Sign in

v1

latestOpenAPI 3.0.02026-07-2667172347.6 KB
Workflows

Create workflow

Use this endpoint to create a workflow.

post/v1/workflows

Headers

Authorizationstring required

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

Cache-Controlstring

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.

Request body

workflowNamestring required

The type of workflow. <br /><br /><img src="https://files.readme.io/5c5228a-Inline_Configurable.svg" align="left"/> Configurable: Configure your workflow identifiers with your Fourthline delivery manager. <br /><br />Options include:<br />• BAV: A Bank Account Verification flow only. <br />• IDV: An Identity Verification flow only. <br />• IDVandBAV: An Identity Verification followed by a Bank Account Verification flow. <br />• IDVandQES: An Identity Verification followed by a Qualified Electronic Signature flow. <br />• IDVandQESandBAV: An Identity Verification followed by a Qualified Electronic Signature and then a Bank Account Verification flow. <br />• UKI: An Identity Verification flow for UK clients. <br />•QES: A Qualified Electronic Signature flow only.

providerClientIdstring required

Your unique identifier for the client. <br /><br />Format: No set format <br /><br /> <img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/>Tip: This is the same value as your ClientNumberProvider.

branchstring

Your configuration for this product. <br />Set the string provided by your Fourthline delivery manager.<br />If not set, we use your default configuration. <br /><br /><img src="https://files.readme.io/8eb9022-Inline_Tip.svg" align="left"/> Tip: Use this parameter for case configuration in older setups.

Response

Workflow created

workflowIdstring

Our unique identifier for the workflow. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

clientIdstring

Our unique identifier for the client, returned in your first Create workflow request for this client. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0