cURL
curl --request POST \ --url https://api.example.com/v1/kyb/navigate \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "flow_name": "business_verification", "actor_id": "550e8400-e29b-41d4-a716-446655440000", "question_name": "company_details" } '
{ "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": {} } }
Start or continue a KYB verification flow
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
"business_verification"
"550e8400-e29b-41d4-a716-446655440000"
"company_details"
Flow navigation successful
Show child attributes