API reference

Workflows

Create, edit, simulate, publish and A/B test workflows.

GET/v3/workflows/[{uuid, workflow_label, features[]}]

POST/v3/workflows/Create and publish from a list of features

bash

curl -X POST https://{{HOST}}/v3/workflows/ -H "x-api-key: sk_..." -H "Content-Type: application/json" \
  -d '{"workflow_label":"Standard KYC","features":[{"feature":"OCR"},{"feature":"LIVENESS"},{"feature":"FACE_MATCH"},{"feature":"AML"}]}'

Features include OCR, LIVENESS, FACE_MATCH, AML, PROOF_OF_ADDRESS, DATABASE_VALIDATION, IP_ANALYSIS, EMAIL_VERIFICATION, PHONE_VERIFICATION. See GET /v3/workflow-catalog/ for the full list.

GET/v3/workflows/{id}/graph/Draft, published version, history, validation and A/B test

PUT/v3/workflows/{id}/graph/Save a draft: {graph: {nodes: [{id, type, config, x, y}], edges: [{from, to, branch}]}}

POST/v3/workflows/{id}/publish/{note}. Returns 422 with the problems if the graph is invalid

POST/v3/workflows/{id}/simulate/{sample: {"document.country": "NGA", "aml.sanctions_hit": true}}

PUT/v3/workflows/{id}/ab-test/{enabled, variants: [{key, workflow_id, weight}]}

GET/v3/workflow-catalog/Node types, condition fields and operators