Skip to main content

Workflows

A workflow is used to complete a verification on a legal person. It specifies the data (or claims) required about a legal person and the type of assessment that is done on the legal person.

Your organisation is assigned one or more workflows — this depends on the type of customer, products and the rights you have over accounts (find out more here).

About workflows​

  • Each organisation has a set of predefined workflows with unique IDs
  • These workflow IDs remain constant and can be cached after initial retrieval
  • Different workflows exist for different operating models (Verify, reliance and outsourced), customer types (limited companies or individuals), or in some cases sub types can be specific to a sector specific or jurisdiction international customers
  • You need to select the appropriate workflow ID when running a verification as part of onboarding or updating customer information

Retrieving your workflows​

You only need to retrieve your workflows once (or when you have new workflows added to your organisation), once retrieved you can cache the IDs:

curl "https://api.griffin.com/v0/organizations/${ORGANIZATION_ID}/workflows" -H "Authorization: GriffinAPIKey $GRIFFIN_API_KEY"

Example response:

json
{
  "workflows": [
    {
      "workflow-url": "/v0/workflows/wf.Ul-1r4gRWfOFxHJsHWghcA",
      "display-name": "Limited Company - Account Owners",
      "legal-person-type": "corporation"
    },
    {
      "workflow-url": "/v0/workflows/wf.Ul-1r4gRWfOFxHJsHWghcA",
      "display-name": "Sole Trader - Account Owners",
      "legal-person-type": "corporation"
    },
    {
      "workflow-url": "/v0/workflows/wf.Ul-1r4gRWfOFxHJsHWghcA",
      "display-name": "Individual - Account Owners",
      "legal-person-type": "corporation"
    }
  ]
}
tip

In your implementation, store these workflow IDs and match them to the appropriate customer type. For example, use the "Limited Company - Account Owners" workflow when onboarding limited companies. We do not recommend storing workflows by name as these are subject to change.

Once you've retrieved your workflows you can use them in verification requests as part of onboarding or updating customer information. Check out our guides for onboarding customers.