V1GetAllCounterpartyRestResponse

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Array of counterparty objects matching the search criteria and pagination parameters.
Array [
id stringrequired
Unique identifier (UUID) of the counterparty.
name stringrequired
Full name of the counterparty. For legal entities, the name field corresponds to the legal name.
type stringrequired
Possible values: [NATURAL_PERSON, LEGAL_PERSON]
Type of counterparty entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.
country stringrequired
Country code.
nationality stringrequired
Nationality of the counterparty.
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 counterparty.
birth_date date-time
Date of birth of the counterparty. Format: YYYY-MM-DD.
issue_date date-time
Date when the identification document was issued. Format: YYYY-MM-DD.
phone_number string
Phone number of the counterparty (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 counterparty.
created_at date-timerequired
Counterparty created date.
updated_at date-timerequired
Counterparty updated date.
]