Customer APIs
APIs for individual (B2C) and organization (B2B) customer lifecycle management
Customer APIs
Unified API surface for managing the complete customer lifecycle — registration, authentication, identity verification, consent collection, and account activation — for both individual and business customers.
Customer Types
Personal customer onboarding: categorization, registration, sessions, verification, and activation
Business customer onboarding: registration, directors, employees, shareholders, and activation
Shared Onboarding Pattern
Both B2C and B2B flows follow the same high-level pattern:
flowchart LR
A[Register] --> B[Authenticate]
B --> C[Verify Identity]
C --> D[Upload Documents]
D --> E[Accept Consents]
E --> F[Activate]
Individual (B2C) onboarding flow
flowchart TB
I1["(1) Categorization"] --> I2["(2) Registration"]
I2 --> I3["(3) Session creation"]
I3 --> I4["(4) Verification"]
I4 --> I5["(5) Document upload"]
I5 --> I6["(6) Consent acceptance"]
I6 --> I7["(7) Activation"]
Organization (B2B) onboarding flow
flowchart TB
O1["(1) Categorization"] --> O2["(2) Organization registration"]
O2 --> O3["(3) Employee/personnel setup"]
O3 --> O4["(4) Session creation"]
O4 --> O5["(5) KYB verification"]
O5 --> O6["(6) Document upload"]
O6 --> O7["(7) Consent acceptance"]
O7 --> O8["(8) Activation"]
| Step | Individual (B2C) | Organization (B2B) |
|---|---|---|
| Register | POST /individual/registration | POST /organization/registration |
| Personnel | — | POST /{orgId}/employee, GET /{orgId}/directors |
| Verify | POST /{customerId}/verification | Via Verification & Compliance APIs |
| Consents | POST /{customerId}/consents/{type} | POST /{orgId}/consents/{type} |
| Activate | POST /{customerId}/activation | POST /{orgId}/activation |
Authentication
All Customer API endpoints require the following headers:
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <token> — OAuth 2.0 access token from an admin or customer session |
X-Tenant-ID | Yes | Your tenant identifier |
Content-Type | Yes | application/json for all POST requests |
curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/individual/registration" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "X-Tenant-ID: YOUR_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{ ... }'Related Resources
KYC/KYB verification, document upload, approval, and consent management
Admin sessions, roles, audit trails, and platform management
Wallet balances, transfers, beneficiaries, and payment consents
Webhook subscriptions and testing utilities