Skip to main content

Get All Counterparties

GET 
/v1/crossborder/clients/:client_id/counterparties

Retrieve a list of all crossborder counterparties for a specific client. Optional filter parameters can be used to refine your search.

Request​

Path Parameters

    client_id stringrequired

    Unique identifier (UUID) of the client to retrieve counterparties for.

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at, name]

    Field to sort the results by. Options: CREATED_AT (default) or NAME.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Filter results by counterparty type. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.

    status string

    Possible values: [ACTIVE, INACTIVE, PENDING]

    Filter results by counterparty status. ACTIVE for active counterparties, INACTIVE for inactive counterparties.

    name string

    Filter results by counterparty name using partial match (case-insensitive). Searches for counterparties whose name contains the provided string. For legal entities, the name field corresponds to the legal name.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Counterparties returned successfully.

Schema
    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.

    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.

  • ]
Loading...