Uploading Documents

Overview

The Crypto Documents API provides a way for clients to upload and download documents associated with investors for the account opening process.

Workflows

Document Upload Process

In order to upload documents relevant to opening investor accounts, post a request to the Upload Document and Metadata endpoint with the necessary file in MIME type format. Include the applicable JSON structured with the document request for associated metadata. After submitting the upload request, Bakkt runs a series of validations across the metadata to ensure proper formatting.

Example

{
  "clientDocumentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "account": "string",
  "documentType": "PASSPORT",
  "description": "string"
}

Document Download Process

In order to download a particular document, use the Download Document endpoint, and provide the clientDocumentId for the specific file.

Retrieve Document Metadata

To retrieve the metadata for a particular file, use the Retrieve Metadata for Specific Document endpoint, and provide the document’s clientDocumentId. Metadata uploaded with this file is then available along with the createdAt field specifying the creation date-time and the Bakkt id.

Example

{
  "createdAt": "2022-06-29T02:55:02.847Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "request": {
    "clientDocumentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "account": "string",
    "documentType": "PASSPORT",
    "description": "string"
 }
}