Skip to main content

V1CreateClientBody

    name stringrequired

    Full name of the client. 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 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 stringrequired

    Nationality of the client. 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 client. Used for communication and notifications. Maximum 255 characters.

    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 code or name where the identification document was issued. Maximum 80 characters.

    phone_number string

    Phone number of the client (digits only, e.g. country code + number).

    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.