Introduction

API Reference Overview
Staging & Production

USERS & AUTHENTICATION

Authentication
- Creates an access tokenpost
User Management
- List all usersget

WEBHOOKS

Webhooks

ENTITY MANAGEMENT

Cases
Companies & People

ENRICHED Entity Data

Company Registry
Company Credit Report
Banking
PEPs & Sanctions
- Request PEPs & Sanctions searchpost
- List all PEPs & Sanctions searchesget
Adverse Media
- Request Adverse Media searchpost
- List all Adverse Media searchesget
Documents
Identity Verification
Online Data

Insights

Affordability Insights
Income & Employer Verification
Data Sources
- List data sources for an entityget
Validation Checklists
Excel Report
- Retrieve excel reportget

Introduction

API Reference Overview
Staging & Production

USERS & AUTHENTICATION

Authentication
- Creates an access tokenpost
User Management
- List all usersget

WEBHOOKS

Webhooks

ENTITY MANAGEMENT

Cases
Companies & People

ENRICHED Entity Data

Company Registry
Company Credit Report
Banking
PEPs & Sanctions
- Request PEPs & Sanctions searchpost
- List all PEPs & Sanctions searchesget
Adverse Media
- Request Adverse Media searchpost
- List all Adverse Media searchesget
Documents
Identity Verification
Online Data

Insights

Affordability Insights
Income & Employer Verification
Data Sources
- List data sources for an entityget
Validation Checklists
Excel Report
- Retrieve excel reportget

List all validation checklist requests

get https://api.sikoia.com/v2/{entity_type}/{entity_id}/validation-checks

List all validation checklist requests.

Returns a list of all validation checklists requested for an entity.

The list includes the validation_instance_id for each request, which can be used to retrieve the validation check rules result using the GET /v2/validation-checks/{validation_instance_id} endpoint.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

entity_type

string

required

Entity Type

entity_id

string

required

Entity ID

Responses

Response body

object

entity_id

string | null

The company_id, person_id or case_id of the entity.

entity_type

string | null

The type of entity.

company person case

validation_check_requests

array of objects | null

A list of validation check instance requests for the entity.

validation_check_requests

object

validation_instance_id

string | null

The unique identifier for a specific instance of the check type.

validation_type_id

string | null

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

status

string | null

The current status of the check, which may be one of the following: Complete, Failed, or Pending.

datetime_requested

string | null

The date and time when the request was initiated.

datetime_completed

string | null

The date and time when the request was completed.

message

string | null

An optional field providing additional context about the status of the check.

Response body

object

type

string

The error type

status

integer

HTTP status code of the error

title

string

A short description of the error

detail

string

More details about what went wrong

correlation_id

string

Correlation ID, please include this in any support tickets raised

Response body

object

type

string

The error type

status

integer

HTTP status code of the error

title

string

A short description of the error

detail

string

More details about what went wrong

correlation_id

string

Correlation ID, please include this in any support tickets raised

Response body

object

type

string

The error type

status

integer

HTTP status code of the error

title

string

A short description of the error

detail

string

More details about what went wrong

correlation_id

string

Correlation ID, please include this in any support tickets raised

Response body

object

type

string

The error type

status

integer

HTTP status code of the error

title

string

A short description of the error

detail

string

More details about what went wrong

correlation_id

string

Correlation ID, please include this in any support tickets raised

Updated 7 months ago

Run a validation checklist

Retrieve validation checklist result

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.sikoia.com/v2/Companies/entity_id/validation-checks \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 7 months ago

Run a validation checklist

Retrieve validation checklist result

Introduction
API Reference Overview
Staging & Production

USERS & AUTHENTICATION
Authentication
Creates an access tokenpost
User Management
List all usersget

WEBHOOKS
Webhooks
Change a shared secretpatch
Delete a shared secretdelete
Create a shared secretpost
Get a shared secretget
List all webhook requestsget
List all event typesget
Delete a webhookdelete
Update a webhookpatch
Retrieve a webhookget
List all webhooksget
Create a new webhookpost

ENTITY MANAGEMENT
Cases
Delete a casedelete
Update a casepatch
Retrieve a caseget
Create a casepost
List all casesget
Companies & People
Delete entities in a casepost
Update entities in a casepatch
Add entities to a casepost

