ID Mobile — Number Verify

Support DQE
Support DQE
  • Updated

Use this endpoint to verify whether the phone number sent in the request matches the number initiating the request. The process involves two steps: initiate the verification request, then retrieve the result.

Related ID Mobile documentation:

Step 1 — Initiate verification request

GET request

https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&name={NAME}&licence={LICENCE_CODE}&scope=numVerify&redirect_uri={URL_REDIRECT}

Replace the values in braces with your own information:

Parameter Description Mandatory/Optional
SERVER_ADDRESS Address of the DQE server that will process the data. Mandatory
licence Number assigned to you as your licence code. Mandatory
number Phone number. Mandatory
token Token retrieved through authentication. Mandatory
name Partner name in the DQE database, usually your company name. Mandatory
scope Static value. Must be numVerify for this scope. Mandatory
redirect_uri Redirection URL. DQE adds the session token and status to the redirect. Optional

POST request

https://{SERVER_ADDRESS}/IDMOBILE/

Add the following parameters in the request body using x-www-form-urlencoded:

Parameter Description Mandatory/Optional
licence Number assigned to you as your licence code. Mandatory
number Phone number. Mandatory
token Token retrieved through authentication. Mandatory
name Partner name in the DQE database, usually your company name. Mandatory
scope Static value. Must be numVerify for this scope. Mandatory
redirect_uri Redirection URL. DQE adds the session token and status to the redirect. Optional

Response

Success

Key Description Type
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*"
}

Error

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.
05 missing or empty parameter (user_infos) for this scope A parameter is missing for the requested scope.
06 bad parameter format (user_infos) is not a valid JSON The user_infos parameter is not valid JSON.
07 missing mandatory key in user informations (phone) The phone key is mandatory in the user_infos parameter for this operator.
09 ineligible phone number The phone number is 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 failed.
13 operator [Operator Name] not found The operator could not be found.
14 operator [Operator Name] not authorized for this licence Your licence is not authorised for this operator.
15 operator [Operator Name] not supported yet The solution is not yet available for this operator.
16 operator [Operator Name] unreachable The operator could not be contacted.
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.

Step 2 — Retrieve verification result

GET request

https://{SERVER_ADDRESS}/GET/?token={TOKEN}&Licence={LICENCE_CODE}&scope=numVerify
Parameter Description Mandatory/Optional
SERVER_ADDRESS Address of the DQE server that will process the data. Mandatory
Licence Number assigned to you as your licence code. Mandatory
token Token retrieved through authentication. Mandatory
scope Static value. Must be numVerify for this scope. Mandatory

POST request

https://{SERVER_ADDRESS}/GET/

Add the following parameters in the request body using x-www-form-urlencoded:

Parameter Description Mandatory/Optional
Licence Number assigned to you as your licence code. Mandatory
token Token retrieved through authentication. Mandatory
scope Static value. Must be numVerify for this scope. Mandatory

Response

Success

Key Description Type
status success: information was successfully retrieved. STRING
scope Contains the scope previously sent. STRING
numVerify true if the phone number verification is successful. BOOLEAN

Example:

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

Pending

Key Description Type
status pending: DQE is waiting for the operator response. STRING
scope Contains numVerify. STRING

Example:

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

Error

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"
}

Was this article helpful?

0 out of 0 found this helpful