Work flows

Find the journey to send a customer to, and learn what it collects.

A work flow is a journey an institution designed: the pages a customer walks and the fields they fill. You need its identifier to open a session, and GET /workflows is where one comes from.

curl

curl https://api.example.com/api/v1/integration/workflows \
  -H "X-API-Key: pmt_live_..."

Knowing your response shape in advance

GET /workflows/{workFlowId} returns the fields the work flow collects, each with its type, its data classification, and whether your credential will receive its value. That is the shape of the collectedData you will get from a decision read — so you can build against it without first running a real person through a real journey.

JSON

{
  "workFlow": { "name": "Individual onboarding", "versionNumber": 7 },
  "fields": [
    { "fieldKey": "full_name", "sensitivity": "PERSONAL", "isReadable": true },
    { "fieldKey": "nic_number", "sensitivity": "SENSITIVE", "isReadable": false }
  ]
}