Gravv docs
Docs Agent Sign in Get API keys
API Reference

List KYC documents

Lists the documents stored for a customer, with their details and which sides have an image. Use a document's id to download its image.

The response includes each document number in plain text. Treat it as personal data. A customer with no documents gets a 404, not an empty list.

GEThttps://api.gravv.xyz/v1/customers/{customer_id}/kyc/documents

Path Parameters

UUID of the customer

Responses

Status Description
200 Stored documents
400 Invalid customer ID
404 Customer not found, or no documents stored
500 The documents could not be read

200 response

ID of the customer the documents belong to

Stored documents. Keys are PascalCase except id, has_front_image and has_back_image. Empty values are null.

Document ID. Use it to download the image.

Document type, such as ID_CARD, SELFIE or COMPANY_DOC

Document subtype

Document number in plain text. Handle it as personal data.

Issuing country (ISO 3166-1 alpha-3)

Issue date as uploaded

Expiry date as uploaded

Whether a front image is stored

Whether a back image is stored

File name sent at upload

Number of stored documents

 
{
"data": {
"customer_id": "42ad0adb-e134-4345-b4be-98e5021b0da8",
"documents": [
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "IDType": "PASSPORT",
    "IDSubType": "FRONT_SIDE",
    "IDNumber": "A12345678",
    "IssuingCountry": "NGA",
    "IssuedDate": "2020-01-01",
    "ExpiryDate": "2030-01-01",
    "has_front_image": true,
    "has_back_image": false,
    "OriginalFilename": "passport_front.jpg"
  }
],
"count": 1
},
"error": null
}

400 response

Always null for error responses

Error message. Most messages start with an upper-case code and a colon, such as INVALID_REQUEST: ....

 
{
"data": null,
"error": "INVALID_REQUEST: The customer ID provided is not valid. Please verify the customer ID format."
}

404 response

Always null for error responses

Error message. Most messages start with an upper-case code and a colon, such as INVALID_REQUEST: ....

 
{
"data": null,
"error": "CUSTOMER_NOT_FOUND: Customer not found. Please verify the customer exists in our system."
}

{
"data": null,
"error": "no KYC document data found for customer"
}

500 response

Always null for error responses

Error message. Most messages start with an upper-case code and a colon, such as INVALID_REQUEST: ....

 
{
"data": null,
"error": "failed to retrieve KYC document data"
}

Authorization

  • ApiKeyAuth
Was this page helpful?
ESC