Consumer
Basic information for Identity Verification and other core features.
Properties
addresses
• addresses: AddressSchema[]
The consumer addresses, requires at least one the for the Identity Verification and other core features.
Example:
[{
"addresses": [{
"street": "Av Nove de Julho",
"number": "4939",
"neighborhood": "Jardim Paulista",
"code": "01407100",
"city": "São Paulo",
"state": "SP",
"country": "BR",
"status": "own"
}]
Best Practice
The "street" field support max 40 characters.
birthday
• birthday: Date
The consumer birthday, for personal
accounts, the user must have more than 18 years old.
If the account type is corporate
this is not required.
Format: ISO-8601
Optional
companyData
Optional
companyData• companyData? : CompanyDataSchema
The company registration data with authorities, required if the account type is corporate
.
motherName
• motherName? : string
The consumer mother name. If the account type is corporate
this field is not required.
Optional
pep
Optional
pep• pep? : boolean
The self-declaration of political exposure.
phones
• phones: PhoneSchema[]
The consumer phones, requires at least one the for the Identity Verification and other core features.
Example:
[{
"code": "11",
"number": "987654321"
}]
taxId
• taxId: string
The consumer Tax ID (CPF or CNPJ) for the account creation and Identity Verification.
requires
type
• type: AccountType
The account type for the Identity Verification.
Updated over 3 years ago