connectivity
mobile-identity
identity-verification

Advanced Silent Mobile Verification

Verify possession of the end user's mobile phone number with a mobile network operator's data connection. If request body is supplied with additional data, the following can be done:

  • SIM swap check before the mobile phone number verification
  • Fallback SMS message if silent mobile verification fails

API and URL may vary per country. Contact your Account Manager for implementation details.

post/mi/verification/1/verify/advanced

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.

callbackUrlstring required

Your URL that will be called to provide result when the process is completed.

returnUrlstring

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

deviceIpstring xxx.xxx.xxx.xxx|xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx

IPv4 or IPv6 address of the mobile device that will be verified with operator. Currently, can be used only in Brazil.

devicePortinteger

Port of the mobile device that will be verified with operator. Can be used only when "deviceIp" is also provided. Currently, can be used only in Brazil.

Example request

{
  "consentGranted": true,
  "phoneNumber": "441134961234",
  "callbackUrl": "https://api.infobip.com/my-callback-webook/my-path",
  "returnUrl": "https://api.infobip.com/my-site/my-shop.html",
  "smsFailover": {
    "from": "441134961234",
    "text": "One time verification pin: 1234",
    "validityPeriod": 5
  },
  "simSwapCheck": {
    "period": 15
  },
  "deviceIp": "10.20.30.100|1111:22222:3333:4444:AAAA:BBBB:CCCC:DDDD",
  "devicePort": 54321
}

Response

OK

status'ACCEPTED'

Silent Mobile Verification request status.

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.

Example response

{
  "token": "123e4567-e89b-12d3-a456-426655440000"
}

Changes

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