INinfobip
connectivity
mobile-identity
identity-verification

Zero rated request initialization

Initialise zero rated request. This API endpoint is available only in Brazil. Please contact your sales for more details.

post/mi/verification/1/zero-rated/init

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Request body

consentGrantedboolean required

Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.

phoneNumberstring required

Mobile phone number (MSISDN) to verify. The number must be in international format.

returnUrlstring

An URL to which the mobile device will be redirected to when verification is complete.

Example request

{
  "consentGranted": true,
  "phoneNumber": "441134961234",
  "returnUrl": "https://api.infobip.com/my-site/my-shop.html"
}

Response

OK

tokenstring uuid

Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.

deviceRedirectUrlstring uri

An URL to perform mobile device redirect to if specified so by 'status'.

Example response

{
  "token": "123e4567-e89b-12d3-a456-426655440000",
  "deviceRedirectUrl": "https://api.infobip.com/mno-domain/smv-check-endpoint"
}

Changes

No recorded changes to this operation across all 1 revision of this API.