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).

The customer's identity as the connected institution knows it: names, identification documents, birth and nationality, contact details (emails, phones, addresses) and declared situation (civil status, children, membership age). Use it to verify identity and to cross-check data the user typed against what their institution knows about them.

One profile describes both persons and companiestype tells you which one you are reading. Some fields switch meaning accordingly (name, birth_date, nationality_country, residence_country — each one says how); the strictly person-only fields behave predictably for companies: name_extra and number_of_children come empty, and gender / civil_status come as unknown.

product"customer_information"Required

The product type identifier. Always customer_information for this product.

sub_family"customer_information:user_profile"Required

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

fetch_datestringRequiredformat: "datetime"
Date this information was fetched.
typeenumRequired

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 objectsRequired

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.

genderenumRequired

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

Allowed values:
civil_statusenumRequired

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

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

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.