API docs by Redocly

Data-Load-API (4.0)

Download OpenAPI specification:

URL: jadethirdeye.com

The Data Load API allows you to automate a number of AML processes via REST API:

  • Loading or amending Customer, Account and Transaction (CAT) information
  • Watchlist screening tasks via a REST API
  • Real-time transaction monitoring
  • Loading Suspicious Matter Reports
  • On demand applicant and customer screening

This API is hosted in Amazon Web Services (AWS), so can be integrated into any API based system relatively easily. It supports bulk loading of customer, account, and transaction data. After data is loaded, predefined rule processing jobs and screening jobs are executed. These jobs will generate any relevant alerts or reports in Jade Thirdeye, based on your risk-based configuration decisions.

Authentication

This API uses a dual authentication mechanism:

  1. API Key Authentication: All requests require a valid API key in the x-api-key header provided by Jade ThirdEye.
  2. Bearer Token Authentication: Requests must include a valid JWT token in the Authorization header with the format Bearer {token}.

This token, along with the required Client-Id and Reporting-Entity headers, is used to authorize access to specific API resources. For OAuth 2.0 flows, the API supports the authorization code flow that enables secure user authentication through an external identity provider.

Customers

Endpoints for creating or updating customer records in Jade ThirdEye.

Create or Update Customers

Create, update, and screen customer records in Jade ThirdEye. The customer API will update an existing customer if the customerNumber exists, otherwise it will create a new record. Up to 1000 new or updated customers can be batched in a call.

Authorizations:
(api_keyauthorizer)
header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Request Body schema: application/json
required
required
Array of EntityCustomer (object) or PersonCustomer (object) [ 1 .. 1000 ] items

Customers can be loaded in batches of up to 1000

Responses

Request samples

Content type
application/json
{
  • "customers": [
    ]
}

Accounts

Endpoints for creating or updating account records in Jade ThirdEye.

Create or Update Accounts

Create and update account records in Jade ThirdEye. The account API will update an existing account if the accountNumber exists, otherwise it will create a new record. Up to 1000 new or updated accounts can be batched in a call.

Authorizations:
(api_keyauthorizer)
header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Request Body schema: application/json
required
Array of objects (Account) [ 1 .. 1000 ] items

Accounts can be loaded in batches of up to 1000

Responses

Request samples

Content type
application/json
{
  • "accounts": [
    ]
}

Transactions

Endpoints for creating transaction records in Jade ThirdEye.

Create Transactions

Create transaction records in JTE.

Authorizations:
(api_keyauthorizer)
header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Request Body schema: application/json
required
Array of objects (Transaction) [ 1 .. 1000 ] items

Transactions can be loaded in batches of up to 1000

Responses

Request samples

Content type
application/json
{
  • "transactions": [
    ]
}

Suspicious Matter Reports

Endpoints for loading and creating suspicious matter reports.

Load and create a Suspicious Matter Report

Load details into Jade ThirdEye for a single suspicious-matter-reports.

Authorizations:
(api_keyauthorizer)
header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Request Body schema: application/json
required
required
Array of objects (Entity) <= 50 items

IDs for customers, accounts and transaction associated with this report.

ReportType
required
stringSMR

The type of report being loaded.

required
object

The report content.

Responses

Request samples

Content type
application/json
{
  • "Entities": [
    ],
  • "ReportType": "SMR",
  • "Report": {
    }
}

Get Report Response Messages

Get report response messages for a specific request.

Authorizations:
(api_keyauthorizer)
path Parameters
requestId
required
string

The unique identifier of request

header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Responses

Response samples

Content type
application/json
{
  • "requestId": "c4a13434-3a35-46b8-9a4c-5gt43e251fc5",
  • "reportId": 102,
  • "client": "string",
  • "reportingEntity": "string",
  • "reportType": "SMR",
  • "requestReceived": "2022-03-20T14:17:45Z",
  • "reportLoaded": true,
  • "reportStatus": "InformationRequired",
  • "errors": [
    ],
  • "warnings": [
    ]
}

Entity Response information

Endpoints for fetching response messages related to entity data loading.

Get response messages for a specific request

For customers, accounts, and transactions when requests are received, the system will trigger data loading and rule processing jobs asynchronously and the response will not be available immediately. This endpoint takes the request ID as a parameter and provides detailed response messages, such as data loading, rule processing status, and any warnings/errors.

Authorizations:
(api_keyauthorizer)
path Parameters
requestId
required
string

The unique identifier of request

header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Responses

Response samples

Content type
application/json
{
  • "requestId": "c4a14618-3b35-46b8-aa4c-4799fe251fc5",
  • "client": "string",
  • "reportingEntity": "string",
  • "entityType": "Account",
  • "actionType": "PUT",
  • "requestReceived": "2022-03-20T14:17:45Z",
  • "entitiesCount": 1000,
  • "entitiesAddedCount": 800,
  • "entitiesIgnoredCount": 800,
  • "entitiesUpdatedCount": 100,
  • "entitiesNotUpdatedCount": 50,
  • "entitiesNotLoadedWithErrorsCount": 50,
  • "entitiesLoadedWithWarningsCount": 20,
  • "entitiesAdded": [
    ],
  • "entitiesUpdated": [
    ],
  • "entitiesNotUpdated": [
    ],
  • "entitiesNotLoadedWithErrors": [
    ],
  • "entitiesLoadedWithWarnings": [
    ],
  • "entitiesIgnored": [
    ]
}

Applicant

Endpoints related to managing applicants, including health checks, creating applicants, and checking screening statuses.

