{"info":{"_postman_id":"15e3df38-01aa-4ef8-bd2c-38302411ad3c","name":"DCB API","description":"

We offer an exclusive API for our trusted traffic partners. This API enables you to seamlessly build and customize your landing pages by integrating directly with our robust backend systems.

\n

Our API is designed to ensure flexibility and ease of use, supporting both POST and GET methods across all web services.

\n

Important Note:

\n
    \n

  1. If any of your parameter values contain a URL, please ensure that it is URL encoded before passing it to us.

    \n
    2. \n

  2. Many of our API responses will include a special identifier called the rockman ID, which refers to a unique session ID. This rockman ID is essential for tracking user activity across sessions and serves as a reference for troubleshooting any issues that may arise. Please ensure that this ID is handled appropriately in your systems.

    \n
    3. \n

  3. A single MSISDN might be subject to limits on the number of tests or subscriptions it can perform. If you need to run multiple tests in a short period with the same MSISDN, consider sending a whitelist request to our account manager.

    \n
    4. \n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33980503","collectionId":"15e3df38-01aa-4ef8-bd2c-38302411ad3c","publishedId":"2sA3Bj8tzf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"7dc142"},"publishDate":"2024-04-15T10:55:38.000Z"},"item":[{"name":"PIN Flow","item":[{"name":"Trigger PIN","id":"109cfd2a-2c83-463d-8f22-434495582d4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"{{slug}}","type":"text","description":"

[Required] Your designated slug from account manager

\n"},{"key":"country","value":"{{country-code}}","type":"text","description":"

[Required] The Alpha-2 country code

\n"},{"key":"msisdn","value":"{{msisdn}}","type":"text","description":"

[Required] Phone number with country code, for example: 30612345678

\n"},{"key":"rockman_id","value":"{{rockman-id}}","description":"

Required: This parameter is mandatory only for specific connections utilizing the Anti-Fraud APIs.

\n

Condition: Include this value only if you are using the Anti-Fraud Session Start endpoint. Use the value provided in the response of the Anti-Fraud Session Start API.

\n","type":"text"},{"key":"offerId","value":"{{offer-id}}","type":"text","description":"

[Required] Your designated offer ID from account manager

\n"},{"key":"clickId","value":"{{click-id}}","type":"text","description":"

[Required] We will include the click ID in the callback or notification

\n"},{"key":"page","value":"{{page-url}}","type":"text","description":"

[Optional] The landing page URL

\n"},{"key":"userAgent","value":"{{user-agent}}","description":"

[Optional] User agent string of the end user browser or device

\n","type":"text","uuid":"8823b73c-3c6c-4ef3-8c92-8115080e0bde"},{"key":"publisherId","value":"{{publisher-id}}","type":"text","description":"

[Optional] Publisher ID

\n"},{"key":"subId","value":"{{sub-id}}","type":"text","description":"

[Optional] Placement ID

\n"},{"key":"callbackUrl","value":"{{callback-url}}","description":"

Required: This parameter is mandatory only for connections in Oman. For Omantel users, redirect the user to the URL specified in redirect_url from the response for anti-fraud checks. Upon successful validation, the user will be redirected back to this callback URL, typically the PIN entry page.

\n","type":"text","uuid":"e1969e94-fc21-4581-b5b4-446728747611"}]},"url":"https://{{domain-host}}/tallyman/v1/?action=trigger-pin&device=smart","description":"

This method is used for sending a one-time PIN to a MSISDN.

\n","urlObject":{"protocol":"https","path":["tallyman","v1",""],"host":["{{domain-host}}"],"query":[{"key":"action","value":"trigger-pin"},{"key":"device","value":"smart"}],"variable":[]}},"response":[{"id":"c40934da-d14e-4c1f-8fbe-e22781da8e0e","name":"Valid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"country","value":"ae","type":"text"},{"key":"slug","value":"my-slug-id","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"msisdn","value":"9711234561388","type":"text"},{"key":"clickId","value":"","type":"text"},{"key":"page","value":"https://my-landing-page.com","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"f0001f33-0b47-4976-ab28-4fbbdeda92ef"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=trigger-pin&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"trigger-pin"},{"key":"device","value":"smart"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 1 Apr 2022 09:54:07 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"operator\": \"AE_ETISALAT\",\n \"rockman_id\": \"0530ea0a6ce64b339aac49524b6fedc8\"\n}"},{"id":"1397fbbe-fa7a-467d-9ec5-bc31277dddd7","name":"Valid Response (Oman - Omantel)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"country","value":"ae","type":"text"},{"key":"slug","value":"my-slug-id","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"msisdn","value":"9711234561388","type":"text"},{"key":"clickId","value":"","type":"text"},{"key":"page","value":"https://my-landing-page.com","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"65b77cd5-23ac-46e9-a793-d8933e56d505"},{"key":"callbackUrl","value":"https://example.com/?callback","type":"text","uuid":"606b90a5-39e2-4022-9a21-ec727412b253"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=trigger-pin&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"trigger-pin"},{"key":"device","value":"smart"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 1 Apr 2022 09:54:07 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"redirect_url\": \"https://example.com/?redirect\",\n \"rockman_id\": \"0530ea0a6ce64b339aac49524b6fedc8\"\n}"},{"id":"14e0a09d-0192-4d84-8270-172dcde619ad","name":"Invalid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"country","value":"ae","type":"text"},{"key":"slug","value":"my-slug-id","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"msisdn","value":"9711234561388","type":"text"},{"key":"clickId","value":"","type":"text"},{"key":"page","value":"https://my-landing-page.com","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"da3f3fca-74c7-44dd-bd31-5dcce69653d6"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=trigger-pin&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"trigger-pin"},{"key":"device","value":"smart"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 16 Apr 2024 04:29:23 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":false,\n \"rockman_id\":\"0530ea0a6ce64b339aac49524b6fedc8\",\n \"message\":\"validation_issue\",\n \"error_code\":\"35\"\n}"}],"_postman_id":"109cfd2a-2c83-463d-8f22-434495582d4d"},{"name":"Verify PIN","id":"84e289af-88f1-458e-b988-3914493e6f64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"{{slug}}","type":"text","description":"

[Required] Your designated slug from account manager

\n"},{"key":"country","value":"{{country-code}}","type":"text","description":"

[Required] The Alpha-2 country code

\n"},{"key":"msisdn","value":"{{msisdn}}","type":"text","description":"

[Required] Phone number with country code, for example: 30612345678

\n"},{"key":"rockman_id","value":"{{rockman-id}}","type":"text","description":"

[Required] Include this value that you receive from the Trigger PIN response

\n"},{"key":"pin","value":"{{pin}}","type":"text","description":"

[Required] The PIN code entered by the user

\n"},{"key":"offerId","value":"{{offer-id}}","type":"text","description":"

[Required] Your designated offer ID from account manager

\n"},{"key":"clickId","value":"{{click-id}}","type":"text","description":"

[Optional] We will include the click ID in the callback or notification

\n"}]},"url":"https://{{domain-host}}/tallyman/v1/?action=verify-pin&device=smart","description":"

This method allows validation to be carried out on a carrier-generated PIN.

\n","urlObject":{"protocol":"https","path":["tallyman","v1",""],"host":["{{domain-host}}"],"query":[{"key":"action","value":"verify-pin"},{"key":"device","value":"smart"}],"variable":[]}},"response":[{"id":"b3f0efb7-a74b-4798-9f35-05c916083153","name":"Valid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"country","value":"AE","type":"text"},{"key":"slug","value":"my-slug-id","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"msisdn","value":"9711234561399","type":"text"},{"key":"rockman_id","value":"0530ea0a6ce64b339aac49524b6fedc8","type":"text"},{"key":"pin","value":"1234","type":"text"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=verify-pin&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"verify-pin"},{"key":"device","value":"smart"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 1 Apr 2022 09:54:07 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"rockman_id\": \"0530ea0a6ce64b339aac49524b6fedc8\"\n}"},{"id":"0c8b0667-e6d0-464b-bf64-0956b40a8cea","name":"Invalid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"country","value":"AE","type":"text"},{"key":"slug","value":"my-slug-id","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"msisdn","value":"9711234561399","type":"text"},{"key":"rockman_id","value":"0530ea0a6ce64b339aac49524b6fedc8","type":"text"},{"key":"pin","value":"1234","type":"text"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=verify-pin&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"verify-pin"},{"key":"device","value":"smart"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 16 Apr 2024 04:29:23 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"rockman_id\": \"0530ea0a6ce64b339aac49524b6fedc8\",\n \"message\": \"invalid_pin\",\n \"error_code\": \"22\"\n}"}],"_postman_id":"84e289af-88f1-458e-b988-3914493e6f64"}],"id":"48762a0e-081e-4e5d-b18f-94405809db71","description":"

