Create an individual customer

POST 
/customers/individual

Creates a new customer with a individual customer profile. This endpoint allows you to:

• Create a new individual customer with basic information
• Set up identification and tax information
• Configure PEP (Politically Exposed Person) status
• Set up contact details and address

Request

application/json

Body

required

Individual customer creation data

email string
phoneNumber string
phoneCountryCode string

PhoneCountryCode, e.g. USA (New York) "1"

basicData

object

required

firstName stringrequired

middleName string

lastName stringrequired

sex stringrequired

Possible values: [M, F, O]

Mandatory: Use M for Male, F for Female, or O for Other. If left blank, this will default to O (Other) and can be automatically populated after KYC has been completed.

nationality stringrequired

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

birthDate date-timerequired

occupation stringrequired

Possible values: [111011, 111021, 111031, 112011, 112021, 112022, 112031, 113011, 113021, 113031, 113051, 113061, 113071, 113111, 113121, 113131, 119013, 119021, 119031, 119032, 119033, 119039, 119041, 119051, 119061, 119071, 119081, 119111, 119121, 119131, 119141, 119151, 119161, 119199, 131011, 131021, 131022, 131023, 131031, 131032, 131041, 131051, 131071, 131074, 131075, 131081, 131111, 131121, 131131, 131141, 131151, 131161, 131199, 132011, 132021, 132031, 132041, 132051, 132052, 132053, 132061, 132071, 132072, 132081, 132082, 132099, 151111, 151121, 151122, 151131, 151132, 151133, 151134, 151141, 151142, 151143, 151151, 151152, 151199, 152011, 152021, 152031, 152041, 152091, 152099, 171011, 171012, 171021, 171022, 172011, 172021, 172031, 172041, 172051, 172061, 172071, 172072, 172081, 172111, 172112, 172121, 172131, 172141, 172151, 172161, 172171, 172199, 173011, 173012, 173013, 173019, 173021, 173022, 173023, 173024, 173025, 173026, 173027, 173029, 173031, 191011, 191012, 191013, 191021, 191022, 191023, 191029, 191031, 191032, 191041, 191042, 191099, 192011, 192012, 192021, 192031, 192032, 192041, 192042, 192043, 192099, 193011, 193022, 193031, 193032, 193039, 193041, 193051, 193091, 193092, 193093, 193094, 193099, 194011, 194021, 194031, 194041, 194051, 194061, 194091, 194092, 194093, 194099, 211011, 211012, 211013, 211014, 211015, 211019, 211021, 211022, 211023, 211029, 211091, 211092, 211093, 211094, 211099, 212011, 212021, 212099, 231011, 231012, 231021, 231022, 231023, 232011, 232091, 232093, 232099, 251011, 251021, 251022, 251031, 251032, 251041, 251042, 251043, 251051, 251052, 251053, 251054, 251061, 251062, 251063, 251064, 251065, 251066, 251067, 251069, 251071, 251072, 251081, 251082, 251111, 251112, 251113, 251121, 251122, 251123, 251124, 251125, 251126, 251191, 251192, 251193, 251194, 251199, 252011, 252012, 252021, 252022, 252023, 252031, 252032, 252051, 252052, 252053, 252054, 252059, 253011, 253021, 253099, 254011, 254012, 254013, 254021, 254031, 259011, 259021, 259031, 259041, 259099, 271011, 271012, 271013, 271014, 271019, 271021, 271022, 271023, 271024, 271025, 271026, 271027, 271029, 272011, 272012, 272021, 272022, 272023, 272031, 272032, 272041, 272042, 272099, 273011, 273012, 273021, 273022, 273031, 273041, 273042, 273043, 273091, 273099, 274011, 274012, 274013, 274014, 274021, 274031, 274032, 274099, 291011, 291021, 291022, 291023, 291024, 291029, 291031, 291041, 291051, 291061, 291062, 291063, 291064, 291065, 291066, 291067, 291069, 291071, 291081, 291122, 291123, 291124, 291125, 291126, 291127, 291128, 291129, 291131, 291141, 291151, 291161, 291171, 291181, 291199, 292011, 292012, 292021, 292031, 292032, 292033, 292034, 292035, 292041, 292051, 292052, 292053, 292054, 292055, 292056, 292057, 292061, 292071, 292081, 292091, 292092, 292099, 299011, 299012, 299091, 299092, 299099, 311011, 311013, 311014, 311015, 312011, 312012, 312021, 312022, 319011, 319091, 319092, 319093, 319094, 319095, 319096, 319097, 319099, 331011, 331012, 331021, 331099, 332011, 332021, 332022, 333011, 333012, 333021, 333031, 333041, 333051, 333052, 339011, 339021, 339031, 339032, 339091, 339092, 339093, 339099, 351011, 351012, 352011, 352012, 352013, 352014, 352015, 352019, 352021, 353011, 353021, 353022, 353031, 353041, 359011, 359021, 359031, 359099, 371011, 371012, 372011, 372012, 372019, 372021, 373011, 373012, 373013, 373019, 391011, 391012, 391021, 392011, 392021, 393011, 393012, 393019, 393021, 393031, 393091, 393092, 393093, 393099, 394011, 394021, 394031, 395011, 395012, 395091, 395092, 395093, 395094, 396011, 396012, 397011, 397012, 399011, 399021, 399031, 399032, 399041, 399099, 411011, 411012, 412011, 412012, 412021, 412022, 412031, 413011, 413021, 413031, 413041, 413099, 414011, 414012, 419011, 419012, 419021, 419022, 419031, 419041, 419091, 419099, 431011, 432011, 432021, 432099, 433011, 433021, 433031, 433041, 433051, 433061, 433071, 433099, 434011, 434021, 434031, 434041, 434051, 434061, 434071, 434081, 434111, 434121, 434131, 434141, 434151, 434161, 434171, 434181, 434199, 435011, 435021, 435031, 435032, 435041, 435051, 435052, 435053, 435061, 435071, 435081, 435111, 436011, 436012, 436013, 436014, 439011, 439021, 439022, 439031, 439041, 439051, 439061, 439071, 439081, 439111, 439199, 451011, 452011, 452021, 452041, 452091, 452092, 452093, 452099, 453011, 453021, 454011, 454021, 454022, 454023, 454029, 471011, 472011, 472021, 472022, 472031, 472041, 472042, 472043, 472044, 472051, 472053, 472061, 472071, 472072, 472073, 472081, 472082, 472111, 472121, 472131, 472132, 472141, 472142, 472151, 472152, 472161, 472171, 472181, 472211, 472221, 472231, 473011, 473012, 473013, 473014, 473015, 473016, 473019, 474011, 474021, 474031, 474041, 474051, 474061, 474071, 474091, 474099, 475011, 475012, 475013, 475021, 475031, 475041, 475042, 475049, 475051, 475061, 475071, 475081, 475099, 491011, 492011, 492021, 492022, 492091, 492092, 492093, 492094, 492095, 492096, 492097, 492098, 493011, 493021, 493022, 493023, 493031, 493041, 493042, 493043, 493051, 493052, 493053, 493091, 493092, 493093, 499011, 499012, 499021, 499031, 499041, 499043, 499044, 499045, 499051, 499052, 499061, 499062, 499063, 499064, 499069, 499071, 499081, 499091, 499092, 499093, 499094, 499095, 499096, 499097, 499098, 499099, 511011, 512011, 512021, 512022, 512023, 512031, 512041, 512091, 512092, 512093, 512099, 513011, 513021, 513022, 513023, 513091, 513092, 513093, 513099, 514011, 514012, 514021, 514022, 514023, 514031, 514032, 514033, 514034, 514035, 514041, 514051, 514052, 514061, 514062, 514071, 514072, 514081, 514111, 514121, 514122, 514191, 514192, 514193, 514194, 514199, 515111, 515112, 515113, 516011, 516021, 516031, 516041, 516042, 516051, 516052, 516061, 516062, 516063, 516064, 516091, 516092, 516093, 516099, 517011, 517021, 517031, 517032, 517041, 517042, 517099, 518011, 518012, 518013, 518021, 518031, 518091, 518092, 518093, 518099, 519011, 519012, 519021, 519022, 519023, 519031, 519032, 519041, 519051, 519061, 519071, 519081, 519082, 519083, 519111, 519121, 519122, 519123, 519141, 519151, 519191, 519192, 519193, 519194, 519195, 519196, 519197, 519198, 519199, 531011, 531021, 531031, 532011, 532012, 532021, 532022, 532031, 533011, 533021, 533022, 533031, 533032, 533033, 533041, 533099, 534011, 534012, 534013, 534021, 534031, 534041, 534099, 535011, 535021, 535022, 535031, 536011, 536021, 536031, 536041, 536051, 536061, 536099, 537011, 537021, 537031, 537032, 537033, 537041, 537051, 537061, 537062, 537063, 537064, 537071, 537072, 537073, 537081, 537111, 537121, 537199, 551011, 551012, 551013, 551014, 551015, 551016, 551017, 551019, 552011, 552012, 552013, 553011, 553012, 553013, 553014, 553015, 553016, 553017, 553018, 553019, SELFEMP, OTHERXX, STUDENT, RETIRED, UNEMPLO]

taxInformation

object

required

number stringrequired

taxNumberType stringrequired

Possible values: [NATIONAL_INSURANCE_NUMBER, TAX_CODE]

country stringrequired

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

identification

object

required

code stringrequired

country stringrequired

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

mainAddress

object

required

street1 stringrequired

street2 string

cityCounty stringrequired

stateRegion string

zip stringrequired

countryCode stringrequired

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

pep booleanrequired

Use true for politically exposed person or false for otherwise

pepExplanation string

Explanation of PEP status if TRUE

Responses

201

The customer was successfully created. Returns the new customer ID.

application/json

Schema

Schema

traceId string
message string

data

object

id stringrequired

Example (from schema)

{
  "traceId": "string",
  "message": "string",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000"
  }
}

400

Invalid request payload. This can happen if required fields are missing or have invalid formats.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

403

The API key is invalid or the client does not have sufficient permissions.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

404

One of the specified resources was not found. Does not apply for empty result set.

application/json

Schema

Schema

traceId string
message string

Example (from schema)

{
  "traceId": "string",
  "message": "string"
}

Loading...