Skip to main content

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.
Base URL: https://sandbox.finhub.cloud/api/v2.1/customer

Customer Types

Individual (B2C)

Personal customer onboarding: categorization, registration, sessions, verification, and activation

Organization (B2B)

Business customer onboarding: registration, directors, employees, shareholders, and activation

Shared Onboarding Pattern

Both B2C and B2B flows follow the same high-level pattern:

Individual (B2C) onboarding flow

Organization (B2B) onboarding flow

StepIndividual (B2C)Organization (B2B)
RegisterPOST /individual/registrationPOST /organization/registration
PersonnelPOST /{orgId}/employee, GET /{orgId}/directors
VerifyPOST /{customerId}/verificationVia Verification & Compliance APIs
ConsentsPOST /{customerId}/consents/{type}POST /{orgId}/consents/{type}
ActivatePOST /{customerId}/activationPOST /{orgId}/activation
Verification, document upload, and consent management are handled through the Verification & Compliance APIs, which are shared across both customer types.

Authentication

All Customer API endpoints require the following headers:
HeaderRequiredDescription
AuthorizationYesBearer <token> — OAuth 2.0 access token from an admin or customer session
X-Tenant-IDYesYour tenant identifier
Content-TypeYesapplication/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 '{ ... }'

Verification & Compliance

KYC/KYB verification, document upload, approval, and consent management

Administration

Admin sessions, roles, audit trails, and platform management

Financial Operations

Wallet balances, transfers, beneficiaries, and payment consents

Developer Tools

Webhook subscriptions and testing utilities