Before you start

\n

Please obtain the value for {{domain-host}} from your account manager

\n","_postman_id":"48762a0e-081e-4e5d-b18f-94405809db71"},{"name":"MO Flow","item":[{"name":"Trigger Message","id":"fb279109-34ed-4afd-938b-e1b70423d8f9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"{{slug}}","type":"text","description":"

[Required] Your designated slug from account manager

\n"},{"key":"country","value":"{{country-code}}","type":"text","description":"

[Required] The Alpha-2 country code

\n"},{"key":"msisdn","value":"{{msisdn}}","type":"text","description":"

[Required] Phone number with country code, for example: 30612345678

\n"},{"key":"offerId","value":"{{offer-id}}","type":"text","description":"

[Required] Your designated offer ID from account manager

\n"},{"key":"clickId","value":"{{click-id}}","type":"text","description":"

[Required] We will include the click ID in the callback or notification

\n"},{"key":"operator","value":"{{operator-fqn}}","type":"text","description":"

[Optional] Operator code, for example: GR_VODAFONE

\n"},{"key":"page","value":"{{page-url}}","type":"text","description":"

[Optional] The landing page URL

\n"},{"key":"userAgent","value":"{{user-agent}}","description":"

[Optional] User agent string of the end user browser or device

\n","type":"text","uuid":"e27d8a77-e97b-49a2-b6cb-d52aadb382f1"},{"key":"publisherId","value":"{{publisher-id}}","type":"text","description":"

