Use this endpoint to compare user-submitted data against operator data, without requiring user consent (OTP). Returns a similarity score for each field.
Related ID Mobile documentation:
GET request
https://{SERVER_ADDRESS}/IDMOBILE/?number={NUM}&token={TOKEN}&mode={MODE}&name={NAME}&code_name={CODE_NAME}&licence={LICENCE_CODE}&user_infos={INFORMATION}&scope=matching_notp&redirect_uri={URL_REDIRECT}&country={COUNTRY}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 |
| mode |
2: authentication by code. |
Mandatory |
| name | Partner name in the DQE Software database, usually your company name. | Mandatory |
| code_name | Optional field containing a code associated with name. |
Optional |
| user_infos | JSON object containing the client information to compare. See the user_infos keys table below. Mandatory if the scope is matching_notp. |
Optional |
| scope | Static value. Must be matching_notp for this scope. |
Mandatory |
| redirect_uri | Redirection URL. DQE adds the session token and status to the redirect. | Optional |
| country | Use only for international Matching without OTP. Expected value: ISO 2-letter country code. | Optional |
user_infos keys — each key must be present, even if no value is provided:
| Key | Description |
|---|---|
street_address |
Street type and name. |
postal_code |
Postal code. |
locality |
City. |
country |
Country name in full. |
birthdate |
Date of birth in YYYY-MM-DD format. |
email |
Email address. |
lastname |
Last name. |
maiden_name |
Maiden name. |
gender |
Gender: M or F. |
firstname |
First name. |
phone |
Phone number. |
number |
Street number. |
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 |
| mode |
2: authentication by code. |
Mandatory |
| name | Partner name in the DQE Software database, usually your company name. | Mandatory |
| code_name | Optional field containing a code associated with name. |
Optional |
| user_infos | JSON object containing the client information to compare. Mandatory if the scope is matching_notp. |
Optional |
| scope | Static value. Must be matching_notp for this scope. |
Mandatory |
| redirect_uri | Redirection URL. DQE adds the session token and status to the redirect. | Optional |
| country | Use only for international Matching without OTP. Expected value: ISO 2-letter country code. | Optional |
Response
Success — direct identification
The API returns a JSON object with a similarity score for each field:
| Key | Description | Type |
|---|---|---|
| family_name | Similarity score for the last name. | NUMBER |
| gender | Similarity score for civility. | NUMBER |
| birthdate | Similarity score for the date of birth. | NUMBER |
| given_name | Similarity score for the first name. | NUMBER |
| address | Object containing address similarity scores. Keys: country, postal_code, street_address, locality. |
JSON OBJECT |
| Similarity score for the email address. | NUMBER |
Example:
{
"family_name": 1.0,
"gender": "",
"birthdate": 1.0,
"given_name": 1.0,
"address": {
"country": 1.0,
"postal_code": 0.78,
"street_address": 0.56,
"locality": 0.44
},
"email": 1.0
}Error
The API returns a JSON object containing the following keys:
| Key | Description | Type |
|---|---|---|
| status | error |
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. |
| 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. |
Example:
{
"status": "error",
"error_type": "invalid phone number",
"error_id": "10"
}