APLYiD Workflow API

The Workflow API lets you integrate the APLYiD Workflow product directly into your own systems. You can create verification Cases programmatically and be notified, via webhook, the moment one is completed.

How it works

1. Set up an integration in the APLYiD portal. You provide a Webhook URL and receive an Access Token.
2. Create a Case by calling the API with your Access Token. A Case represents a customer you want verified.
3. You complete the Case by following the guided flow we generate.
4. We notify you with a case.completed webhook to your Webhook URL when the Case is finished.

Where to next

• Authentication & Setup — create a Test or Live integration and authenticate your requests with the X-Workflow-Access-Key header.
• Creating Cases — the POST /integrations/core/cases endpoint.
• Receiving Webhooks — what we send to your Webhook URL when a Case completes.

At a glance

Base URL	https://api.workflow.aplyid.com
Authentication	X-Workflow-Access-Key request header
Cases endpoint	POST /integrations/core/cases
Webhook event	case.completed

NOTE

We're here to help. If you have any questions about integrating with APLYiD, please reach out to your Account Manager.