Skip to main content

V1GetClientByIdRestResponse

    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.

    document string

    Official document number used for identification.

    country string

    Possible values: [AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

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

    type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

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

    status stringrequired

    Possible values: [ACTIVE, INACTIVE, PENDING, REJECTED, EXPIRED]

    Current status of the client.

    risk string

    Possible values: [LOW, MEDIUM, HIGH]

    Risk of the client.

    email stringrequired

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

    client_verifications object[]

    Client verifications: id, type, provider, status, field_props, created_at, updated_at.

  • Array [
  • id stringrequired

    Client verification ID.

    type stringrequired

    Verification type (e.g. KYC).

    provider stringrequired

    Provider name (e.g. persona).

    status stringrequired

    Status: created, waiting, processed.

    field_props object

    Per-field metadata or validation state for the verification.

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

  • ]