[Optional] Publisher ID

\n"},{"key":"subId","value":"{{sub-id}}","type":"text","description":"

[Optional] Placement ID

\n"}]},"url":"https://{{domain-host}}/tallyman/v1/?action=trigger-message&device=smart","description":"

To obtain the opt-in keyword and shortcode after the user submits their MSISDN.

\n","urlObject":{"protocol":"https","path":["tallyman","v1",""],"host":["{{domain-host}}"],"query":[{"key":"action","value":"trigger-message"},{"key":"device","value":"smart"}],"variable":[]}},"response":[{"id":"32edb623-9f05-482d-97e2-62e1dd4b33e4","name":"Valid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"my-slug-id","type":"text"},{"key":"country","value":"GR","type":"text"},{"key":"msisdn","value":"306976824117","type":"text"},{"key":"device","value":"smart","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"clickId","value":"","type":"text"},{"key":"page","value":"https://my-landing-page.com","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"ab6317ba-d760-4121-9ab9-e60976f8f015"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=trigger-message&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"trigger-message"},{"key":"device","value":"smart"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 1 Apr 2022 09:54:07 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"keyword\": \"OK\",\n \"shortcode\": \"54784\",\n \"success\": true,\n \"rockman_id\": \"0530ea0a6ce64b339aac49524b6fedc8\",\n \"message\": \"ok\"\n}"},{"id":"13c63798-e0b9-4017-bc7d-ad0e87dc57b9","name":"Invalid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"my-slug-id","type":"text"},{"key":"country","value":"GR","type":"text"},{"key":"msisdn","value":"306976824117","type":"text"},{"key":"device","value":"smart","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"clickId","value":"","type":"text"},{"key":"page","value":"https://my-landing-page.com","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"862afa68-660f-450a-aad0-2b9c3ff4ca36"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=trigger-message&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"trigger-message"},{"key":"device","value":"smart"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 16 Apr 2024 04:29:23 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"rockman_id\": \"87a636da948f4deaab815d1617f965d7\",\n \"message\": \"subscription_api_failure\",\n \"error_code\": \"50\"\n}"}],"_postman_id":"fb279109-34ed-4afd-938b-e1b70423d8f9"}],"id":"44992e69-cd41-4d7e-b65a-8747fe3099c8","description":"

Before you start

\n

Please obtain the value for {{domain-host}} from your account manager

\n","_postman_id":"44992e69-cd41-4d7e-b65a-8747fe3099c8"},{"name":"Click-To-SMS Flow","item":[{"name":"One Click to SMS","id":"4565b9b8-6a63-442d-9a06-b38c7266a96a","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"{{slug}}","type":"text","description":"

[Required] Your designated slug from account manager

\n"},{"key":"country","value":"{{country-code}}","type":"text","description":"

[Required] The Alpha-2 country code

\n"},{"key":"offerId","value":"{{offer-id}}","type":"text","description":"

[Required] Your designated offer ID from account manager

\n"},{"key":"clickId","value":"{{click-id}}","type":"text","description":"

[Required] We will include the click ID in the callback or notification

\n"},{"key":"page","value":"{{page-url}}","type":"text","description":"

[Optional] The landing page URL

\n"},{"key":"userAgent","value":"{{user-agent}}","description":"

[Optional] User agent string of the end user browser or device

\n","type":"text","uuid":"f2765f4a-fe8b-4f7a-864d-f5a75f183d3e"},{"key":"publisherId","value":"{{publisher-id}}","description":"

[Optional] Publisher ID

\n","type":"text"},{"key":"subId","value":"{{sub-id}}","description":"

[Optional] Placement ID

\n","type":"text"}]},"url":"https://{{domain-host}}/tallyman/v1/?action=oc2sms&device=smart","description":"

To obtain the opt-in keyword and shortcode.

\n

The SMS content should be formatted as follows,

\n

[displayKeyword] [uid]

\n

Therefore, based on the sample valid response, the final SMS content should be

\n
ON *53P2\n\n
","urlObject":{"protocol":"https","path":["tallyman","v1",""],"host":["{{domain-host}}"],"query":[{"key":"action","value":"oc2sms"},{"key":"device","value":"smart"}],"variable":[]}},"response":[{"id":"7a7829c6-f5b4-4eeb-a529-070a157bb936","name":"Valid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"my-slug-id","type":"text"},{"key":"country","value":"GR","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"clickId","value":"","type":"text"},{"key":"page","value":"https://my-landing-page.com","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"d10f72df-85e4-4b0e-b375-6299cdbcb4ae"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=oc2sms&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"oc2sms"},{"key":"device","value":"smart"}]}},"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 1 Apr 2022 09:54:07 GMT","description":"","type":"text"},{"key":"transfer-encoding","value":"chunked","description":"","type":"text"},{"key":"content-type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"private","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"uid\": \"*53P2\",\n \"shortcode\": \"83767\",\n \"displayKeyword\": \"ON\",\n \"success\": true,\n \"rockman_id\": \"90b5ca10f165485082639c85e5acc58f\"\n}"},{"id":"5e5770eb-024f-44cb-8e56-5a56ada9c2c4","name":"Invalid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"my-slug-id","type":"text"},{"key":"country","value":"GR","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"clickId","value":"","type":"text"},{"key":"page","value":"https://my-landing-page.com","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"5b8e896c-6206-491d-b137-bf3974ae3f3b"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=oc2sms&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"oc2sms"},{"key":"device","value":"smart"}]}},"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 16 Apr 2024 04:29:23 GMT","description":"","type":"text"},{"key":"transfer-encoding","value":"chunked","description":"","type":"text"},{"key":"content-type","value":"application/json","description":"","type":"text"},{"key":"cache-control","value":"private","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"rockman_id\": \"87a636da948f4deaab815d1617f965d7\",\n \"message\": \"cap_reached\",\n \"error_code\": 40\n}"}],"_postman_id":"4565b9b8-6a63-442d-9a06-b38c7266a96a"}],"id":"a5bb0824-0357-43fb-8883-067d331e5514","description":"

Before you start

\n

Please obtain the value for {{domain-host}} from your account manager

\n","_postman_id":"a5bb0824-0357-43fb-8883-067d331e5514"},{"name":"Redirect Flow","item":[{"name":"Redirect","id":"e1152b64-a7bb-4151-baab-8b990aeb65f5","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"{{slug}}","type":"text","description":"

[Required] Your designated slug from account manager

\n"},{"key":"country","value":"{{country-code}}","type":"text","description":"

[Required] The Alpha-2 country code

\n"},{"key":"msisdn","value":"{{msisdn}}","type":"text","description":"

[Required] Phone number with country code, for example: 30612345678

\n"},{"key":"offerId","value":"{{offer-id}}","type":"text","description":"

[Required] Your designated offer ID from account manager

\n"},{"key":"clickId","value":"{{click-id}}","type":"text","description":"

[Required] We will include the click ID in the callback or notification

\n"},{"key":"callbackUrl","value":"{{callback-url}}","description":"

[Required] After a user completes the sign-up process, we redirect them to this URL with extra details:

\n
error: Indicates if the sign-up was successful, pending, or failed.\nerror_code: Provides more details if there was an issue. Refer to the Error messages and error codes section.\nurl: A link to the product page where the user can access the content portal.\n

Depending on regulations, we may either show a Thank You (TQ) page or redirect the user to the product page after the TQ page.

\n","type":"text"},{"key":"page","value":"{{page-url}}","type":"text","description":"

[Optional] The landing page URL

\n"},{"key":"userAgent","value":"{{user-agent}}","description":"

[Optional] User agent string of the end user browser or device

\n","type":"text","uuid":"87a809c3-27dd-41eb-a5e7-8396312a3a4d"},{"key":"publisherId","value":"{{publisher-id}}","type":"text","description":"

[Optional] Publisher ID

\n"},{"key":"subId","value":"{{sub-id}}","type":"text","description":"

[Optional] Placement ID

\n"}]},"url":"https://{{domain-host}}/tallyman/v1/?action=redirect&device=smart","description":"

To obtain a redirection URL.

\n

If the request is valid, you will send the user to the redirect_url to complete the sign-up process. We will return the user to your specified callbackUrl once they complete the action.

\n","urlObject":{"protocol":"https","path":["tallyman","v1",""],"host":["{{domain-host}}"],"query":[{"key":"action","value":"redirect"},{"key":"device","value":"smart"}],"variable":[]}},"response":[{"id":"cf695fca-5a9c-4377-ae85-f7a84e1f537c","name":"Valid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"my-slug-id","type":"text"},{"key":"country","value":"sa","type":"text"},{"key":"msisdn","value":"966554881370","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"clickId","value":"","type":"text"},{"key":"callbackUrl","value":"https://example.org/?callback","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"7338e361-05e0-4d30-afdb-c2158d1767b7"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=redirect&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"redirect"},{"key":"device","value":"smart"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 1 Apr 2022 09:54:07 GMT"},{"key":"transfer-encoding","value":"chunked","description":""},{"key":"content-type","value":"application/json","description":""},{"key":"cache-control","value":"private","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"redirect_url\": \"https://www.example.com/?redirect\",\n \"success\": true,\n \"rockman_id\": \"753ccafafb304ce9a66149a964c5b9ae\"\n}"},{"id":"157a3780-d33e-4f92-a065-86e72b92eb1a","name":"Invalid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"my-slug-id","type":"text"},{"key":"country","value":"sa","type":"text"},{"key":"msisdn","value":"966554881370","type":"text"},{"key":"offerId","value":"999","type":"text"},{"key":"clickId","value":"","type":"text"},{"key":"callbackUrl","value":"https://example.com/?callback","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"f0113bf4-bf8a-4da7-9172-85b98545a453"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=redirect&device=smart","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"redirect"},{"key":"device","value":"smart"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 1 Apr 2022 09:54:07 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"false\",\n \"rockman_id\": \"c6b94b2c445793582dddbb7b120281c5\",\n \"message\": \"invalid_msisdn\",\n \"error_code\": \"32\"\n}"}],"_postman_id":"e1152b64-a7bb-4151-baab-8b990aeb65f5"}],"id":"46d76e77-97b7-49be-aa91-b8a812b20263","description":"

Before you start

\n

Please obtain the value for {{domain-host}} from your account manager

\n","_postman_id":"46d76e77-97b7-49be-aa91-b8a812b20263"},{"name":"Anti Fraud Integration","item":[{"name":"Session Start","id":"0b2a5be1-541b-483c-a873-60bc75ce0153","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"{{slug}}","description":"

[Required] Your designated slug from account manager

\n","type":"text"},{"key":"country","value":"{{country-code}}","type":"text","description":"

[Required] The Alpha-2 country code

\n"},{"key":"offerId","value":"{{offer-id}}","description":"

[Optional] Your designated offer ID from account manager

\n","type":"text","uuid":"2223cacb-0da0-4688-a450-25cc53a725b6"},{"key":"page","value":"{{page-url}}","type":"text","description":"

[Optional] The landing page URL

\n"},{"key":"userAgent","value":"{{user-agent}}","description":"

[Optional] User agent string of the end user browser or device

\n","type":"text","uuid":"01be2203-6d74-4abb-aaea-3f181c9e4540"}]},"url":"https://{{domain-host}}/tallyman/v1/?action=evina-light-session-start&device=smart","description":"

This method is used to request the anti-fraud JavaScript.

\n","urlObject":{"protocol":"https","path":["tallyman","v1",""],"host":["{{domain-host}}"],"query":[{"key":"action","value":"evina-light-session-start"},{"key":"device","value":"smart"}],"variable":[]}},"response":[{"id":"bcbc42ad-9fcc-41f8-ab26-e7292b888fdb","name":"Valid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"country","value":"ae","type":"text"},{"key":"slug","value":"my-slug-id","type":"text"},{"key":"page","value":"https://my-landing-page.com","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"115cdc97-5f8e-44ca-845f-e6e420356f43"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=evina-light-session-start","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"evina-light-session-start"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 1 Apr 2022 09:54:07 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"script\": \"!function(){}();\",\n \"rockman_id\": \"0530ea0a6ce64b339aac49524b6fedc8\",\n \"tid\": \"0530ea0a6ce64b339aac49524b6fedc8:1167607217\"\n}"},{"id":"7aaaee47-ed18-45b0-a43e-6ef8cdc39264","name":"Invalid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"country","value":"ae","type":"text"},{"key":"slug","value":"my-slug-id","type":"text"},{"key":"page","value":"https://my-landing-page.com","type":"text"},{"key":"userAgent","value":"Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/139.0.0.0 Mobile Safari/537.36","type":"text","uuid":"63c420dc-74ca-4ee3-80f4-114a19f55d0e"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=evina-light-session-start","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"evina-light-session-start"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 16 Apr 2024 04:29:23 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\n \"success\":false,\n \"rockman_id\":\"0530ea0a6ce64b339aac49524b6fedc8\",\n \"message\":\"not_supported\"\n}"}],"_postman_id":"0b2a5be1-541b-483c-a873-60bc75ce0153"},{"name":"Session Check","id":"cec6d315-d942-40b4-8d00-a3562bdddd7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"slug","value":"{{slug}}","description":"

[Required] Your designated slug from account manager

\n","type":"text"},{"key":"country","value":"{{country-code}}","type":"text","description":"

[Required] The Alpha-2 country code

\n"},{"key":"msisdn","value":"{{msisdn}}","type":"text","description":"

[Required] Phone number with country code, for example: 30612345678

\n"},{"key":"rockman_id","value":"{{rockman-id}}","type":"text","description":"

[Required] Include the rockman_id value that you receive from the Session Start response

\n"},{"key":"tid","value":"{{tid}}","type":"text","description":"

[Required] Include the tid value that you receive from the Session Start response

\n"}]},"url":"https://{{domain-host}}/tallyman/v1/?action=evina-session-check&device=smart","description":"

This method is called to check the fraud status of the session.

\n","urlObject":{"protocol":"https","path":["tallyman","v1",""],"host":["{{domain-host}}"],"query":[{"key":"action","value":"evina-session-check"},{"key":"device","value":"smart"}],"variable":[]}},"response":[{"id":"5fccfced-4348-4b93-aef6-3f8c6fc7df15","name":"Valid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"country","value":"AE","type":"text"},{"key":"slug","value":"my-slug-id","type":"text"},{"key":"msisdn","value":"9711234561399","type":"text"},{"key":"rockman_id","value":"0530ea0a6ce64b339aac49524b6fedc8","type":"text"},{"key":"tid","value":"0530ea0a6ce64b339aac49524b6fedc8:1167607217","type":"text"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=evina-session-check","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"evina-session-check"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Mon, 1 Apr 2022 09:54:07 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\r\n \"should-block\": false,\r\n \"reason\": 1000,\r\n \"rule-id\": \"5d6f3a8129fe74ac6802dbb4:1705306103\",\r\n \"success\": true,\r\n \"rockman_id\": \"0530ea0a6ce64b339aac49524b6fedc8\"\r\n}"},{"id":"5b077bfd-af96-406b-9986-5397e54ac8ce","name":"Invalid Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"country","value":"AE","type":"text"},{"key":"slug","value":"my-slug-id","type":"text"},{"key":"msisdn","value":"9711234561399","type":"text"},{"key":"rockman_id","value":"0530ea0a6ce64b339aac49524b6fedc8","type":"text"},{"key":"tid","value":"0530ea0a6ce64b339aac49524b6fedc8:1167607217","type":"text"}]},"url":{"raw":"https://api.local/tallyman/v1/?action=evina-session-check","protocol":"https","host":["api","local"],"path":["tallyman","v1",""],"query":[{"key":"action","value":"evina-session-check"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Tue, 16 Apr 2024 04:29:23 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"content-type","value":"application/json"},{"key":"cache-control","value":"private"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"rockman_id\": \"0530ea0a6ce64b339aac49524b6fedc8\",\r\n \"message\": \"Your evina-session-check request could not be completed\"\r\n}"}],"_postman_id":"cec6d315-d942-40b4-8d00-a3562bdddd7d"}],"id":"47d54901-44e0-4633-946f-d4c1e287c9e2","description":"

In some of the connections, we are required to send your traffic for anti-fraud screenings to comply with regulatory requirements. In this document, we will outline two API calls that are required to perform the screening. Here are the steps:

\n
    \n

  1. An HTML element tagged with the CSS class submit-button is required to be present on the landing page. We suggest using a submit button, which users typically interact with, to increase the chance of passing the anti-fraud check.

    \n
                 <button type=\"submit\" class=\"submit-button\">Continue</button>\n\n
    \n
    2. \n

  2. After the user lands on the page, make a Session Start API call.

    \n
    3. \n

  3. In the response, we will return a JavaScript script, an anti-fraud ID (tid), and a rockman ID.

    \n
    4. \n

  4. Include the JavaScript in the HTML source code of the page.

    \n
                        <html lang=\"en\">\n      <head>\n        <meta charset=\"UTF-8\">\n        <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n        <title>My Landinge Page</title>\n      </head>\n      <body>\n        <form action=\"#\" method=\"post\">\n          <button type=\"submit\" class=\"submit-button\">Continue</button>\n        </form>\n        <script type=\"text/javascript\">\n        // Anti fraud Javascript here\n        {{script}}\n        </script>\n      </body>\n </html>\n\n
    \n
    5. \n

  5. After the user performs an action (e.g., clicking the submit button), make a Session Check API call.

    \n
    6. \n

  6. If should-block is false in the response, perform the subsequent API call to continue the flow.

    \n
    7. \n
\n","_postman_id":"47d54901-44e0-4633-946f-d4c1e287c9e2"},{"name":"Server Postback","item":[],"id":"728be71c-6a34-4a1c-aad3-19092e2b0def","description":"

Postback URLs, also known as callbacks or server-to-server (S2S) pixel URLs, play a crucial role in transferring conversion data. These URLs are used to relay information about successful conversions.

\n

When a user completes a conversion, our system sends an HTTP request to your designated postback URL.

\n

Here is an example of a postback URL:

\n
http://my-tracking-server/postback?click_id={clickid}\n\n
\n

Before launching your campaign, it is important to share this information with your account manager to ensure seamless integration.

\n","_postman_id":"728be71c-6a34-4a1c-aad3-19092e2b0def"},{"name":"Error Messages and Error Codes","item":[],"id":"a3de0a15-8617-4396-ad23-31b0ce816a39","description":"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ErrorError CodeDescription
success1Successful
pending2Pending (waiting for gateway confirmation)
already_subscribed

or

ALREADY SUBSCRIBED		10If a user is already subscribed in our system or at the gateway or operator side.
blacklisted_msisdn11The MSISDN is blacklisted and cannot continue the subscription process.
duplicated_request12Received the same request for more than one time.
expired_pin21For security reasons, there is a time limit to enter a PIN when verifying (e.g., 2 minutes).
If the PIN is entered after the specified time limit, the system returns an error.
invalid_pin22When a user enters a wrong or invalid pin.
pin_limit_exceeded23When a user exceeds the allowed number of incorrect attempts (e.g., a maximum of 3 wrong attempts).
pin_generation_error24This error is related to OTP/PIN generation. It can occur either from the gateway or Sam Media depending on the platform generating the PIN.
pin_already_used25This error happens when a user tries to reuse a PIN that has already been used.
unsupported_flow30This error occurs when the requested flow is not supported for the given user.
inactive_operator31The operator is not active for a subscription.
invalid_msisdn32The MSISDN is either invalid or not in the correct format.
invalid_subscription_id33This error occurs when the subscription ID provided in the request is not valid or recognized by the system. It typically indicates that the subscription ID does not exist in the database or does not match the expected format or criteria.
not_eligible_msisdn34This error occurs when the MSISDN provided is not eligible for the requested action or service. This could be due to various reasons such as the MSISDN being inactive, not registered with the service, or not meeting specific eligibility criteria required for the operation.
validation_issue35This error indicates that there was a problem with the validation process for the input or request.

It typically occurs when the provided data does not meet the required format, constraints, or validation rules. This could include missing or incorrect parameters, invalid data types, or failing to meet specific criteria necessary for the operation to proceed successfully.
insufficient_balance36This error indicates that the user does not have sufficient credit balance to fulfil the subscription.
anti_fraud_error37This error indicates that there was an error associated with anti fraud.

This typically occurs when anti-fraud check fails to meet specific condition. It could also be due to anti-fraud agent identifying the page to be fradulent.
vas_blocked38The error occurs when VAS is enabled on an MSISDN by the Telecom.

It can be resolve by contacting the Telecom provider to deactivate VAS on the number.
account_suspended39The error occurs when a user account have been suspended but not blacklisted.
cap_reached

or

sales cap reached		40This error indicates that a predefined limit or cap has been reached for the requested action or resource. It typically occurs when the maximum threshold for sales has been exceeded.
subscription_api_failure50This error indicates that the subscription API failed due to an issue encountered when our system attempted to call an external API to subscribe.
re-subscription blocked75If a user tries to subscribe to more than two services within 30 days, they will be blocked from subscribing again.
re lead blocked76If a user tries to enter their phone number more than 5 times on the landing page within 5 minutes, they will be blocked from trying again.

Additionally, there may be other connection-specific blocks that could apply based on the situation.
unspecified_error99This error occurs when an unexpected or unspecified issue arises during the execution of the operation.

It indicates that the system encountered a problem that cannot be precisely categorized or described by predefined error codes.
\n
","_postman_id":"a3de0a15-8617-4396-ad23-31b0ce816a39"}],"event":[{"listen":"prerequest","script":{"id":"890721c5-99b1-4570-9679-2bff5435c530","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"dc7aeb9d-ed54-44f5-8b9b-51270552832b","type":"text/javascript","packages":{},"exec":[""]}}]}