BVbvnk
Customers

List required information

:::info Customers API v2 The new customer onboarding flow 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.

get/platform/v1/customers/{customerReference}/info-required

Request

Path parameters

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

Unique identifier of the customer in the UUID format.

Response

Successful operation

status'INFO_REQUIRED' | 'PENDING' | 'VERIFIED' | 'REJECTED' | 'TERMINATED'

Current status of the customer. INFO_REQUIRED is related only to the Embedded model.

Example response

{
  "status": "INFO_REQUIRED",
  "infoRequired": {
    "documents": [
      {
        "docSetType": "IDENTITY",
        "types": [
          "PASSPORT",
          "DRIVERS",
          "ID_CARD",
          "RESIDENCE_PERMIT"
        ]
      },
      {
        "docSetType": "SELFIE",
        "types": [
          "SELFIE"
        ]
      }
    ],
    "data": []
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.