Skip to main content

Verification Document Management API

APIs for uploading and managing documents associated with verification processes.
Base URL: https://sandbox.finhub.cloud

Available Operations

Get Documents

GET /verifications/{id}/documents

Upload Document

POST /verifications/{id}/documents

Get Verification Documents

Retrieves all documents for a specific verification process.

Request

verificationId
string
required
Verification identifier
Authorization
string
required
Bearer token for authentication
X-Tenant-ID
string
required
Tenant identifier
X-Forwarded-From
string
required
Source identifier for request origin tracking
User-Agent
string
required
Client application identifier — required by the global request filter
platform
string
required
Client platform identifier. Also accepted as sec-ch-ua-platform
deviceId
string
required
Unique device identifier for session tracking. Also accepted as X-Device-Id or device-id

Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/verifications/ver_12345/documents" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: 97e7ff29-15f3-49ef-9681-3bbfcce4f6cd" \
  -H "X-Forwarded-From: e2e-test" \
  -H "User-Agent: YourApp/1.0" \
  -H "platform: web" \
  -H "deviceId: 356938035643809"
{
  "success": true,
  "data": {
    "documents": [
      {
        "documentId": "doc_12345",
        "documentType": "GOVERNMENT_ID",
        "status": "VERIFIED",
        "uploadedAt": "2024-01-15T10:30:00Z"
      },
      {
        "documentId": "doc_67890",
        "documentType": "PROOF_OF_ADDRESS",
        "status": "PENDING_REVIEW",
        "uploadedAt": "2024-01-15T10:35:00Z"
      }
    ]
  }
}

Upload Verification Document

Uploads a document for a specific verification process.

Request

verificationId
string
required
Verification identifier
documentType
string
required
Type of document: GOVERNMENT_ID, PROOF_OF_ADDRESS, SELFIE, etc.
documentId
string
Optional document ID (for re-uploads)
Authorization
string
required
Bearer token for authentication
X-Tenant-ID
string
required
Tenant identifier
X-User-Id
string
Uploading user ID
file
file
required
Document file (multipart/form-data)
category
string
Document category

Code Examples

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/verifications/ver_12345/documents?documentType=GOVERNMENT_ID" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: 97e7ff29-15f3-49ef-9681-3bbfcce4f6cd" \
  -H "X-Forwarded-From: e2e-test" \
  -H "User-Agent: YourApp/1.0" \
  -H "platform: web" \
  -H "deviceId: 356938035643809" \
  -F "file=@/path/to/passport.pdf"
{
  "success": true,
  "data": {
    "documentId": "doc_11111",
    "verificationId": "ver_12345",
    "documentType": "GOVERNMENT_ID",
    "status": "UPLOADED",
    "uploadedAt": "2024-01-15T10:30:00Z"
  }
}

Document Types

TypeDescription
GOVERNMENT_IDPassport, national ID, driver’s license
PROOF_OF_ADDRESSUtility bill, bank statement (< 3 months)
SOURCE_OF_FUNDSIncome proof, tax returns
SELFIECustomer selfie for liveness check
CERTIFICATE_OF_INCORPORATIONCompany registration
BENEFICIAL_OWNER_DECLARATIONUBO declaration

Document Statuses

StatusDescription
UPLOADEDDocument uploaded
PENDING_REVIEWAwaiting review
VERIFIEDDocument verified
REJECTEDDocument rejected

Response Codes

CodeDescription
200Documents retrieved successfully
201Document uploaded successfully
400Invalid request data
404Verification not found
500Internal server error