GRgriffin
Workflows

Get workflow

Changed on

Fetch the workflow.

get/v0/workflows/{workflow-id}

Request

Path parameters

workflow-idstring required

Response

OK

workflow-urlstring required

A link to the workflow.

display-namestring required

A human readable label for an entity

descriptionstring required
legal-person-type'individual' | 'corporation' required

Specifies if the legal person is an individual or a corporation.

created-atstring date-time required

ISO 8601 formatted date-time.

disabled?boolean required

When a workflow is disabled, no new verifications using that workflow can be created.

required-claim-typesobject

A mapping of workflow-appropriate legal person types to claims that are required for each type.

workflow-rulesstring[]

A list of special behaviours a workflow can possess.

Example response

{
  "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA"
}

Changes