Manage Documents

Get customer document

Returns a single customer document by their id's.

get/platform/v2/customers/{customerId}/documents/{documentId}

Request

Base URL
https://api.sandbox.bvnk.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v2/customers/:customerId/documents/:documentId/get.ts
A function with typed inputs. Its response is checked against the schema.

customerIdstring uuid required

Example:0a184641-30e2-4414-871f-3db1c683900e

Customer id.

documentIdstring uuid required

Example:b8f8a6b5-8f44-4b7c-8d1e-4a6a5a9b4a21

Document id.

Customer document details

idstring uuid

filenamestring

typestring

checksumstring

SHA-256 hex checksum of the uploaded content.

status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETE' | 'ERROR'

createdAtstring date-time

updatedAtstring date-time