Skip to main content

Get All Clients

GET 
/v1/crossborder/clients

Retrieve a list of all crossborder clients. 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 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 client type. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.

    status string

    Possible values: [ACTIVE, INACTIVE, PENDING]

    Filter results by client status. ACTIVE for active clients, INACTIVE for inactive clients.

    name string

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

    country string

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

    Country code of the client (ISO 3166-1 alpha-2).

    risk string

    Possible values: [LOW, MEDIUM, HIGH]

    Filter results by client risk. LOW for low risk, MEDIUM for medium risk, HIGH for high risk.

Header Parameters

    x-wallet-uuid string

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

    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.

Responses​

Clients 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 client objects matching the search criteria and pagination parameters.

  • Array [
    • id stringrequired

    Unique identifier (UUID) of the client.

    name stringrequired

    Full name of the client. For legal entities, the name field corresponds to the legal name.

    type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Type of client entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.

    country string

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

    Country code of the client (ISO 3166-1 alpha-2).

    nationality string

    Nationality of the client.

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

    birth_date date-time

    Date of birth of the client. Format: YYYY-MM-DD.

    issue_date date-time

    Date when the identification document was issued. Format: YYYY-MM-DD.

    issuing_country string

    Country where the identification document was issued.

    phone_number string

    Phone number of the client (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 client.

    risk string

    Possible values: [LOW, MEDIUM, HIGH]

    Risk of the client.

    link_url string

    Link URL to the client finished onboarding.

    created_at date-timerequired

    Client created date.

    updated_at date-timerequired

    Client updated date.

  • ]
Loading...