API - Description - IDMOBILE - Formfill Retrieval - Response

Support DQE
Support DQE
  • Updated

Formfilling success response

Key Description Format
status "success": indicates the correct recovery of information STRING
scope Contains the scope previously sent STRING
code_name Contains the code name previously sent STRING
formfilling

If "formfilling" value sent in the "scope" field of the request.

Contains all the keys described in the table below

 JSON OBJECT

 

Elements of the "formfilling" key if requested scope includes formfilling:

Key Description Format
phone_number Phone number STRING(10)
family_name Last name STRING
name First name and last name STRING
locale Native language STRING(3)
gender Gender ("M" for male and "F" for female) STRING
updated_at Date of the last update of the information DATE
birthdate Birth date DATE
birthplace Birth department STRING
given_name First name STRING
address Contains all the keys described in the following table JSON OBJECT
email Complete email STRING
email_domain Email domain STRING
email_account Email username STRING
subscriber_msisdn Phone used for the contract subscription STRING(10)
sub Customer identifier in the operator's database STRING

 

Elements of the “address” key:

Key Description Format
country Country of address in full letter STRING
postal_code Postal code STRING(8)
formatted Complete postal address (\n and \r correspond to line breaks) STRING
street_address Street type and street name STRING(38)
number Street number STRING
locality City STRING(38)

 

Example:

{
"status": "success",
"scope": "matching,formfilling",
"code_name": "",
"formfilling": {
"phone_number": "",
"family_name": "",
"name": " -",
"locale": "fr-FR",
"gender": "M",
"email_domain": ".com",
"updated_at": "-08-09",
"birthdate": "-08-30",
"birthplace": "-08-30",
"given_name": " ",
"address": {
"locality": "",
"country": "",
"number": "",
"formatted": "",
"postal_code": "",
"street_address": « "
},
"email_account": "",
"email": "",
"subscriber_msisdn": "",
"sub": " "
}
}

Formfilling pending response

Key Description Format
status "pending" : indicates that we are waiting for the operator STRING
scope Contains formfilling and/or matching STRING

Example:

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

Formfilling error response

Key Description Format
status "error": indicates that the request has failed STRING
error_type Error label detailed in the following table STRING
error_id Error code detailed in the following table STRING(2)

 

Error codes details (error_id) :

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
18 failed to retrieve data from operator No data received after OTP validation
20 OTP incorrect OTP validation has not been completed
21 access denied OTP validation declined
30 invalid or expired token the token has expired
99 internal server error Server error

Example:

{
"status": "error",
"error_type": "internal server error",
"error_id": "99"
}

 

 

Related to

Was this article helpful?

0 out of 0 found this helpful