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

Upload a document to an entity

post https://api.sikoia.com/v2/documents

Uploads a document to a `case`, `person`, or `company`.

The document must be base64 encoded and included as a string in the file field.

Ensure that the file_name field includes the file extension.

Recipes

📄

Manage Documents

Open Recipe

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Body Params

entity_id

string

required

length ≥ 1

The company_id, person_id or case_id of the entity

entity_type

string

required

length ≥ 1

The type of entity

file

string

required

length ≥ 1

File data base64 encoded

document_type

string | null

The type of document

display_name

string

required

length ≥ 1

Display name

file_name

string

required

length ≥ 1

File name including file extension

Responses

Response body

object

document_id

string

Sikoia ID for the document

document_uri

string

The uri for the document

entity_type

string

The type of entity

company person case

entity_id

string

The company_id, person_id or case_id of the entity

file_type

string

The type of file

display_name

string

The display name of the document

document_type

string | null

The type of document

BankStatement Payslip Identity Contract FactFind Other CompanyRegistration StakeholdersDisclosure Tax UtilityBill CreditReport SavingsStatement SA302 TaxOverview P45 P60 EmploymentLetter EmploymentContract ChildBenefitLetter BenefitAwardLetter StudentLoanLetter PensionStatement FinancialAccounts

sikoia_document_type

string | null

Document type, as classified by Sikoia's AI system

file_name

string

The name of the file

status

string

The status of the request

datetime_created

string

The time the document was created

date_created

date-time

deprecated

Date Created

datetime_last_modified

string

The time the document was last modified

date_uploaded

date-time

deprecated

Date Uploaded

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

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 11 months ago

List all Adverse Media searches

Retrieve a document

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.sikoia.com/v2/documents \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "entity_type": "company"
8
}
9
'

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

application/json

Updated 11 months ago

List all Adverse Media searches

Retrieve a document

🦉

Recipe Title

Recipe Description

{"success":true}

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

201Document

400Entity deleted/not found or invalid request

401Unauthorized

403Document upload not enabled

429Too Many Requests

500Internal Server Error