BVbvnk
Customers

Get customer documents

:::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 the details of the specific document added for the Customer. If no parameters are specified, retrieves the array of available documents.

get/platform/v1/customers/documents

Request

Query parameters

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

Customer reference

externalReferencestring uuid
Example:501e87bb-24d7-4008-a249-f485512b8a14

External document tracking ID

namestring
Example:J_Kaldwin_Passport.pdf

Customer reference

typestring
Example:PASSPORT

Document type

subtypestring
Example:FRONT_SIDE

Subtype of document

status'INIT' | 'PENDING' | 'APPROVED' | 'DECLINED'
Example:APPROVED

Initial status of the document upload

Response

successful operation

Example response

{
  "content": [
    {
      "reference": "c1d7aa15-77f0-40b2-a990-ae0610422c73",
      "externalReference": "501e87bb-24d7-4008-a249-f485512b8a14",
      "customerReference": "d9f2ffc1-4d80-49ff-b44d-d3e43bd7b66a",
      "customerPersonReference": "b6179794-73a1-42d4-af56-bdb57313bc4b",
      "accountReference": "5bc49988-fe25-408f-bccc-3e0fe96cf322",
      "type": "PASSPORT",
      "name": "A_Sokolov_Residence_Permit.pdf",
      "description": "Document optional description",
      "countryCode": "DE",
      "country": "Germany",
      "status": "PENDING"
    },
    {
      "reference": "34d5b0e3-8fb9-4f4e-86c5-3a438388c1c0",
      "externalReference": "09a92c28-6fbe-4ea8-bff3-88451078faa9",
      "customerReference": "d9f2ffc1-4d80-49ff-b44d-d3e43bd7b66a",
      "accountReference": "5bc49988-fe25-408f-bccc-3e0fe96cf322",
      "type": "CERTIFICATE_OF_INCORPORATION",
      "name": "Certificate of Incorporation.pdf",
      "description": "Document optional description",
      "countryCode": "FR",
      "country": "France",
      "status": "PENDING"
    }
  ]
}

Changes

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