Skip to main content

Get Counterparty by ID

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

Retrieve detailed information about a specific crossborder counterparty by providing the counterparty ID.

Request​

Path Parameters

    client_id stringrequired

    Unique identifier (UUID) of the client that owns the counterparty.

    id stringrequired

    Unique identifier (UUID) of the counterparty to retrieve.

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

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

Responses​

Counterparty returned successfully.

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

    Country code.

    nationality string

    Nationality of the counterparty.

    document string

    Official document number used for identification.

    document_type string

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

    risk string

    Possible values: [LOW, MEDIUM, HIGH]

    Risk of the counterparty.

    link_url string

    Link URL to the counterparty finished onboarding.

    counterparty_verifications object[]

    Counterparty verifications.

  • Array [
    • id stringrequired

    Counterparty verification ID.

    type stringrequired

    Verification type (e.g. KYC).

    provider stringrequired

    Provider name (e.g. persona).

    status stringrequired

    Status: created, waiting, processed.

    props object

    Provider payload (e.g. Persona inquiry response).

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

  • ]
Loading...