Skip to main content

​
Individual Customer APIs (B2C)

End-to-end API reference for individual customer lifecycle management — from categorization and registration through identity verification, consent collection, and account activation.
Base URL: https://sandbox.finhub.cloud/api/v2.1/customer/individual
Verification, document upload, and consent acceptance are handled through the Verification & Compliance APIs. This section covers the customer-specific endpoints only.

​
Onboarding Journey

The individual customer onboarding flow follows 5 customer API phases, plus verification and consent steps handled by the Verification & Compliance APIs:
PhaseAPI SectionEndpointDescription
1. CategorizationCustomerGET /categorization/hierarchy/{tenantId}Retrieve available customer categories and risk tiers
2. RegistrationCustomerPOST /registrationCreate a new individual customer with personal details
3. SessionCustomerPOST /{customerId}/users/{userId}/sessionsAuthenticate and obtain a JWT access token
4. VerificationCustomerPOST /{customerId}/verificationInitiate identity verification for the customer
5. KYC DocumentsVerificationPOST /verifications/{verificationId}/documentsUpload identity and address documents
6. KYC ApprovalVerificationPOST /verifications/{verificationId}/approveAdmin approves the verification submission
7. ConsentsVerificationPOST /{customerId}/consents/{consentType}Accept terms, privacy, and data-processing consents
8. ActivationCustomerPOST /{customerId}/activationActivate the customer account and wallet
Steps 5-7 use endpoints from the Verification & Compliance section. See the Verification & Compliance overview for details.

​
API Endpoints

Categorization

Retrieve the category hierarchy to determine available customer tiers and features

Registration

Register a new individual customer with personal and contact information

Sessions

Create authenticated sessions and obtain JWT tokens

Verification

Initiate identity verification (KYC) for a registered customer

Activation

Activate the customer account once all prerequisites are met

​
Quick Start

​
1. Retrieve Categories

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/customer/individual/categorization/hierarchy/{tenantId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"

​
2. Register Customer

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/individual/registration" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "SecurePass123!",
    "customerCategory": { "id": "fs-cat-b2c-low-001" },
    ...
  }'

​
3. Create Session

curl -X POST "https://sandbox.finhub.cloud/api/v2.1/customer/individual/{customerId}/users/{userId}/sessions" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{ "username": "user@example.com", "password": "SecurePass123!" }'

​
4-8. Complete Verification, Consents & Activation

See the Verification & Compliance section for document upload, approval, and consent endpoints, then return to the Activation endpoint to complete onboarding.

​
Prerequisites

  • API credentials obtained (Tenant ID, API keys, admin session token)
  • Customer categorization selected from the hierarchy
  • Customer personal information collected (name, email, date of birth, nationality)
  • Identity documents ready (passport or national ID, proof of address)

​
Customer Lifecycle

Verification & Compliance

KYC document upload, approval, and consent management

Organization APIs (B2B)

Business customer onboarding and management

Financial Operations

Wallet balances, transfers, and payment operations

Administration

Admin sessions, roles, and platform management