API Documentation
Addresses
- Addresses
- Management
Users
- Users overview
- Registration
- Management
- Credentials
- Password
Roles
- Roles overview
- Role Management
- User Role Management
Personas
- Personas overview
- Personal Identity
- User-Persona
Customers
- Customers overview
- Management
- Team Management
- Settings
Countries
- Countries overview
- Management
- Lookup
Currencies
- Currencies overview
- Management
- Exchange Rates
FX
- FX overview
- Exchange Rates
Ledger
- Ledgers overview
- Management
- Operations
- Reports
Tariffs
- Tariffs overview
- Management
- Fee Ranges
- Calculations
Tasks
- Tasks overview
- Management
- Actions
- Assignees
Transactions
- Transactions overview
- Management
- Actions
- Recipients
Uploads
- Uploads overview
- Files
- Customer Documents
Invoices
- Invoices overview
- Management
- Processing
- Payers
- Customer
Accounts
- Accounts overview
- Management
- Customer
- Balance
Chat
- Chat overview
- Conversations
- Messages
Utilities
- Utilities overview
- Record Management
Profile
- Profile overview
- Management
- Avatar
- Security
KYB
RBAC
- RBAC overview
- Permissions
- Management
- System
Flow
Navigate KYB flow
Start or continue a KYB verification flow
POST
/
v1
/
kyb
/
navigate
Copy
{
"flow": {
"actor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"flow_name": "<string>",
"current_step": "<string>",
"previous_step": "<string>",
"status": "NOT_STARTED",
"sections": [
{
"name": "<string>",
"title": "<string>",
"icon": "<string>",
"status": "NOT_STARTED",
"show": true
}
]
},
"question": {
"name": "<string>",
"section": {
"name": "<string>",
"title": "<string>",
"icon": "<string>",
"status": "NOT_STARTED",
"show": true
},
"q": "<string>",
"description": "<string>",
"message": {
"text": "<string>",
"severity": "info"
},
"schema": {},
"uiSchema": {},
"formData": {}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201
application/json
Flow navigation successful
The response is of type object
.
Copy
{
"flow": {
"actor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"flow_name": "<string>",
"current_step": "<string>",
"previous_step": "<string>",
"status": "NOT_STARTED",
"sections": [
{
"name": "<string>",
"title": "<string>",
"icon": "<string>",
"status": "NOT_STARTED",
"show": true
}
]
},
"question": {
"name": "<string>",
"section": {
"name": "<string>",
"title": "<string>",
"icon": "<string>",
"status": "NOT_STARTED",
"show": true
},
"q": "<string>",
"description": "<string>",
"message": {
"text": "<string>",
"severity": "info"
},
"schema": {},
"uiSchema": {},
"formData": {}
}
}
Assistant
Responses are generated using AI and may contain mistakes.