This page describes the response returned by the IDMobile Number Verify Retrieval endpoint.
Related IDMobile Number Verify documentation:
- ID Mobile introduction
- Number Verify Retrieval GET request
- Number Verify Retrieval POST request
- Number Verify URL response
- IDMobile Number Verify Swagger documentation
Number Verify retrieval success response
The response is a JSON object whose keys are defined below:
| Key | Description | Format |
|---|---|---|
| status |
success: indicates that the information was successfully retrieved. |
STRING |
| scope | Contains the scope previously sent. | STRING |
| numVerify |
true if the verification is successful. |
BOOLEAN |
Example:
{
"status": "success",
"scope": "numVerify",
"numVerify": true
}Number Verify retrieval pending response
The response is a JSON object whose keys are defined below:
| Key | Description | Format |
|---|---|---|
| status |
pending: indicates that DQE is waiting for the operator response. |
STRING |
| scope | Contains numVerify. |
STRING |
Example:
{
"status": "pending",
"scope": "numVerify"
}Number Verify retrieval error response
The response is a JSON object whose keys are defined below:
| Key | Description | Format |
|---|---|---|
| status |
error: indicates that the request failed. |
STRING |
| error_type | Error label. Details are provided in the table below. | STRING |
| error_id | Error code. Details are provided in the table below. | STRING(2) |
Error code details:
| Error ID | Error type | Description |
|---|---|---|
| 01 | invalid request | The request is not valid. |
| 02 | invalid licence key | The licence is not valid. |
| 04 | invalid scope | Invalid scope. |
| 18 | failed to retrieve data from operator | No data was received after OTP validation. |
| 20 | Not the same phone number between the phone in the request | OTP validation was not completed. |
| 21 | access denied | OTP validation was declined. |
| 30 | invalid or expired token | The token has expired. |
| 99 | internal server error | Server error. |
Example:
{
"status": "error",
"error_id": "20",
"error_type": "OTP process failed"
}Related to