ENRICHED Entity Data
Company Registry
Search for a companypost
Resolve registry picklistpost
Retrieve registry dataget
List all registry data requestsget
Request registry datapost
Company Credit Report
Resolve credit report picklistpost
Retrieve credit reportget
List all credit report requestsget
Request credit reportpost
Banking
Refresh an accountpost
Retrieve account transactionsget
Retrieve account balancesget
List all accountsget
Retrieve account detailsget
List all Open Banking connectionsget
Delete an Open Banking connectiondelete
Retrieve Open Banking connection statusget
Create Open Banking connectionpost
PEPs & Sanctions
List all PEPs & Sanctions searchesget
Request PEPs & Sanctions searchpost
Adverse Media
List all Adverse Media searchesget
Request Adverse Media searchpost
Documents
Retrieve integrity checklist resultget
List all integrity checklist requestsget
List all documents for an entityget
Delete a documentdelete
Retrieve a documentget
Upload a document to an entitypost
Identity Verification
Retrieve IDV resultget
List all IDV requestsget
Request IDVpost
Online Data
Retrieve online dataget
List all online data requestsget
Request online datapost

Insights
Affordability Insights
Retrieve a full breakdown of all transaction dataget
Retrieve a monthly summary of transaction dataget
Retrieve affordability insightget
List all affordability insight requestsget
Request affordability insightpost
Income & Employer Verification
Retrieve detailed payslip, bank statement and/or open banking connection dataget
Retrieve income & employer verificationget
List all income & employer verificationsget
Request income & employer verificationpost
Data Sources
List data sources for an entityget
Validation Checklists
Retrieve validation checklist resultget
List all validation checklist requestsget
Run a validation checklistpost
List all validation checklistsget
Excel Report
Retrieve excel reportget

Introduction
API Reference Overview
Staging & Production

USERS & AUTHENTICATION
Authentication
Creates an access tokenpost
User Management
List all usersget

WEBHOOKS
Webhooks
Change a shared secretpatch
Delete a shared secretdelete
Create a shared secretpost
Get a shared secretget
List all webhook requestsget
List all event typesget
Delete a webhookdelete
Update a webhookpatch
Retrieve a webhookget
List all webhooksget
Create a new webhookpost

ENTITY MANAGEMENT
Cases
Delete a casedelete
Update a casepatch
Retrieve a caseget
Create a casepost
List all casesget
Companies & People
Delete entities in a casepost
Update entities in a casepatch
Add entities to a casepost

ENRICHED Entity Data
Company Registry
Search for a companypost
Resolve registry picklistpost
Retrieve registry dataget
List all registry data requestsget
Request registry datapost
Company Credit Report
Resolve credit report picklistpost
Retrieve credit reportget
List all credit report requestsget
Request credit reportpost
Banking
Refresh an accountpost
Retrieve account transactionsget
Retrieve account balancesget
List all accountsget
Retrieve account detailsget
List all Open Banking connectionsget
Delete an Open Banking connectiondelete
Retrieve Open Banking connection statusget
Create Open Banking connectionpost
PEPs & Sanctions
List all PEPs & Sanctions searchesget
Request PEPs & Sanctions searchpost
Adverse Media
List all Adverse Media searchesget
Request Adverse Media searchpost
Documents
Retrieve integrity checklist resultget
List all integrity checklist requestsget
List all documents for an entityget
Delete a documentdelete
Retrieve a documentget
Upload a document to an entitypost
Identity Verification
Retrieve IDV resultget
List all IDV requestsget
Request IDVpost
Online Data
Retrieve online dataget
List all online data requestsget
Request online datapost

Insights
Affordability Insights
Retrieve a full breakdown of all transaction dataget
Retrieve a monthly summary of transaction dataget
Retrieve affordability insightget
List all affordability insight requestsget
Request affordability insightpost
Income & Employer Verification
Retrieve detailed payslip, bank statement and/or open banking connection dataget
Retrieve income & employer verificationget
List all income & employer verificationsget
Request income & employer verificationpost
Data Sources
List data sources for an entityget
Validation Checklists
Retrieve validation checklist resultget
List all validation checklist requestsget
Run a validation checklistpost
List all validation checklistsget
Excel Report
Retrieve excel reportget

200Validation Check Requests

401Unauthorized

404Entity not found

429Too Many Requests

500Internal Server Error