Individual onboarding API workflow

​

Individual onboarding API workflow

Use this map to connect individual KYC policy to the current generated API reference. Follow the current resource at every step rather than implementing policy-facing labels as an API state machine.

​

Workflow map

​

1. Create the individual customer

Create the customer with POST /v3/customers. Store the returned customer id and read the current resource with GET /v3/customers/{customerId}.

​

2. Discover and request an eligible capability

Read GET /v3/customers/{customerId}/capabilities/supported. Select a variant only when its current availability and eligibility allow the request, then use POST /v3/customers/{customerId}/capabilities/{capabilityId}.

​

3. Read the current capability and applications

Read GET /v3/customers/{customerId}/capabilities/{capabilityId} and GET /v3/customers/{customerId}/capabilities/{capabilityId}/applications. Follow current open task ids rather than assuming readiness from an earlier response.

​

4. Fetch current task detail

List customer tasks with GET /v3/customers/{customerId}/tasks. Fetch the authorized action surface with GET /v3/customers/{customerId}/tasks/{taskId}. Task detail can expose first-party hosted session URLs and the current actionable requirements. Use its current revision and status.

​

5. Complete hosted sessions or submit task answers

When task detail provides a hosted session, return only the required session data to your client and keep the API key in your backend. When the task requires answers, create one complete immutable attempt with POST /v3/customers/{customerId}/tasks/{taskId}/submissions. Read one current submission and its public outcome with GET /v3/customers/{customerId}/tasks/{taskId}/submissions/{submissionId}.

​

6. Upload documents only when requested

Upload documents only when the current task asks for them. Use POST /v3/customers/{customerId}/documents, then place the returned document id in the applicable document answer.

​

7. Refetch current resources

Refetch the current customer, capability, applications, and task after each event or action. Use their latest states, reasons, requirements, and open task ids to select the next step.

​

Generated operation map

​

Policy and implementation guidance

Simplified, Standard, and Enhanced KYC are policy tiers. They do not replace current capability, application, task, submission, requirement, or hosted-session states. For implementation details, follow the individual onboarding guide, Capabilities and tasks, and the Integration Documents guide.