Get KYC Required Fields

Get required KYC fields for a country

GET
texttext
/api/v2/kyc/required-fields

Returns the list of required and optional KYC fields for users from a specific country.

Query Parameters

countryCodestringrequired
ISO country code
kycLevelstring
Target level (TIER_1, TIER_2, TIER_3)

Response Schema

requiredFieldsarray
List of required field names
optionalFieldsarray
List of optional field names
requiredDocumentsarray
List of required document types

Example

jsonjson
GET /api/v2/kyc/required-fields?countryCode=US&kycLevel=TIER_2
// Response:
{
  "requiredFields": ["firstName", "lastName", "dateOfBirth", "address", "documentType", "documentNumber"],
  "optionalFields": ["phoneNumber", "middleName", "occupation"],
  "requiredDocuments": ["GOVERNMENT_ID", "SELFIE"]
}