Complete a workflow session
URL
POST https://api.complycube.com/v1/workflowSessions/:id/complete
Notifies ComplyCube that a workflow session has completed, triggering all configured verification checks.
Headers
Name
Type
Description
Authorization*
string
The API live or test key.
Path parameters
Name
Type
Description
id*
string
The ID of the workflow session.
Example request
curl -X POST https://api.complycube.com/v1/workflowSessions/{:wfSessionId}/complete \
-H 'Authorization: <YOUR_API_KEY>' \
-H 'Content-Type: application/json'const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const wfSession = await complycube.workflowSession.complete("WORKFLOW_SESSION_ID");from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
workflow_session = cc_api.workflowsessions.complete('WORKFLOW_SESSION_ID')use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$workflowSession = $ccapi->workflowSessions()->complete('WORKFLOW_SESSION_ID');using ComplyCube.Net;
using ComplyCube.Net.Resources.WorkflowSessions;
var wfSessionApi = new WorkflowSessionApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var workflowSession = await wfSessionApi.CompleteAsync("WORKFLOW_SESSION_ID");Example response
{
"status": "processing"
}{
"type": "resource_not_found",
"message": "Invalid workflow session id '5eb2b61e02df0a0008f1cf2b'"
}