Skip to main content

Get All Counterparties

GET 
/v1/crossborder/counterparties

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

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort object

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Filter by counterparty type.

    country string

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

    Filter by country code.

    nationality string

    Filter by nationality.

    document_type string

    Possible values: [CPF, CNPJ, DNI, PASSPORT, RUT, RUC, CUIL, CUIT, RFC, CURP, CE, PAS, PP]

    Filter by document type.

    status string

    Possible values: [ACTIVE, INACTIVE, PENDING]

    Filter by status.

    name string

    Filter by 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

    Counterparties data.

  • Array [
    • id stringrequired

    Counterparty ID.

    name stringrequired

    Counterparty name.

    type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Counterparty type.

    country stringrequired

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

    Country code.

    nationality stringrequired

    Nationality.

    document stringrequired

    Document number.

    document_type stringrequired

    Possible values: [CPF, CNPJ, DNI, PASSPORT, RUT, RUC, CUIL, CUIT, RFC, CURP, CE, PAS, PP]

    Document type.

    email stringrequired

    Email address.

    birth_date stringrequired

    Birth date.

    issue_date stringrequired

    Issue date.

    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]

    Counterparty status.

    created_at date-timerequired

    Counterparty created date.

    updated_at date-timerequired

    Counterparty updated date.

  • ]
Loading...