BVbvnk
Customers

Upload documents to customer

Changed on

:::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. :::

Attach one or more documents to a customer's profile. This can be either a company customer (with optional linkage to a specific associate) or an individual customer. Files must be base64-encoded before submission.

  • For company-level documents, omit customerPersonReference.
  • For associate-level documents, provide the customerPersonReference.
  • The customer must be in INFO_REQUIRED status.
post/platform/v1/customers/{customerReference}/documents

Request

Path parameters

customerReferencestring required
Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the customer to whom the documents will be attached. Must be in INFO_REQUIRED status.

Request body

Example request

[
  {
    "type": "COMPANY_DOC",
    "subType": "INCORPORATION_CERT",
    "name": "Certificate of Incorporation.pdf",
    "description": "Certificate of incorporation",
    "countryCode": "DE",
    "externalReference": "2b8d8bde-eef5-408a-9228-96bef24865ad",
    "content": "JVBERi0xLjUKJeLjz9MKMSAwIG9iago8PC9UeXBlIC9QYWdl..."
  },
  {
    "customerPersonReference": "9b2c3d4e-567f-48f0-abc1-03a4e3df12ab",
    "type": "PASSPORT",
    "name": "John Smith Passport.pdf",
    "description": "Passport single-sided",
    "countryCode": "DE",
    "externalReference": "8eabc8f2-7f76-4d2e-9fa6-0a11e94d3dcd",
    "content": "JVBERi0xLjUKJeLjz9MKMSAwIG9iago8PC9UeXBlIC9QYWdl..."
  }
]

Response

Documents accepted and queued for upload.

referencestring uuid

Unique reference for the document upload request.

externalReferencestring uuid

External reference sent in the request.

status'INIT'

Initial status of the document upload.

Example response

{
  "reference": "d42e1c62-27b8-4b3b-b51e-eb10edeb1731",
  "externalReference": "2b8d8bde-eef5-408a-9228-96bef24865ad",
  "status": "INIT"
}

Changes

  • 97d6c0d2fe2eRevision changes
    • breaking

      request property // was restricted to a list of enum values

    • breaking

      request property // was restricted to a list of enum values

    • breaking

      request property // was restricted to a list of enum values

    • breaking

      request property // was restricted to a list of enum values

    • info

      added the new AGREEMENT enum value to the request property //

    • info

      added the new ARBITRARY_DOC enum value to the request property //

    • info

      added the new BACK_SIDE enum value to the request property //

    • info

      added the new BANK_CARD enum value to the request property //

    • info

      added the new CAPITALISATION_OWNERSHIP_STRUCTURE enum value to the request property //

    • info

      added the new COMPANY_DOC enum value to the request property //

    • info

      added the new CONTRACT enum value to the request property //

    • info

      added the new COVID_VACCINATION_FORM enum value to the request property //

    • info

      added the new DIRECTORS_REGISTRY enum value to the request property //

    • info

      added the new DRIVERS enum value to the request property //

    • info

      added the new DRIVERS_TRANSLATION enum value to the request property //

    • info

      added the new FILE_ATTACHMENT enum value to the request property //

    • info

      added the new FRONT_SIDE enum value to the request property //

    • info

      added the new GOOD_STANDING_CERT enum value to the request property //

    • info

      added the new ID_CARD enum value to the request property //

    • info

      added the new ID_DOC_PHOTO enum value to the request property //

    • info

      added the new INCOME_SOURCE enum value to the request property //

    • info

      added the new INCORPORATION_ARTICLES enum value to the request property //

    • info

      added the new INCORPORATION_CERT enum value to the request property //

    • info

      added the new INCUMBENCY_CERT enum value to the request property //

    • info

      added the new INFORMATION_STATEMENT enum value to the request property //

    • info

      added the new INVESTOR_DOC enum value to the request property //

    • info

      added the new MEMORANDUM enum value to the request property //

    • info

      added the new OTHER enum value to the request property //

    • info

      added the new OTHER enum value to the request property //

    • info

      added the new PARTNERSHIP_AGREEMENT enum value to the request property //

    • info

      added the new PASSPORT enum value to the request property //

    • info

      added the new PAYMENT_SOURCE enum value to the request property //

    • info

      added the new POWER_OF_ATTORNEY enum value to the request property //

    • info

      added the new POWER_OF_ATTORNEY enum value to the request property //

    • info

      added the new PROFILE_IMAGE enum value to the request property //

    • info

      added the new PROOF_OF_ADDRESS enum value to the request property //

    • info

      added the new PROOF_OF_NATURE_OF_BUSINESS enum value to the request property //

    • info

      added the new REGULATORY_LICENSE enum value to the request property //

    • info

      added the new RESIDENCE_PERMIT enum value to the request property //

    • info

      added the new SELFIE enum value to the request property //

    • info

      added the new SELF_DECLARATION_FORM enum value to the request property //

    • info

      added the new SHAREHOLDER_REGISTRY enum value to the request property //

    • info

      added the new SOURCE_OF_FUNDS enum value to the request property //

    • info

      added the new STATE_REGISTRY enum value to the request property //

    • info

      added the new TRADE_LICENSE enum value to the request property //

    • info

      added the new TRANSPARENCY_REGISTRY_EXTRACT enum value to the request property //

    • info

      added the new TRUST_AGREEMENT enum value to the request property //

    • info

      added the new UTILITY_BILL enum value to the request property //

    • info

      added the new UTILITY_BILL2 enum value to the request property //

    • info

      added the new VEHICLE_REGISTRATION_CERTIFICATE enum value to the request property //

    • info

      added the new VIDEO_SELFIE enum value to the request property //