Skip to main content

Create Counterparty

POST 
/v1/crossborder/clients/:client_id/counterparties

Create a new crossborder counterparty for a specific client. The counterparty will be associated with the specified client and user.

Request​

Path Parameters

    client_id stringrequired

    Unique identifier (UUID) of the client that will own this counterparty.

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    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.

Body

required
    name stringrequired

    Full name of the counterparty. Must be a valid string with maximum 80 characters. 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

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

    Country code.

    nationality stringrequired

    Nationality of the counterparty. Country name or nationality identifier. Maximum 80 characters.

    document stringrequired

    Official document number used for identification (e.g., passport number, ID number, tax ID). Maximum 50 characters.

    document_type stringrequired

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

    Type of identification document provided. PASSPORT for passport, NATIONAL_ID for national ID card, TAX_ID for tax identification number.

    email stringrequired

    Valid email address of the counterparty. Used for communication and notifications. Maximum 255 characters.

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

Responses​

Counterparty created successfully.

Schema
    id stringrequired

    Unique identifier (UUID) of the created 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

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

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