Know Your Customer (KYC)

Add KYC Documents

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

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

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/evs/v1/identity/{identityId}/document
  • Auth
    none declared

Path parameters

identityIdstring required

Request body multipart/form-data

selectedIdClass'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'

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
frontPhotostring binary

Front photo of the identity document

Image Requirements:

  • Dimensions: 200 to 15,000 px
  • File Size: 10 KB to 15 MB
  • Supported Formats: JPG, JPEG, PNG, HEIC, PDF
backPhotostring binary

Back photo of the identity document

Image Requirements:

  • Dimensions: 200 to 15,000 px
  • File Size: 10 KB to 15 MB
  • Supported Formats: JPG, JPEG, PNG, HEIC, PDF
proofOfResidencystring binary

Proof of residency

Image Requirements:

  • Dimensions: 200 to 15,000 px
  • File Size: 10 KB to 15 MB
  • Supported Formats: JPG, JPEG, PNG, HEIC, PDF

Example request

{
  "frontPhoto": "\"passport-front.jpg\"",
  "backPhoto": "\"drivers-license-back.png\"",
  "proofOfResidency": "\"rental-lease.pdf\""
}

Response

OK

idstring required
status'pending' | 'processing' | 'approved' | 'rejected' required
selectedIdClass'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' required

Changes

No operation changes recorded.