API - Description - IDMOBILE - NumberVerifyRetriev Response

Support DQE
Support DQE
  • Updated

Number Verify success response

The response is a JSON object whose keys are defined below:

KeyDescriptionFormat
statussuccess: indicates that the information was successfully retrieved.STRING
scopeContains the scope previously sent.STRING
numVerifytrue if the verification is successful.BOOLEAN

Example:

{
  "status": "success",
  "scope": "numVerify",
  "numVerify": true
}

Number Verify pending response

The response is a JSON object whose keys are defined below:

KeyDescriptionFormat
statuspending: indicates that DQE is waiting for the operator response.STRING
scopeContains numVerify.STRING

Example:

{
  "status": "pending",
  "scope": "numVerify"
}

Number Verify error response

The response is a JSON object whose keys are defined below:

KeyDescriptionFormat
statuserror: indicates that the request failed.STRING
error_typeError label. Details are provided in the table below.STRING
error_idError code. Details are provided in the table below.STRING(2)

Error code details:

Error IDError typeDescription
01invalid requestThe request is not valid.
02invalid licence keyThe licence is not valid.
04invalid scopeInvalid scope.
18failed to retrieve data from operatorNo data was received after OTP validation.
20Not the same phone number between the phone in the requestOTP validation was not completed.
21access deniedOTP validation was declined.
30invalid or expired tokenThe token has expired.
99internal server errorServer error.

Example:

{
  "status": "error",
  "error_id": "20",
  "error_type": "OTP process failed"
}

Related to

Was this article helpful?

0 out of 0 found this helpful