Ctrl+K

Update KYC Document

put/api/evs/v1/identity/{identityId}/document/{documentId}

Update KYC Document.

Path Parameters

  • identityIdstringRequired
  • documentIdstringRequired

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` - Driver's 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 Permanent Account Number card (SSN) - `pid` - PH Postal Identity Card - `pp` - Passport - `ppc` - Passport Card - `pr` - Permanent 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 <binary>
Front photo of the identity document
Example: "passport-front.jpg"
backPhoto <binary>
Back photo of the identity document
Example: "drivers-license-back.png"
proofOfResidency <binary>
Proof of residency
Example: "rental-lease.pdf"

200 Response

id string required
status string required
Allowed values: pending processing approved rejected
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

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