REST API›Identity›Know Your Customer (KYC)

POST

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.

Path Params

  • identityId string required

Body Params

object

  • selectedIdClass string enum

    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
    cctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawp
  • frontPhoto object 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
  • backPhoto object 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
  • proofOfResidency object 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

Responses

200
OK

Response Body

object

  • id string required
  • status string enum required
    pendingprocessingapprovedrejected
  • selectedIdClass string enum required
    cctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawp
  • fileUploads array of objects required
    fileUploads object
    • fileName string required

      at least 1 characters

    • fileSize number required
    • uploadStatus string required

      at least 1 characters

    • documentType string enum required
      frontPhotobackPhotoproofOfResidency
400
Bad Request

Response Body

object

  • name string
  • context map of objects required
    context object
    • <key> object
  • status number
  • additionalDetails object
    additionalDetails object
    • retryAfter number required
  • error string required
  • requestId string required
401
Unauthorized

Response Body

object

  • name string
  • context map of objects required
    context object
    • <key> object
  • status number
  • additionalDetails object
    additionalDetails object
    • retryAfter number required
  • error string required
  • requestId string required
403
Forbidden

Response Body

object

  • name string
  • context map of objects required
    context object
    • <key> object
  • status number
  • additionalDetails object
    additionalDetails object
    • retryAfter number required
  • error string required
  • requestId string required
404
Not Found

Response Body

object

  • name string
  • context map of objects required
    context object
    • <key> object
  • status number
  • additionalDetails object
    additionalDetails object
    • retryAfter number required
  • error string required
  • requestId string required