POST/api/v2/users/{userId}/kyc/verify

Verify and update user KYC information with comprehensive verification data

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
Field	Type	Required	Description
userId (path)	unknown	Yes	User ID

Request body

application/json

Request body fields
Field	Type	Required	Description
KycStatus	KycStatusV2	Yes
KycLevel	KycLevelV2	Yes
VerificationId	string	No
KycProvider	string	No
FirstName	string	No
LastName	string	No
DateOfBirth	string	No
Gender	string	No
Nationality	string	No	ISO 3166-1 alpha-3 country code, for example GBR.
Ssn	string	No	Required when Nationality is USA. Exactly 9 digits, without separators.
Email	string	No
PhoneNumber	string	No
Occupation	string	Yes
AnnualSalary	0-10000 \| 10001-30000 \| 30001-50000 \| 50001-75000 \| 75001-100000 \| 100001-150000 \| …	Yes	Possible values: 0-10000, 10001-30000, 30001-50000, 50001-75000, 75001-100000, 100001-150000, 150001-250000, 250001+.
AccountPurpose	string	Yes
ExpectedMonthlyVolume	0-1000 \| 1001-5000 \| 5001-15000 \| 15001-50000 \| 50001-100000 \| 100001+	Yes	Possible values: 0-1000, 1001-5000, 5001-15000, 15001-50000, 50001-100000, 100001+.
IpAddress	string	No
DocumentIssueDate	string	Yes	Format: YYYY-MM-DD.
EqualsMainPurpose	array of SALARY_OR_INCOME \| PERSONAL_TRANSFERS_OR_LIVING_EXPENSES \| FAMILY_SUPPORT \| MORTGAGE_OR_RENT_OR_UTILITY_BILLS \| SAVINGS \| INVESTMENT_PURPOSES \| …	No	Possible values: SALARY_OR_INCOME, PERSONAL_TRANSFERS_OR_LIVING_EXPENSES, FAMILY_SUPPORT, MORTGAGE_OR_RENT_OR_UTILITY_BILLS, SAVINGS, INVESTMENT_PURPOSES, INVESTMENT_OR_TRADING_IN_CRYPTOCURRENCIES, RECEIVING_OR_SENDING_LOAN_PAYMENTS, PURCHASE_OF_GOODS_OR_SERVICES, TRAVEL, EDUCATION, MEDICAL_EXPENSES, CHARITABLE_DONATIONS.
EqualsSourceOfFunds	array of RECEIVING_FUNDS_FROM_OWN_ACCOUNTS \| RECEIVING_SALARY_PENSION_OR_DIVIDENDS \| RECEIVING_GIFTS_OR_INHERITANCES \| PROCEEDS_FROM_INVESTMENTS \| PROCEEDS_FROM_CRYPTOCURRENCY_SALES_OR_TRADING \| PROCEEDS_FROM_SALE_OF_A_PROPERTY_OR_PHYSICAL_ASSET \| …	No	Possible values: RECEIVING_FUNDS_FROM_OWN_ACCOUNTS, RECEIVING_SALARY_PENSION_OR_DIVIDENDS, RECEIVING_GIFTS_OR_INHERITANCES, PROCEEDS_FROM_INVESTMENTS, PROCEEDS_FROM_CRYPTOCURRENCY_SALES_OR_TRADING, PROCEEDS_FROM_SALE_OF_A_PROPERTY_OR_PHYSICAL_ASSET, OTHER.
EqualsCurrenciesRequired	array of AED \| AFN \| ALL \| AMD \| ANG \| AOA \| …	No	Possible values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHN, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XAG, XAU, XCD, XOF, XPD, XPF, XPT, YER, ZAR, ZMK, ZMW, ZWD.
EqualsDestinationCountries	array of AD \| AE \| AF \| AG \| AI \| AL \| …	No	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, XK, YE, YT, ZA, ZM, ZW.
EqualsExpectedAnnualVolume	0-10000 \| 10001-50000 \| 50001-100000 \| 100001-250000 \| 250001-1000000 \| 1000001-5000000 \| …	No	Possible values: 0-10000, 10001-50000, 50001-100000, 100001-250000, 250001-1000000, 1000001-5000000, 5000000+.
EqualsExpectedPayments	FEWER-THAN-5 \| 5-10 \| 10-20 \| MORE-THAN-20	No	Possible values: FEWER-THAN-5, 5-10, 10-20, MORE-THAN-20.
NationalId	string	No
DocumentType	string	No
DocumentNumber	string	No
DocumentExpiryDate	string	No
DocumentIssuingCountry	string	No	ISO 3166-1 alpha-3 country code, for example GBR.
DocumentIssuingAuthority	string	No
DocumentIssuedAt	string	No
DocumentFrontImage	string	No
DocumentBackImage	string	No
SelfieImage	string	No
DocumentImageFormat	string	No
AddressLine1	string	No
AddressLine2	string	No
City	string	No
Region	string	No
PostalCode	string	No
Country	string	No	ISO 3166-1 alpha-3 country code, for example GBR.
ProofOfAddressType	string	No
ProofOfAddressImage	string	No
ProofOfAddressIssueDate	string	No
ProofOfAddressImageFormat	string	No
Metadata	object	No
RejectionReason	string	No
ReviewNotes	string	No
KycDetails	string	No

Responses

200 — OK

Response 200 fields
Field	Type	Required
Success	boolean	No
Message	string	No
User	UserKycVerificationData	No

400 — Bad Request

Response 400 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

404 — Not Found

Response 404 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

Example request

curl -X POST "https://{base_url}/api/v2/users/{userId}/kyc/verify" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"KycStatus":"…","KycLevel":"…","Occupation":"…","AnnualSalary":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.