Perform a data query to fetch customer information.
Response Attributes
taxId string
Customer Tax ID.
name string
Full name of the customer.
status enum
Current status of the Tax ID. Possible values:
| Status | Description |
|---|---|
REGULAR | Regular |
SUSPENSA | Suspended |
TITULAR FALECIDO | Deceased Owner |
PENDENTE DE REGULARIZAÇÃO | Pending Regularization |
CANCELADA | Canceled |
NULA | Null |
REJECTED | Rejected |
countryOrigin string
Country of origin, if applicable. Empty if not provided.
motherName string
Full name of the customer's mother.
birthDate datetime
Date of birth in UTC format (YYYY-MM-DDTHH:mm:ss.sssZ).
deathDate datetime
Date of death, if applicable. null if the individual is alive.
gender enum
Gender of the customer. Possible values:
| Gender | Description |
|---|---|
| F | Female |
| M | Male |
| U | Undefined |
Special Cases
Underage Customer
When the customer is a minor, data retrieval is restricted by legal constraints. In this case:
-
The
namefield will be set to"Menor de idade". -
The
statusfield will be set to"REJECTED". -
All personal data fields (
countryOrigin,motherName,birthDate,deathDate,gender) will benull.