API - Description - IDMOBILE - NumberVerify - URL - Response

Support DQE
Support DQE
  • Updated

Number Verify Request Success

The response is a JSON whose keys are defined below:

Key Description Format
status « success » STRING
operator Operator STRING
url URL of the Operator API STRING

Example:

{
"status": "success",
"operator": "SFR",
"url": "htt***fr.fr/api/a**l8ET6UMbsaG0AOm5FsakgyKu*"
}

Number Verify Request Error

The response is a JSON whose keys are defined below :

Key Description Format
status « error » STRING
error_type Error label: details in the following table STRING
error_id Error code: details in the following table STRING(2)

 

Error code details (error_id key) :

error_id error_type Description
01 invalid request The request is not valid
02 invalid licence key The license is not valid
04 invalid scope Invalid scope
05 missing or empty parameter (user_infos) for this scope A parameter is missing for the scope called
06 bad parameter format (user_infos) is not a valid JSON The "user_infos" parameter is not a valid json
07 missing mandatory key in user informations (phone) The missing "phone" key in the "user_infos" parameter is mandatory for this operator [SFR].
09 ineligible phone number Number not eligible for the solution
10 invalid phone number The phone number does not exist
11 phone number is empty The phone number is empty
12 phone check failed The operator verification did not work
13 operator [Operator Name] not found The operator is not found
14 operator [Operator Name] not authorized for this licence Your license is not open on this operator
15 operator [Operator Name] not supported yet The solution is not yet available on the requested solution
16 operator [Operator Name] unreachable Impossible to contact the operator
17 scope not supported by this operator [Operator Name] yet This scope is not supported by the operator
30 invalid or expired token The token has expired

Response example :

{
      "status": "error",
      "error_type": "invalid phone number",
      "error_id": "10"
}

Related to

Was this article helpful?

0 out of 0 found this helpful