Perform checks via the API (no remote invite) | API

A typical integration will involve the following sequence:

1. Create an Entity

POST /api/v2/ci/entities

Firstly you will need to create an 'entity' - this is a representation of the person you are interacting with.

See the swagger definition for the full list of possible parameters.  As a minimum (and typical) implementation, your request object should contain the following:

{

  "emailAddress": "user@example.com",

  "firstName": "John",

  "surname": "Smith",

}

The response that you receive from this endpoint will contain the entityId ("id"), which is a unique identifier which relates to the person you are interacting with.  We recommend that you store this values within your system as it will be needed to retrieve results later.

2. Request datacheck to be run against the Entity

You can now request datachecks to be run against the Entity that you have created.

There are a range of datachecks available in the system, and each require specific parameters to be provided.  See the datachecks page for details on each type of check.

These calls are synchronous, and a response will be provided within a few seconds (usually much quicker).

3. Retrieve the results, interpret and store

The response JSON you receive will contain a breakdown of the results, along with the outcome and any relevant remarks.

Please refer to the relevant schemas on our swagger page for an explanation of each parameter.