Workflows

Workflows are how most checks are initiated.

We have big plans for workflows in the future including them being customizable and event driven. But for now we only have basic workflows available that run single checks.

Available workflows

Workflow name	Checks initiated
kyc	KYC
fin-vul	Financial vulnerability
aml	AML
bav	BAV

Execute workflow

Executes a workflow on the desired case.

Endpoint	api/workflows/execute
Method	POST
Content type	application/json

Fields

Property	Required	Max Length	Notes
caseId	✅	integer (int64)	Unique CaseId to run checks for
workflowName	✅		Either 'kyc', 'fin-vul', 'aml' or 'bav' depending on which service you want to run
workflowOptions			Object of key-value string pairs, workflow options listed below
externalReference			Idempotency key as outlined here

WorkflowOptions

Property	Value	Notes
enableOngoingMonitoring	true or false	Currently only available on AML. Sets whether the person should be checked recurringly.
bankAccountId	long	Currently only available for BAV. ID of the bank account to verify. Get the ID via Bank Account Management.

Request

A request requires a case ID and a workflow name. Options depend on the workflow — for example bankAccountId for BAV:

{
    "caseId":"123",
    "workFlowName":"bav", 
    "workflowOptions": {
        "bankAccountId": "456"
    }
}

KYC example:

{
    "caseId":"123",
    "workFlowName":"kyc", 
    "workflowOptions": { // optional
        "enableOngoingMonitoring": "false" // optional — AML only
    },
    "externalReference": "abc123" // optional
}