Skip to main content
GET
https://sandbox.finhub.cloud
/
api
/
v2.1
/
customer
/
organization
/
{organizationId}
/
documents
Organization Documents API
curl --request GET \
  --url https://sandbox.finhub.cloud/api/v2.1/customer/organization/{organizationId}/documents \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --data '
{
  "category": "<string>",
  "documentType": "<string>"
}
'
{
  "success": true,
  "data": {
    "documents": [
      {
        "documentId": "doc_12345",
        "category": "INCORPORATION",
        "documentType": "CERTIFICATE_OF_INCORPORATION",
        "fileName": "incorporation_cert.pdf",
        "status": "VERIFIED",
        "uploadedAt": "2024-01-15T10:30:00Z"
      }
    ],
    "pagination": {
      "total": 15,
      "page": 0,
      "size": 20
    }
  }
}

Organization Documents API

APIs for uploading and managing corporate documents for business organizations.
Base URL: https://sandbox.finhub.cloud
For complete details on authentication and headers, refer to the Standard HTTP Headers reference documentation.

Prerequisites

Before uploading documents:
  • Organization must be registered
  • You must have ADMIN_USER or COMPLIANCE_OFFICER role
  • Documents must be in PDF, JPG, or PNG format
  • Maximum file size: 10MB per document

Required Documents for Verification

Different organization types require different documents:
Organization TypeRequired Documents
LLC / Limited Company• Certificate of Incorporation
• Articles of Association
• Shareholder Register
• Director IDs
Partnership• Partnership Agreement
• Partner IDs
• Bank Statement (last 3 months)
Sole Trader• Business License
• Owner ID
• Proof of Address
All Types• Beneficial Owner Declaration
• Financial Statements (if applicable)

Available Operations

Get Documents

GET /documents

Upload Document

POST /documents

Get Document

GET /documents/{id}

Delete Document

DELETE /documents/{id}

Get Documents

Retrieves all documents for an organization with optional filtering.

Request

organizationId
string
required
Organization identifier
Authorization
string
required
Bearer token for authentication
X-Tenant-ID
string
required
Tenant identifier
category
string
Filter by category: INCORPORATION, CONTRACT, FINANCIAL, COMPLIANCE, OTHER
page
integer
Page number (default: 0)
size
integer
Page size (default: 20)

Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/documents?category=INCORPORATION" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"
{
  "success": true,
  "data": {
    "documents": [
      {
        "documentId": "doc_12345",
        "category": "INCORPORATION",
        "documentType": "CERTIFICATE_OF_INCORPORATION",
        "fileName": "incorporation_cert.pdf",
        "status": "VERIFIED",
        "uploadedAt": "2024-01-15T10:30:00Z"
      }
    ],
    "pagination": {
      "total": 15,
      "page": 0,
      "size": 20
    }
  }
}

Upload Document

Uploads a new document for an organization (requires ADMIN role).

Request

organizationId
string
required
Organization identifier
file
file
required
Document file (multipart/form-data)
category
string
required
Document category: INCORPORATION, CONTRACT, FINANCIAL, COMPLIANCE, OTHER
documentType
string
required
Specific document type

Code Examples

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/documents" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -F "file=@/path/to/incorporation_cert.pdf" \
  -F "category=INCORPORATION" \
  -F "documentType=CERTIFICATE_OF_INCORPORATION"
{
  "success": true,
  "data": {
    "documentId": "doc_67890",
    "status": "UPLOADED",
    "uploadedAt": "2024-01-15T10:30:00Z"
  }
}

Delete Document

Deletes a specific document.

Code Examples

curl -X DELETE "https://sandbox.finhub.cloud/api/v2.1/customer/organization/org_12345/documents/doc_12345" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"

Document Categories

CategoryDescription
INCORPORATIONCertificate of incorporation, articles
CONTRACTBusiness contracts and agreements
FINANCIALFinancial statements, audits
COMPLIANCECompliance certificates, licenses
OTHEROther supporting documents

Document Types

TypeCategoryDescription
CERTIFICATE_OF_INCORPORATIONINCORPORATIONCompany registration certificate
ARTICLES_OF_ASSOCIATIONINCORPORATIONCompany articles/bylaws
SHAREHOLDER_REGISTERINCORPORATIONList of shareholders
DIRECTOR_IDCOMPLIANCEDirector identification
BENEFICIAL_OWNER_DECLARATIONCOMPLIANCEUBO declaration form
FINANCIAL_STATEMENTFINANCIALAnnual accounts
BANK_STATEMENTFINANCIALBank statements

Document Specifications

AttributeRequirement
FormatsPDF, JPG, PNG
Max Size10MB per file
ResolutionMinimum 300 DPI (for scans)
ColorColor or grayscale (no black & white)
ReadabilityAll text must be clearly legible
ValidityDocuments must be current (not expired)

Document Status Flow

StatusDescriptionNext Action
UPLOADEDDocument uploaded successfullyWait for review
PENDING_REVIEWQueued for compliance reviewNo action needed
UNDER_REVIEWBeing reviewed by complianceWait for decision
VERIFIEDDocument approvedNone
REJECTEDDocument rejectedUpload corrected version

Response Codes

CodeDescription
200Documents retrieved successfully
201Document uploaded successfully
400Invalid request data or file format
403Access denied (requires ADMIN role)
404Document or organization not found
413File size exceeds 10MB limit
415Unsupported file format
500Internal server error

Common Upload Errors

Error: File Size Too Large

Problem: Document exceeds 10MB limit Solution:
  • Compress PDF using online tools
  • Reduce image resolution to 300 DPI
  • Split large documents into multiple files

Error: Invalid File Format

Problem: File format not supported Solution: Only PDF, JPG, and PNG formats are accepted. Convert other formats (DOC, DOCX, etc.) to PDF before uploading.

Error: Document Not Legible

Problem: Document text is unreadable Solution:
  • Ensure minimum 300 DPI resolution for scans
  • Use color or grayscale (not black & white)
  • Avoid shadows or glare in photos
  • Take photos straight-on (not at an angle)

API Schema Reference

For the complete OpenAPI schema specification, see the API Schema Mapping documentation (similar to individual documents).