Skip to main content

Update Client

PUT 
/v1/crossborder/clients/:id

Update an existing crossborder client. Only provided fields will be updated.

Request​

Path Parameters

    id stringrequired

    Client ID.

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.

    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 string

    Client name.

    type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Client type.

    country string

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

    Country code.

    nationality string

    Nationality.

    document string

    Document number.

    document_type string

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

    Document type.

    email string

    Email address.

    birth_date string

    Birth date.

    issue_date string

    Issue date.

    address object
    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​

Client updated successfully.

Schema
    id stringrequired

    Client ID.

    name stringrequired

    Client name.

    type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Client 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]

    Client status.

    created_at date-timerequired

    Client created date.

    updated_at date-timerequired

    Client updated date.

Loading...