Customer Data API

CSVFile

CSV file upload

Upload

Retail endpoint for adding new screening check information

Add screening check information

Retail endpoint for adding new SAR information

Add SAR information

Retail endpoint for adding new customer risk assessment information

Add risk assessment information

Retail endpoint for adding new person information

Add person information

Retail endpoint for adding new Onboarding Flow information

Add onboarding flow information

Retail endpoint for adding new IDV information

Add IDV information

Retail endpoint for adding new account status information

Add account status information

Retail endpoint for adding new access information

Add access information

Retail

Business endpoint for adding new screening check information

Business endpoint for adding new SAR (Suspicious Activity Report) information

Business endpoint for adding new customer risk assessment information

Add customer risk assessment information

Business endpoint for adding new person information

Business endpoint for adding new Onboarding Flow information

Business endpoint for adding new IDV (Identity Verification) information

Business endpoint for adding new company information

Add company information

Business endpoint for adding new account status information

Business endpoint for adding new access information

Business

Endpoint for organization status check purposes

Organization status check

Helper

Address

BusinessEntityParent

Unique external identifier of the parent entity, ID stored in your database / back-office

BusinessEntityParentType

Custom data that is relevant. This can be any JSON object. Please include any details and data points that our schema does not capture.

CustomData

RetailEntityParent

V1BusinessAccessInfoRequestItem

Original timestamp relating to this access information creation/change

V1BusinessAccessInfoRequestItemData

Device identifier. eg. SSAID / Android ID / Device Fingerprint

V1BusinessAccessInfoResponse

You probably did something wrong if you set this to false

V1BusinessAccountStatusInfoRequestItem

Original timestamp relating to this account status information creation/change

V1BusinessAccountStatusInfoRequestItemData

Latest account status for the related entity. One of the following: APPROVED, BLOCKED, CLOSED, PENDING, REJECTED

V1BusinessAccountStatusInfoResponse

V1BusinessCompanyInfoRequestItem

Unique external identifier of the company entity, ID stored in your database / back-office

Original timestamp relating to when this company's information was received

If the company is a test company, this should be set to true

V1BusinessCompanyInfoRequestItemData

Main contact telephone number for the company

Business entity type. eg. Sole Trader, Limited Company

State where the company was incorporated (US only)

Original timestamp of when the person completed their first transaction

If the company is registered as inactive, this should be set to true

V1BusinessCompanyInfoRequestItemDataAddressesItem

Type of address. eg. Registered, Trading, Legal

V1BusinessCompanyInfoRequestItemDataIndustryClassification

Description of the industry classification code

V1BusinessCompanyInfoRequestItemDataRegistrationNumber

Type of registration number, e.g. Companies House number (UK), EIN number (US) etc.

V1BusinessCompanyInfoResponse

V1BusinessIdvInfoRequestItem

Original timestamp relating to this IDV information creation/change

V1BusinessIdvInfoRequestItemData

Result of IDV screening returned from provider

The number of the document used in the screening

The expiration date of the document used in the screening

Whether a live selfie was used in the IDV screening

V1BusinessIdvInfoRequestItemDataDocumentExtractedDataItem

Value of the data extracted from the document

V1BusinessIdvInfoRequestItemDataExternallyVerifiedDataItem

Name of the provider that externally verified the data

V1BusinessIdvInfoResponse

V1BusinessOnboardingFlowRequestItem

Original timestamp relating to this onboarding flow information creation/change

V1BusinessOnboardingFlowRequestItemData

Latest onboarding flow that this entity has gone through, e.g. manual KYC, automated onboarding, Simplified Due Diligence, Enhanced Due Diligence

Outcome for the latest onboarding flow that this entity has gone through, e.g. automated approval, manual approval, automated rejection, manual rejection, EDD required

V1BusinessOnboardingFlowRequestItemDataOutcomeReason

V1BusinessOnboardingFlowResponse

V1BusinessPersonInfoRequestItem

Unique external identifier of the person entity, ID stored in your database / back-office

Original timestamp relating to this person entity creation/change

If the person is a beneficial owner of the parent entity, this should be set to true

If the person is a director of the parent entity, this should be set to true

If the person is an account owner of the parent entity, this should be set to true

If the person is a shareholder of the parent entity, this should be set to true

If the person is a has significant control of the parent entity, this should be set to true

If the person is a test user, this should be set to true

If the person is a shareholder of the parent entity, this should be set to their ownership percentage, as a value between 0 and 1

V1BusinessPersonInfoRequestItemData

V1BusinessPersonInfoRequestItemDataNationalIdentificationNumber

V1BusinessPersonInfoRequestItemParent

V1BusinessPersonInfoResponse

V1BusinessRiskAssessmentRequestItem

Original timestamp relating to this risk assessment information creation/change

V1BusinessRiskAssessmentRequestItemData

Type of risk assessment eg. pre-onboarding risk rating, risk band, risk engine score

The outcome of the assessment. One of: LOW, MEDIUM, HIGH, CRITICAL

V1BusinessRiskAssessmentResponse

V1BusinessSarInfoRequestItem

Original timestamp relating to this SAR creation/change

V1BusinessSarInfoRequestItemData

V1BusinessSarInfoRequestItemDataStatus

V1BusinessSarInfoResponse

V1BusinessScreeningCheckRequestItem

Original timestamp relating to this screening check information creation/change

V1BusinessScreeningCheckRequestItemData

The ID linking the initial/reviewed result

The lists that were screened against. E.g. OFAC, ComplyAdvantage Watchlists...

The provider that performed the screening check

V1BusinessScreeningCheckResponse

StatusCheckResponse

StatusCheckResponseOverall

StatusCheckResponseOverallFailures

The number of errors seen through the API requests in the last week

The number of errors seen through the API requests in the last month

StatusCheckResponseOverallSuccesses

The number of overall successful data point entries sent through the API in the last week

The number of overall successful data point entries sent through the API in the last month

StatusCheckResponsePerEndpointValue

StatusCheckResponsePerEndpointValueFailures

The number of errors seen through the API requests for a particular endpoint in the last week

The number of errors seen through the API requests for a particular endpoint in the last month

The actual errors seen through the API requests for a particular endpoint in the last week

StatusCheckResponsePerEndpointValueSuccesses

The number of successful data point entries for a particular endpoint sent through the API in the last week

The number of successful data point entries for a particular endpoint sent through the API in the last month