Overview
The KYB API provides functionality for managing:
- Business verification flows
- Dynamic questionnaires
- Answer management
- Status tracking
- Validation rules
Core Concepts
Flow Status
| Status | Description | Next States |
|---|
NOT_STARTED | Flow initialized | PENDING |
PENDING | In progress | COMPLETE |
COMPLETE | Flow finished | - |
Section Types
| Type | Description | Required | Order |
|---|
company_information | Company details | Yes | 1 |
address_details | Address info | Yes | 2 |
director_information | Director details | No | 3 |
ownership_structure | Ownership info | No | 4 |
Question Types
| Type | Description | Format | Validation |
|---|
text | Text input | String | Length, pattern |
select | Single choice | Option | Required option |
multi | Multiple choice | Array | Min/max items |
file | File upload | Binary | Size, type |
Validation Rules
Answer Rules
- Required fields complete
- Valid format per type
- Business logic rules
- Cross-field validation
Flow Rules
- Sequential completion
- Section dependencies
- Required documents
- Status transitions
Document Rules
- PDF/JPEG formats
- Max size: 10MB
- Clear resolution
- Valid signatures
Security Requirements
- JWT authentication
- Role-based access
- Answer encryption
- Audit logging
See individual endpoint documentation for detailed request/response formats and examples.
