---
title: "List required information"
method: GET
path: "/platform/v1/customers/{customerReference}/info-required"
tags: ["Customers"]
---

# List required information

`GET /platform/v1/customers/{customerReference}/info-required`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/platform/v1/customers/{customerReference}/info-required`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v1/customers/:customerReference/info-required/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 detailed information about what documents and data are required for customer onboarding when their status is `INFO_REQUIRED`. This endpoint provides specific requirements for documents, questionnaires, and additional data needed to complete the onboarding process.

## Path parameters

- `customerReference` string, uuid, required

## Response `200`

Successful operation

- object
  - `status` 'INFO_REQUIRED' | 'PENDING' | 'VERIFIED' | 'REJECTED' | 'TERMINATED': Current status of the customer. `INFO_REQUIRED` is related only to the Embedded model.
  - `infoRequired` object: Details about what documents are required for onboarding. Only present when status is INFO_REQUIRED.
    - `questionnaires` object[]: List of questionnaires that need to be completed.
    - `documents` object[]: List of document sets that need to be provided for compliance.
      - `docSetType` 'IDENTITY' | 'SELFIE' | 'PROOF_OF_RESIDENCE': Type of document set
      - `types` string[]: Specific document types accepted for this document set.
    - `data` object[]: Additional data requirements. Mirrors the response of the [`/platform/v1/customers/{customerReference}`](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-customer-with-external-status) endpoint.

## Other responses

- `401`: Unauthorized
- `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)