v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB

Physical Documents

Upload Physical Document

Uploads a Physical Document.

post/documents

Request body

userIDstring required

A unique identifier created for each User on DriveWealth's platform.

type'DRIVER_LICENSE' | 'PASSPORT' | 'NATIONAL_ID_CARD' | 'VOTER_ID' | 'WORK_PERMIT' | 'VISA' | 'RESIDENCE_PERMIT' | 'ACATS_IN' | 'ACATS_OUT' | 'TRANSFER_ON_DEATH' | 'BENEFICIARY_DOCUMENT' | 'BUSINESS_DOCUMENT' | 'TRUST_DOCUMENTS' required

The type of physical document.

documentstring required

The Base64 encoded string of the document.

sidestring

The actual side of the physical document.

Example request

{
  "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "type": "DRIVER_LICENSE",
  "document": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4QCMR",
  "side": "FRONT"
}

Response

Uploading a Physical Document was Successful.

idstring

The unique identifier of the document.

type'DRIVER_LICENSE' | 'PASSPORT' | 'NATIONAL_ID_CARD' | 'VOTER_ID' | 'WORK_PERMIT' | 'VISA' | 'RESIDENCE_PERMIT' | 'ACATS_IN' | 'ACATS_OUT' | 'TRANSFER_ON_DEATH' | 'BENEFICIARY_DOCUMENT' | 'BUSINESS_DOCUMENT' | 'TRUST_DOCUMENTS'

The type of physical document.

sidestring

The actual side of the physical document.

Example response

{
  "id": "532e1b7d-09fd-4a1b-956f-d4e91ad71b4f",
  "type": "DRIVER_LICENSE",
  "status": {
    "name": "NOT_SUBMITTED",
    "description": "Document has not been submitted for approval."
  },
  "side": "FRONT"
}