Customer Profile

The customer's identity as the connected institution knows it
View as Markdown

Where it lives: in the Spain Public Administration results, at data.customer.profile. APIs with dedicated per-product results endpoints return this model directly.

The customer profile is the identity the source has on file: names, identification documents, birth and nationality, contact details and declared situation. Use it to verify identity and to cross-check the data the user typed against what their institution knows about them.

One profile describes both persons and companiestype is the switch that tells you how to read it, and each field’s description below says how its meaning changes (for a company, birth_date is the incorporation date, nationality_country the registered seat, residence_country the tax residence).

product"customer_information"Required
sub_family"customer_information:user_profile"Required
fetch_datestringRequiredformat: "datetime"
Date this information was fetched.
typeenumRequired
Allowed values:
identification_numberslist of objectsRequired
genderenumRequired
Allowed values:
civil_statusenumRequired
emailslist of stringsRequired
Email addresses of the customer, as they appear at the source.
phoneslist of stringsRequired
Phone numbers of the customer, as they appear at the source.
addresseslist of objectsRequired
Postal addresses of the customer, as they appear at the source.
namestringOptional
name_extrastringOptional
aliasstringOptional
birth_datedateOptional
birth_countrystringOptionalformat: "country"
nationality_countrystringOptionalformat: "country"
residence_countrystringOptionalformat: "country"
number_of_childrenintegerOptional
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.