Structure
A customer is represented in our API by the following structure:Attributes
string
Unique identifier of the customer in CUID format.
string
Customer’s full name.
string
Customer’s email address.
string
Phone number with area code, digits only.
string
Customer’s CPF or CNPJ, digits only. Used as a unique identifier per project.
string
Street name or address line.
string
Address number.
string | null
Address complement (e.g.,
Apto 4). Optional.string
Customer’s neighborhood.
string
ZIP code, digits only.
string
Customer’s city.
string
State abbreviation (UF).
string
Country code in ISO 3166-1 alpha-2 format.
boolean
Indicates whether the customer is blocked. Blocked customers cannot generate new transactions.
date-time | null
Date and time when the block was applied.
string | null
Recorded reason for blocking the customer.
date-time | null
Block expiration date.
null indicates a permanent block until manually unblocked.string | null
Type of block applied.
date-time
Date and time when the record was created.
date-time
Date and time of the last update.
Next steps
Get customer by ID
Retrieve a specific customer from the project.
Customers
Understand how Bob links buyers and transactions.