V1
Phone number verify
API operation to verify a phone number received as input. It can be received either in plain text or hashed format.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Bearer ‘token’ |
| body | body | NumberVerificationRequestBody | true | ‘none’ |
Request body - instance of NumberVerificationRequestBody
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| phoneNumber | PhoneNumber | false | A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ‘+’. |
| hashedPhoneNumber | string | false | Hashed phone number. SHA-256 (in hexadecimal representation) of the mobile phone number in E.164 format (starting with country code). Prefixed with ‘+’. |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | NumberVerificationMatchResponse |
| 400 | Bad Request | Problem with the client request | ErrorInfo |
| 401 | Unauthorized | Unauthorized | ErrorInfo |
| 403 | Forbidden | Forbidden | ErrorInfo |
| 500 | Internal Server Error | Server error | ErrorInfo |
| 503 | Service Unavailable | Service unavailable. Typically the server is down. | ErrorInfo |
| 504 | Gateway Time-out | Request time exceeded. If it happens repeatedly, consider reducing the request complexity | ErrorInfo |
Endpoints
Phone number verify
Sim Swap
Device Swap
KYC Match
Authentication