​
Customer Management API

The Customer Management API provides endpoints for creating and managing individual and business customers in the FinHub platform. These APIs are essential for the customer registration and onboarding process, enabling tenants to implement seamless user experiences.

​
Overview

Customer management is a foundational component of financial services offered through the FinHub platform. It enables tenants to register, verify, and manage their customers’ profiles, which is a prerequisite for most other financial services such as KYC verification, wallet creation, and transaction processing.

​
Microservices

These APIs are primarily handled by the customerMs (Customer Microservice) which manages all customer-related operations including profile creation, updates, and verification processes.

​
Integration Flow

The customer management flow typically consists of the following steps:

  1. Customer Registration - Create a new customer profile (individual or business)
  2. Contact Verification - Verify email address and phone number
  3. Profile Completion - Collect and store additional customer information
  4. Account Activation - Activate the customer account after verification

​
Detailed Implementation Guide

For complete step-by-step implementation guides, please refer to the following documentation:

Individual Account Opening Guide

Complete implementation guide for onboarding individual customers

Business Account Opening Guide

Complete implementation guide for onboarding business customers

B2C Registration Flow

End-to-end registration process for individual customers

B2B Registration Flow

End-to-end registration process for business customers

These guides include:

  • Detailed sequence diagrams
  • Code examples for each step
  • Best practices for implementation
  • Error handling strategies
  • Testing recommendations

​
Key API Endpoints

​
Customer Profile Management

GET /profile/{customerId}

Retrieve customer profile information using their unique customer ID.

POST /profile

Create a new customer profile.

PUT /profile/{customerId}

Update an existing customer profile.

​
Customer Verification

POST /email/verify

Verify a customer’s email address.

POST /phone/verify

Verify a customer’s phone number.

The customer management process is used in several key integration flows. For complete implementation details, refer to these guides:

Individual Account Opening

Complete flow for onboarding individual customers

Business Account Opening

Complete flow for onboarding business customers

B2C Registration Flow

End-to-end registration process for individual customers

B2C Authentication Flow

Authentication process for individual customers

B2B Registration Flow

End-to-end registration process for business customers

B2B Tenant Flow

Tenant onboarding and configuration process

​
Integration with FinHub Platform

The Customer Management API is a key component of the following FinHub capabilities:

  • SCT01: B2C Distribution Channel
  • SCT02: B2B Distribution Channel
  • SCT03: Country of Operation (for country-specific compliance requirements)

It’s a critical part of FinHub’s FinCore™ foundational banking system, enabling tenants to manage their customer base while maintaining compliance with financial regulations.

​
Tenant Model Implementation

In FinHub’s tenant model, each tenant has their own Business Entity configuration that allows them to:

  • Register and manage their customers (individuals or businesses)
  • Collect and store customer profile information
  • Verify customer identity and contact information
  • Link customers to other services such as KYC verification and wallet management

This integration guide helps tenants implement these capabilities while providing a seamless onboarding experience for their customers.