API - Description - IDMOBILE - Matching Notp - Response

Support DQE
Support DQE
  • Updated

Matching No OTP request success

Identification to the operator without user consent

The response is a JSON whose keys are defined below:

KeyDescriptionFormat
family_nameResult of the comparison on the last nameNUMBER
genderResult of the comparison on civilityNUMBER
birthdateResult of the comparison on the date of birthNUMBER
given_nameResult of the comparison on the first nameNUMBER
addressContains all the keys described in the following tableJSON OBJECT
emailResult of the comparison on the email addressNUMBER


Elements of the “address” key :

KeyDescriptionFormat
countryResult of the comparison on the countrySTRING(3)
postal_codeResult of the comparison on the postal codeSTRING(3)
street_addressResult of the comparison on the streetSTRING(3)
localityResult of the comparison on the citySTRING(3)

Response example for « 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 whose keys are defined below:

KeyDescriptionFormat
status« success »STRING
operatorOperatorSTRING
urlURL of the Operator APISTRING

Response example:

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

 

Matching No OTP request error

The response is a JSON whose keys are defined below :

KeyDescriptionFormat
status« error »STRING
error_typeError label: details in the following tableSTRING
error_idError code: details in the following tableSTRING(2)

 

Error code details (error_id key) :

error_iderror_typeDescription
01invalid requestThe request is not valid
02invalid licence keyThe license is not valid
04invalid scopeInvalid scope
05missing or empty parameter (user_infos) for this scopeA parameter is missing for the scope called
06bad parameter format (user_infos) is not a valid JSONThe "user_infos" parameter is not a valid json
07missing mandatory key in user informations (phone)The missing "phone" key in the "user_infos" parameter is mandatory for this operator [SFR].
09ineligible phone numberNumber not eligible for the solution
10invalid phone numberThe phone number does not exist
11phone number is emptyThe phone number is empty
12phone check failedThe operator verification did not work
13operator [Operator Name] not foundThe operator is not found
14operator [Operator Name] not authorized for this licenceYour license is not open on this operator
15operator [Operator Name] not supported yetThe solution is not yet available on the requested solution
16operator [Operator Name] unreachableImpossible to contact the operator
17scope not supported by this operator [Operator Name] yetThis scope is not supported by the operator
30invalid or expired tokenThe 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