logoOPEN BANKING DOCS

Get customer KYC status

Retrieve KYC verification status for a customer

GET
/customers/{customerId}/kyc/status
X-API-Key<token>

In: header

Path Parameters

customerIdstring

Customer UUID

Formatuuid

Header Parameters

X-API-Keystring

API key for the application

X-App-Idstring

UUID of the application

Formatuuid

Response Body

curl -X GET "https://virtual-accounts-api.vantacrest.com/company/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/kyc/status" \  -H "X-API-Key: string" \  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": {
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "kycLevel": "TIETR_1",
    "kycStatus": "PENDING",
    "verificationDate": "2019-08-24T14:15:22Z",
    "verifiedBy": "a9613b4f-4200-4346-bccf-25c05ba0b5ee",
    "rejectionReason": "string",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "documentsRequired": [
      "NATIONAL_ID"
    ],
    "documentsSubmitted": [
      {
        "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
        "documentType": "NATIONAL_ID",
        "documentStatus": "PENDING",
        "uploadedAt": "2019-08-24T14:15:22Z",
        "reviewedAt": "2019-08-24T14:15:22Z",
        "reviewedBy": "849e71dc-4e73-4d65-b54c-c7fc0faacffa",
        "rejectionReason": "string",
        "documentUrl": "string"
      }
    ]
  }
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}