Run a validation checklist

Runs a validation checklist against a specific case, person, company, or data source.

This endpoint automatically checks whether an entity passes all the rules in a specific validation checklist.

To proceed, ensure that validation_type_id, entity_id and entity_type are valid.

To run the checklist against a specific data source use the check_params filter and provide the source_id and source_id_type of the data source you want to use.

A successful response will include a validation_instance_id that can be used to check the status of the request.

Body Params
string | null

The unique identifier for the check type, such as the ID for the 'Last 3 months of payslips' check.

string | null

The company_id, person_id or case_id of the entity.

string | null
enum

The type of entity.

Allowed:
checklist_params
array of objects | null

A list of parameters for the validation check to run against, such as specifying an individual document instead of the entire entity.

checklist_params
Responses

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json