---
title: "Get customer documents"
method: GET
path: "/platform/v1/customers/documents"
tags: ["Customers"]
---

# Get customer documents

`GET /platform/v1/customers/documents`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/platform/v1/customers/documents`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v1/customers/documents/get.ts> (a function with typed inputs; its response is checked against the schema)

:::info Customers API v2
The [new customer onboarding flow](../../../get-started/create-embedded-partner-customer/create-customers-com) is recommended for all new integrations.

If you already have an existing integration with Customers API v1, you can continue using it. BVNK will continue to support this API going forward.
:::

Retrieves the details of the specific document added for the Customer. If no parameters are specified, retrieves the array of available documents.

## Query parameters

- `customerReference` string, uuid
- `externalReference` string, uuid
- `name` string
- `type` string
- `subtype` string
- `status` 'INIT' | 'PENDING' | 'APPROVED' | 'DECLINED'

## Response `200`

successful operation

- object
  - `content` object[]
    - `reference` string, uuid, required: Internal document identifier
    - `externalReference` string, uuid, required: External document tracking ID
    - `customerReference` string, uuid, required: Customer identifier
    - `customerPersonReference` string, uuid: Customer person identifier (for individuals)
    - `accountReference` string, uuid: Associated account identifier
    - `type` string, required: Document type
    - `subType` string: Subtype of document
    - `name` string, required: Filename of the document
    - `description` string: Optional document description
    - `countryCode` string, required: ISO 3166-1 alpha-2 country code
    - `country` string, required: Full country name
    - `status` 'INIT' | 'PENDING' | 'APPROVED' | 'DECLINED', required: Current document status

## Other responses

- `404`: The specified resource was not found

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)