Retrieve Person KYC

Use this end point to display KYC documents

Request
Security:
path Parameters
person_guid
required
string <uuid>

person guid

version
required
string
Responses
200

Returns the KYC details for person

400

Bad request

401

Unauthorized

404

Person not found

500

Server Error

get/api/{version}/persons/{person_guid}/kyc
Request samples
curl -i -X GET \
  'https://qvapikeybank.qolopay.com/api/{version}/persons/{person_guid}/kyc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
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.