Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Verifications

Perform verification of a legal person

Initiates verification of the subject legal person.

The request body must include a workflow-url to determine checks to be performed by the verification. The workflow specified determines which claims must exist for the subject legal person, as identified in the request URL, and any associated legal persons (i.e. directors and people with significant control of a corporation).

These claims can be found in the required-claim-types field on a Workflow.

Once a verification is created, the system will perform checks on the claim details. The status of check processing is indicated by the verification-status in the response body. Initially it will be pending, and will transition through in-progress to a final status of checks-complete.

A verification-status of failed indicates something went wrong during check processing. You can initiate another verification to retry the check processing.

post/v0/legal-persons/{legal-person-id}/verifications

Path parameters

legal-person-idstring required

Request body

workflow-urlstring required

A link to the workflow.

Example request

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

Response

The created verification

verification-urlstring required

A link to the verification.

verification-resources-urlstring

A link to the resources of a verification.

updated-atstring date-time

ISO 8601 formatted date-time.

workflow-urlstring

A link to the workflow.

created-atstring date-time required

ISO 8601 formatted date-time.

verification-checks-urlstring required
risk-rating'high-risk' | 'prohibited-risk' | 'medium-risk' | 'low-risk'
verification-status'in-progress' | 'pending' | 'checks-declined' | 'checks-complete' | 'failed' required
verification-risk-assessments-urlstring

Example response

{
  "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
  "verification-resources-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA/resources",
  "workflow-url": "/v0/workflows/wf.ICAgICB3b3JrZmxvdy1pZA"
}