Applicant Health Check

This endpoint is used to check the health of the connection between the API Gateway and the Financial Crime instance. It returns a simple JSON response indicating whether the connection is healthy or not.

Authorizations:
(api_keyauthorizer)
header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Responses

Response samples

Content type
application/json
{
  • "status": "Healthy"
}

Create and screen an applicant

This endpoint is used to create and screen an applicant in the system. It accepts a JSON payload containing the applicant's details and returns a response indicating the success or failure of the operation and whether there was a match when screening.

Authorizations:
(api_keyauthorizer)
header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Request Body schema: application/json
required
object

The applicant details.

Responses

Request samples

Content type
application/json
Example
{
  • "applicant": {
    }
}

Response samples

Content type
application/json
{
  • "loadApplicantResponse": {
    },
  • "hasBeenProcessed": true,
  • "requestId": "15ca0d91-c9de-4dfa-a41a-f6963355f1d0"
}

Check the screening status of an applicant

Checks the screening status of an applicant by their unique identifier. It returns a JSON response indicating the applicant's details and screening status.

Authorizations:
(api_keyauthorizer)
path Parameters
applicantId
required
string

The unique identifier of applicant that is being checked

header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Responses

Response samples

Content type
application/json
Example
{
  • "applicantId": "1234",
  • "customerType": "P",
  • "firstName": "John",
  • "lastName": "Smith",
  • "entityName": "",
  • "screeningStatus": "Not Started",
  • "alertId": "",
  • "requestId": "16ca0d91-c9de-4dfa-a41a-f6963355f1d0"
}

Customer Screening

Endpoints for screening customers

Check the screening status of a customer

Checks the screening status of a customer by their unique identifier. It returns a JSON response indicating the customer's details and screening status.

Authorizations:
(api_keyauthorizer)
path Parameters
customerId
required
string

The unique identifier of the customer to screen

header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Responses

Response samples

Content type
application/json
Example
{
  • "customerId": "1234",
  • "customerType": "P",
  • "firstName": "John",
  • "lastName": "Smith",
  • "entityName": "",
  • "screeningStatus": "Not Started",
  • "alertId": "",
  • "requestId": "16ca0d91-c9de-4dfa-a41a-f6963355f1d0"
}

Screen a customer

This endpoint is used to screen a customer in the system. It accepts a customer ID as a query parameter and returns a response indicating the success or failure of the operation and whether there was a match when screening.

Authorizations:
(api_keyauthorizer)
path Parameters
customerId
required
string

The unique identifier of the customer to screen

header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Responses

Response samples

Content type
application/json
Example
{
  • "customerNumber": "1234",
  • "messages": [ ],
  • "matchFound": false
}

Real-time transaction monitoring

Endpoints for monitoring real-time transactions.

Monitor real-time transaction

This endpoint is used to load and monitor a pending transaction within the system. It accepts a JSON payload containing transaction details and returns a response that includes a risk assessment outcome and details of any real time alerts generated for the pending transaction.

Authorizations:
(api_keyauthorizer)
header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Request Body schema: application/json
required
accountNumber
required
string [ 1 .. 80 ] characters

The unique identifier for the account

amount
required
string

The amount of money transferred through this transaction

debit
required
string

To check if the transaction is debit or not

transactionDateTime
required
string <date-time>

The UTC date and time on which this transaction was made

transactionId
required
string [ 1 .. 50 ] characters

The unique identifier for this specific transaction

transactionType
required
string

The type of transaction configured for your reporting entity

Array of objects

Additional properties related to the pending transaction.

Responses

Request samples

Content type
application/json
{
  • "accountNumber": "123405678910-01",
  • "amount": "1200.50",
  • "debit": "false",
  • "transactionDateTime": "2021-06-30T13:45:00Z",
  • "transactionId": "ba1834cc-9ed4-4511-868a-6b8f30edf284",
  • "transactionType": "CCPI",
  • "additionalProperties": [
    ]
}

Response samples

Content type
application/json
{
  • "transactionId": "1234",
  • "summary": "Risk – Rules matched",
  • "rulesProcessed": [
    ],
  • "realTimeRuleAlerts": [
    ],
  • "transactionErrors": [
    ],
  • "hasBeenProcessed": true,
  • "requestId": "15ca0d91-c9de-4dfa-a41a-f6963355f1d0",
  • "error": "null"
}

Check the real-time transaction monitoring status

Checks the monitoring status of a pending transaction by its unique identifier. It returns a JSON response containing the risk assessment outcome and details of any real time alerts generated for the pending transaction.

Authorizations:
(api_keyauthorizer)
path Parameters
transactionId
required
string

The unique identifier of pending transaction that is being checked

header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Responses

Response samples

Content type
application/json
{
  • "transactionId": "1234",
  • "summary": "Risk – Rules matched",
  • "rulesProcessed": [
    ],
  • "realTimeRuleAlerts": [
    ],
  • "transactionErrors": [
    ],
  • "hasBeenProcessed": true,
  • "requestId": "15ca0d91-c9de-4dfa-a41a-f6963355f1d0",
  • "error": "null"
}

Transaction Monitoring Health Check

This endpoint is used to check the health of the connection between the API Gateway and the Financial Crime instance. It returns a simple JSON response indicating whether the connection is healthy or not.

Authorizations:
(api_keyauthorizer)
header Parameters
Client-Id
required
string

Your unique client identifier supplied by Jade Thirdeye.

Reporting-Entity
required
string

The name of reporting entity.

Responses

Response samples

Content type
application/json
{
  • "status": "Healthy"
}