Skip to navigation
Fetching the resultsCustomer Data

Customer profile

View as Markdown

Your customer’s identity, as the source knows it.

Names, identification documents, birth and nationality, contact details and declared situation — read from the institution rather than from a form somebody filled in. It is the natural cross-check against what your customer typed during onboarding, and the one field set that almost every engine produces.

One profile describes a person or a company. type says which, and the fields that only make sense for one of them say so individually — name_extra and number_of_children come empty for a company, gender and civil_status come as unknown. Field by field in Customer Profile.

Requires the customer_information_read feature

Features are chosen when the execution starts, not here. An execution that did not ask for customer_information_read answers 204, and the only way to get the data is to run another one.

StatusMeaning
200The profile.
202feature_not_ready — customer_information_read is still running. Only this family waits: the ones that already closed answer now.
204The execution never asked for customer_information_read, or it did and the source had nothing to give. No body either way.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
Your customer as the institution knows them: names, identification documents, birth and nationality, contact details and declared situation. type says whether you are reading a person or a company.

product"customer_information"

The product type identifier. Always customer_information for this product.

sub_family"customer_information:user_profile"

The sub-family identifier: customer_information:user_profile, the customer’s profile at the institution.

fetch_datestringformat: "datetime"
Date this information was fetched.
typeenum

The kind of customer: a person or a company. This is the switch that tells you how to read the rest of the profile.

Allowed values:
identification_numberslist of objects

The customer’s identification documents as the institution registers them — for persons a DNI/NIE, passport or Social Security number; for companies the tax ID (CIF). Each entry carries its type, its value, and whether the value passed validation.

genderenum

Persons only — gender as declared at the institution. unknown for companies, and for persons whose source does not disclose it.

Allowed values:
civil_statusenum

Persons only — civil status as declared at the institution. unknown for companies, and for persons whose source does not disclose it.

emailslist of strings
Email addresses of the customer, as they appear at the source.
phoneslist of strings
Phone numbers of the customer, as they appear at the source.
addresseslist of objects
Postal addresses of the customer, as they appear at the source.
namestringOptional

For persons, the given name(s); for companies, the registered legal name (razón social).

name_extrastringOptional

Persons only — the rest of the legal name; Spanish institutions report both surnames here. Empty for companies.

aliasstringOptional

How the institution addresses the customer when it differs from the legal name — a chosen or commercial name.

birth_datedateOptional

For persons, the date of birth; for companies, the date of incorporation, when the source provides it.

birth_countrystringOptionalformat: "country"

Country of birth, as a two-letter ISO code.

nationality_countrystringOptionalformat: "country"

For persons, the country of nationality; for companies, the country of the registered seat. Two-letter ISO code.

residence_countrystringOptionalformat: "country"

For persons, the country of residence; for companies, the country of its tax residence. Two-letter ISO code.

number_of_childrenintegerOptional

Persons only — number of children, when the institution records it. Empty for companies.

languagestringOptionalformat: "language"
The customer's preferred language, as an ISO language code.
member_sincedateOptional
Date the customer's relationship with the institution began, when the source reports it.

Errors

404
Not Found Error
422
Unprocessable Entity Error