API Reference

Run a completeness and income insights check

post
https://api.sikoia.com/v2/completeness-income-checks

Check Completness and Income.

This endpoint executes a two-stage workflow: it first validates the entity against all completeness rules,

then automatically initiates income verification upon success.

A successful response returns the combined data from both processes.

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

Updated 2 months ago

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