Skip to main content

​
FinCore™ Customer API

The Customer API is a comprehensive suite of endpoints that enables you to manage the complete customer lifecycle, from registration and authentication to profile management and compliance.

​
Key Features

  • Complete Customer Journey Management: Handle the entire customer lifecycle from registration to ongoing account management
  • Multi-Tenant Support: Designed for multi-tenant environments with proper isolation between tenant data
  • B2C and B2B Capabilities: Support for both individual (SCT01) and business (SCT02) customer profiles
  • Compliance Integration: Built-in compliance workflows for KYC/KYB verification (SCT11)
  • Security-First Design: OAuth 2.0 authentication, role-based access control, and two-factor authentication
  • Extensible Architecture: Modular design that allows for customization based on subscription tier

​
Capability Requirements

The Customer API functionality is divided into capability codes that align with FinHub subscription tiers:
CapabilityDescriptionSubscription Tiers
SCT01B2C Customer ManagementStarter, Professional, Enterprise, Custom
SCT02B2B Customer ManagementProfessional, Enterprise, Custom
SCT11Document ManagementProfessional, Enterprise, Custom
SCT12TPP ManagementEnterprise, Custom

​
API Structure

The Customer API is organized into logical sections that follow the customer journey:
  1. Registration: Endpoints for creating new customer profiles
  2. Authentication: User login, logout, and two-factor authentication
  3. Verification: KYC/KYB verification workflows
  4. Access Control: Credential and permission management
  5. Profile Management:
    • B2C Profiles: Individual customer data management
    • B2B Profiles: Business customer data management
  6. Account & Security Management:
    • Group Management: User grouping and organization
    • TPP Management: Third-party provider integration
  7. Financial Operations:
    • Beneficiary Management: Managing payment recipients
  8. Compliance:
    • Document Management: Handling identity and verification documents

​
Base URL

https://api.finhub.com/v2/customer
```text`n## Authentication

All Customer API endpoints require OAuth 2.0 authentication. See the [Authentication Guide](/latest/auth/introduction) for details on obtaining and using access tokens.

```http
GET /profiles
Authorization: Bearer {access_token}
```text`n## Rate Limiting

The Customer API implements rate limiting based on your subscription tier:

| Tier | Rate Limit |
|------|------------|
| Starter | 100 requests/minute |
| Professional | 500 requests/minute |
| Enterprise | 2000 requests/minute |
| Custom | Customizable |

## Best Practices

- Implement proper error handling for all API responses
- Cache frequently accessed customer data to reduce API calls
- Use webhook notifications for real-time updates to customer profiles
- Implement proper validation before submitting customer data
- Follow the recommended customer journey flow for optimal user experience

For detailed information on specific endpoints, refer to the relevant sections in the navigation menu.