Introduction

APLYiD's Workflow product helps businesses onboard and verify their customers. The Workflow API lets you drive that process from your own systems: create verification Cases on demand and receive a webhook when each one completes, so you can keep your records in sync.

This documentation is intended for software developers integrating APLYiD Workflow into their own applications.

Key concepts

Term	Meaning
Case	A unit of work representing a customer you want to verify. You create Cases through the API.
Client	The person (or entity) being verified. Each Case is created with a Client.
Guided flow	The verification journey you complete (document capture, biometrics, and checks) for a Client. A Case generates a guided flow automatically.
Webhook	An HTTP request we send to your server to notify you of an event - currently when a Case is completed.
Access Token	The secret credential you send with every API request, in the X-Workflow-Access-Key header.

The integration lifecycle

1. Set up an integration in the APLYiD portal (see Authentication & Setup). You enter the Webhook URL we should notify, and we issue you an Access Token.
2. Create a Case with POST /integrations/core/cases, passing the Client's details and your own reference (external_id).
3. You complete the generated guided flow in the portal.
4. We send a case.completed webhook to your Webhook URL once the Case is finished, including the outcome for the Client (see Receiving Webhooks).

Base URL

All API requests are made to:

https://api.workflow.aplyid.com

Authentication

Every request must include your Access Token in the X-Workflow-Access-Key header:

X-Workflow-Access-Key: <your access token>

See Authentication & Setup for how to obtain an Access Token and the difference between Test and Live integrations.

NOTE

We're here to assist you if you have any questions regarding integration with APLYiD; please feel free to reach out to your Account Manager.