V1GetAllClientRestResponseItem

id stringrequired

Unique identifier (UUID) of the client.

name stringrequired

Full name of the client. For legal entities, the name field corresponds to the legal name.

type stringrequired

Possible values: [NATURAL_PERSON, LEGAL_PERSON]

Type of client entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.

country string

Possible values: [US, BR, MX, AR, CO, CL, PE, EC, UY, PY]

Country code of the client (ISO 3166-1 alpha-2).

nationality stringrequired

Nationality of the client.

document stringrequired

Official document number used for identification.

document_type stringrequired

Possible values: [DRIVERS_LICENSE, IDENTITY_CARD, PASSPORT, OTHERS]

Type of identification document.

email stringrequired

Email address of the client.

birth_date date-time

Date of birth of the client. Format: YYYY-MM-DD.

issue_date date-time

Date when the identification document was issued. Format: YYYY-MM-DD.

issuing_country string

Country where the identification document was issued.

phone_number string

Phone number of the client (digits only).

address objectrequired

id stringrequired

Address ID.

street_line_1 stringrequired

Street line 1.

street_line_2 string

Street line 2.

city stringrequired

City.

state stringrequired

State.

subdivision stringrequired

Subdivision.

postal_code stringrequired

Postal code.

country stringrequired

Possible values: [US, BR, MX, AR, CO, CL, PE, EC, UY, PY]

Country.

status stringrequired

Possible values: [ACTIVE, INACTIVE, PENDING]

Current status of the client.

created_at date-timerequired

Client created date.

updated_at date-timerequired

Client updated date.