Providing information related to a customer identity stored the account data bound to the customer's phone number.

POST/knowyourcustomerfill-in/fill-in

Providing information related to a customer identity stored the account data bound to the customer’s phone number.

Header ParametersExpand Collapse

"x-correlator": optional string

Body ParametersJSONExpand Collapse

phoneNumber: optional string

A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ’+’.

ReturnsExpand Collapse

address: optional string

Complete address of the customer stored on the Operator’s system. For some countries, it is built following the usual concatenation of parameters in a country, but for other countries, this is not the case. For some countries, it can use streetName, streetNumber and/or houseNumberExtension. For example, in ESP, streetName+streetNumber; in NLD, it can be streetName+streetNumber or streetName+streetNumber+houseNumberExtension.

birthdate: optional string

Birthdate of the customer, in ISO 8601 calendar date format (YYYY-MM-DD), stored on the Operator’s system.

formatdate

cityOfBirth: optional string

City where the customer was born.

country: optional string

Country of the customer’s address stored on the Operator’s system. Format ISO 3166-1 alpha-2.

countryOfBirth: optional string

Country where the customer was born. Format ISO 3166-1 alpha-2.

email: optional string

Email address of the customer in the RFC specified format (local-part@domain), stored on the Operator’s system.

formatemail

familyName: optional string

Last name, family name, or surname of the customer stored on the Operator’s system.

familyNameAtBirth: optional string

Last/family/sur- name at birth of the customer stored on the Operator’s system.

gender: optional "MALE" or "FEMALE" or "OTHER"

Gender of the customer stored on the Operator’s system (Male/Female/Other).

One of the following:

"MALE"

"FEMALE"

"OTHER"

givenName: optional string

First/given name or compound first/given name of the customer on the Operator’s system.

houseNumberExtension: optional string

House number extension of the customer stored on the Operator’s system. Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.

idDocument: optional string

Id number associated to the id_document of the customer stored on the Operator’s system.

idDocumentExpiryDate: optional string

Expiration date of the identity document (ISO 8601).

formatdate

idDocumentType: optional "passport" or "national_id_card" or "residence_permit" or 4 more

Type of the official identity document provided.

One of the following:

"passport"

"national_id_card"

"residence_permit"

"diplomatic_id"

"driver_licence"

"social_security_id"

"other"

locality: optional string

Locality of the customer’s address, stored on the Operator’s system.

middleNames: optional string

Middle name/s of the customer stored on the Operator’s system.

name: optional string

Complete name of the customer stored on the Operator’s system. It is usually composed of first/given name and last/family/sur- name in a country. Depending on the country, the order of first/give name and last/family/sur- name varies, and middle name could be included. It can use givenName, middleNames, familyName and/or familyNameAtBirth. For example, in ESP, name+familyName; in NLD, it can be name+middleNames+familyName or name+middleNames+familyNameAtBirth, etc.

nameKanaHankaku: optional string

Complete name of the customer in Hankaku-Kana format (reading of name) for Japan, stored on the Operator’s system.

nameKanaZenkaku: optional string

Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan, stored on the Operator’s system.

nationality: optional string

ISO 3166-1 alpha-2 code of the customer’s nationality. In the case a customer has more than one nationality, it is supposed to be the nationality related to the ID document provided in the match request.

phoneNumber: optional string

postalCode: optional string

The postal code or Zip code of the customer’s address, stored on the Operator’s system.

region: optional string

Region/prefecture of the customer’s address, stored on the Operator’s system.

streetName: optional string

Name of the street of the customer’s address on the Operator’s system. It should not include the type of the street.

streetNumber: optional string

The street number of the customer’s address on the Operator’s system. Number identifying a specific property on the ‘streetName’.

Providing information related to a customer identity stored the account data bound to the customer's phone number.

curl https://api.example.com/camara/knowyourcustomerfill-in/fill-in \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CAMARA_BEARER_TOKEN" \
    -d '{
          "phoneNumber": "+34629255833"
        }'

{
  "phoneNumber": "+34629255833",
  "idDocument": "66666666q",
  "idDocumentType": "passport",
  "idDocumentExpiryDate": "2027-07-12",
  "name": "Federica Sanchez Arjona",
  "givenName": "Federica",
  "familyName": "Sanchez Arjona",
  "nameKanaHankaku": "federica",
  "nameKanaZenkaku": "Ｆｅｄｅｒｉｃａ",
  "middleNames": "Sanchez",
  "familyNameAtBirth": "YYYY",
  "address": "Tokyo-to Chiyoda-ku Iidabashi 3-10-10",
  "streetName": "Nicolas Salmeron",
  "streetNumber": "4",
  "postalCode": "1028460",
  "region": "Tokyo",
  "locality": "ZZZZ",
  "country": "JP",
  "houseNumberExtension": "36",
  "birthdate": "1978-08-22",
  "email": "abc@example.com",
  "gender": "MALE",
  "cityOfBirth": "Madrid",
  "countryOfBirth": "ES",
  "nationality": "ES"
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param."
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action."
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "The phone number provided is not associated with a customer account"
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not applicable for the provided phone number"
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "No phone number has been provided"
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "An explicit phone number has been provided when one is already associated with the access token"
}

Returns Examples

{
  "phoneNumber": "+34629255833",
  "idDocument": "66666666q",
  "idDocumentType": "passport",
  "idDocumentExpiryDate": "2027-07-12",
  "name": "Federica Sanchez Arjona",
  "givenName": "Federica",
  "familyName": "Sanchez Arjona",
  "nameKanaHankaku": "federica",
  "nameKanaZenkaku": "Ｆｅｄｅｒｉｃａ",
  "middleNames": "Sanchez",
  "familyNameAtBirth": "YYYY",
  "address": "Tokyo-to Chiyoda-ku Iidabashi 3-10-10",
  "streetName": "Nicolas Salmeron",
  "streetNumber": "4",
  "postalCode": "1028460",
  "region": "Tokyo",
  "locality": "ZZZZ",
  "country": "JP",
  "houseNumberExtension": "36",
  "birthdate": "1978-08-22",
  "email": "abc@example.com",
  "gender": "MALE",
  "cityOfBirth": "Madrid",
  "countryOfBirth": "ES",
  "nationality": "ES"
}

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param."
}

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials. A new authentication is required."
}

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action."
}

{
  "status": 404,
  "code": "IDENTIFIER_NOT_FOUND",
  "message": "The phone number provided is not associated with a customer account"
}

{
  "status": 422,
  "code": "SERVICE_NOT_APPLICABLE",
  "message": "The service is not applicable for the provided phone number"
}

{
  "status": 422,
  "code": "MISSING_IDENTIFIER",
  "message": "No phone number has been provided"
}

{
  "status": 422,
  "code": "UNNECESSARY_IDENTIFIER",
  "message": "An explicit phone number has been provided when one is already associated with the access token"
}