Start workflow

Use this endpoint to start a workflow after all required client data and documents have been uploaded.

For App Drop-in and Web SDK, the SDK calls this endpoint when capture ends. You do not call it yourself for that flow. For an API-only integration, call it after the required uploads are complete.

A second call returns 202 and changes nothing. The endpoint is idempotent.

The endpoint returns 400 when required data is missing before capture is complete, for example IdentityVerification: selfie image required.

Note Note:

  • Workflows cannot be restarted. Before calling this endpoint, ensure that all required documents and information are complete and correct. To correct missing or incorrect data after the workflow has started, create a new workflow.
  • For error responses, inspect the response body for additional details.
Path Params
uuid
required

The unique identifier of the workflow to start. Use the workflowId from the Create workflow response.

Format: uuid

Example: 3a3f90d8-019b-4001-98f8-c54848d07827

Headers
string
required
Defaults to Bearer <access_token>

The access_token returned in your most recent Create access token response.

string
Defaults to no-cache

To have the response validated by the origin server instead of reusing stored content, we strongly recommend including this parameter and setting it to no-cache.

Responses
202

Accepted. Returned when the workflow is accepted for processing. The response body is empty.

Language
LoadingLoading…
Response
Choose an example:
application/json