Add KYC Documents

post/api/evs/v1/identity/{identityId}/document

Add and validate KYC documents for an existing identity. Documents are verified with the document service before being associated with the identity.

Path Parameters

  • identityIdstringRequired

Request Body

selectedIdClass string
Required when uploading the front and/or back photos of KYC verification documents. It represents the type of identification document being uploaded: - `cct` - Citizenship Certificate - `cid` - Consular ID - `dl` - Drivers License - `foid` - CO Foreigner ID - `hic` - Health Insurance Card - `id` - Identification Card - `ipp` - Internal Passport - `keyp` - AU Keypass ID - `ltpass` - Long Term Pass - `munid` - US Municipal ID (e.g. NYC ID) - `myn` - JP My Number Card (SSN) - `nbi` - PH National Bureau of Investigation Certificate - `nric` - SG National Residency ID - `ofw` - PH Overseas Foreign Worker Card - `rp` - Residence Permit - `pan` - IN Permanant Account Number card (SSN) - `pid` - PH Postal Identity Card - `pp` - Passport - `ppc` - Passport Card - `pr` - Permanant Residence Card - `sss` - PH Social Security System Card (SSN) - `td` - US Travel Document - `tribalid` - US/CA Tribal ID - `umid` - PH Unified Multi Purpose ID - `vid` - Voter Id - `visa` - VISA - `wp` - Work Permit
Allowed values: cct cid dl foid hic id ipp keyp ltpass munid myn nbi nric ofw rp pan pid pp ppc pr sss td tribalid umid vid visa wp
frontPhoto
backPhoto
proofOfResidency

200 Response

id string required
status string required
Min length: >= 1 characters
selectedIdClass string required
Allowed values: cct cid dl foid hic id ipp keyp ltpass munid myn nbi nric ofw rp pan pid pp ppc pr sss td tribalid umid vid visa wp
fileUploads array[object] required
fileName string required
Min length: >= 1 characters
fileSize number required
uploadStatus string required
Min length: >= 1 characters
documentType string required
Allowed values: frontPhoto backPhoto proofOfResidency

400 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required

401 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required

403 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required

404 Response

name string
context object required
status number
additionalDetails object
retryAfter number required
error string required
requestId string required