API - Description - IDMOBILE - Matching Notp - Response

Support DQE
Support DQE
  • Updated

This page describes the response returned by the IDMobile Matching without OTP endpoint.

Related IDMobile Matching without OTP documentation:

Matching without OTP success response

Identification to the operator without user consent

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

Key Description Format
family_name Result of the comparison on the last name. NUMBER
gender Result of the comparison on civility. NUMBER
birthdate Result of the comparison on the date of birth. NUMBER
given_name Result of the comparison on the first name. NUMBER
address Contains all the keys described in the following table. JSON OBJECT
email Result of the comparison on the email address. NUMBER

Elements of the address key:

Key Description Format
country Result of the comparison on the country. STRING(3)
postal_code Result of the comparison on the postal code. STRING(3)
street_address Result of the comparison on the street. STRING(3)
locality Result of the comparison on the city. STRING(3)

Response example for the matching_notp scope:

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

Identification to the operator with user consent

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

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

Response example:

{
  "status": "success",
  "operator": "Orange",
  "url": "https://api.operator/openidconnect/fr"
}

Matching without OTP error response

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

Key Description Format
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 authorized 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.

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