List Business Documents

The business's documents, each with its type and whether its upload was completed, and the per-file size limit, so your client can check a file before presigning it.

Takes a workspace-scoped API key or a dashboard session. An account-scoped key is refused with 401.

New in v3: in v2, documents were part of GET /api/v2/kyb/banking-verification/business/{accountId}, as verificationFiles.

Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
  Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

GET

/v3/customers/{customer_id}/kyb/documents

Path parameters

Parameter	Type	Description
customer_id	string (cst_…)	Required. The business customer.

The whole set is returned at once: this list is not paginated. A customer with no record answers 204 No Content, with no body. An id that names no customer of the workspace answers 404 customer_not_found, not 204.

Response Sample

{
  "documents": [
    {
      "document_id": "doc_01m24s2q00fqrbpn5wwx8akzr5",
      "slot": "certificate_of_incorporation",
      "state": "ready",
      "size_bytes": 524288,
      "content_type": "application/pdf",
      "file_name": "certificate-of-incorporation.pdf"
    },
    {
      "document_id": "doc_01m24wgjm0ee9s5ms8j6f1ga3x",
      "slot": "proof_of_address",
      "state": "pending",
      "size_bytes": 182044,
      "content_type": "image/png",
      "file_name": "utility-bill.png"
    }
  ],
  "max_document_bytes": 3145728
}

Response Schema

Field	Type	Description
documents	array	One entry per document type on file.
documents[].document_id	string (doc_…)	The document.
documents[].slot	string	Its type. See Upload a Business Document.
documents[].state	string	pending: presigned, upload not completed yet. ready: completed, and counts as evidence.
documents[].size_bytes	integer	Size in bytes: as declared while pending, as stored once ready.
documents[].content_type	string	application/pdf, image/jpeg or image/png.
documents[].file_name	string	The uploader's name for the file. Absent for documents uploaded through v2.
max_document_bytes	integer	The largest file accepted, in bytes. Read it here rather than hard-coding it.

Errors

Status	message	When
400	failed to parse request	customer_id is not a cst_… TypeID.
401	unauthorized	Missing or invalid signature, or an account-scoped key or customer session.
403	forbidden	A dashboard member whose role does not allow this. A workspace-scoped key always may.
404	customer_not_found	No such customer in the workspace.

Support and Resources

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

• Instagram: BlockWyre Instagram
• Twitter: BlockWyre Twitter
• Facebook: BlockWyre Facebook
• LinkedIn: BlockWyre LinkedIn

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!