Perform KYC

A person's KYC or Verification level can be set/upgraded using this API. The following actions are available.

  • Initiate Verification for an existing Person
  • Update Verification data or documents
  • Answer 'challenge' questions for verification
  • Override verification level by Client
Request
Security:
path Parameters
person_guid
required
string <uuid>

person guid

version
required
string
Request Body schema: application/json
perform_kyc
boolean
notes
string or null
Array of objects or null (PersonIdentificationDTO)

Identification details of the person for electronic identity verification

Array of objects or null (Answer)

To pass the answers for OOW questions(if applicable)

object (Document)
object (ClientVerification)
program_guid
string <uuid>
Responses
200

Returns the KYC details for person

400

Bad request

401

Unauthorized

404

Person not found

500

Server Error

post/api/{version}/persons/{person_guid}/kyc
Request samples
application/json
{
  • "perform_kyc": true,
  • "notes": "string",
  • "identifications": [
    • {
      • "govt_id_type": "NOTPROVIDED",
      • "govt_id_number": "string"
      }
    ],
  • "answers": [
    • {
      • "key": "string",
      • "answer": "string"
      }
    ],
  • "document": {
    • "document_type": "PASSPORT",
    • "file_type": "BMP",
    • "issuing_country": "string",
    • "front": "string",
    • "back": "string",
    • "face_image": "string",
    • "liveness_detected": true
    },
  • "client_verification": {
    • "document_approved": true,
    • "person_status_update": true,
    • "override_sanction_check": true,
    • "verification_datetime": "2019-08-24T14:15:22Z",
    • "verification_provider": "string",
    • "verification_provider_refnumber": "string",
    • "verification_level": "string",
    • "document": {
      • "document_type": "PASSPORT",
      • "file_type": "BMP",
      • "issuing_country": "string",
      • "front": "string",
      • "back": "string",
      • "face_image": "string",
      • "liveness_detected": true
      }
    },
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f"
}
Response samples
application/json
{
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "verification_mode": "string",
  • "verification_level": "string",
  • "additional_desc": "string",
  • "verificationResults": [
    • {
      • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
      • "verification_method": "string",
      • "verification_date": "2019-08-24T14:15:22Z",
      • "document_type": "string",
      • "document_path": "string",
      • "response_code": "string",
      • "verification_results": "string",
      • "reason_code": "string",
      • "questions": [
        • {
          • "prompt": "string",
          • "key": "string",
          • "options": [
            • "string"
            ]
          }
        ],
      • "provider_reference": "string",
      • "provider_name": "string",
      • "documents": {
        • "document_reference": "string",
        • "file_type": "string",
        • "back_file_type": "string",
        • "front_docpath": "string",
        • "back_docpath": "string",
        • "face_image_docpath": "string"
        }
      }
    ]
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.