Skip to main content

Quickstart Guide

Before you start using the Transaction Monitoring and Actor Intelligence solutions, the Lucinity Platform needs access to the relevant customer, account and transaction data.

These seven easy steps show you how to use our APIs to publish data to the Lucinity Platform and get your own Transaction Monitoring or Actor Intelligence solution up and running in no time.

Please note that you can send the data in any order. However, to make it a bit easier for you, we have structured it as Actors, Accounts and Transactions.

Step 1 - Get Your API Keys Ready#

Make sure you have your API Keys ready to go to be able to authenticate with the Lucinity Platform. The API Key is a string consisting of numbers and letters. Please send us a line to [email protected] if you don't have your API Key yet. 

Step 2 - Ingest Actor Data#

Collect your customer data and follow the data structure outlined below to ingest it to the Lucinity Platform. Use the provided code snippet to try it out.

Transmitting Customer Data
var unirest = require("unirest");var req = unirest("POST", "https://api.lucinity.com/actors");req.headers({    "X-Api-Key": "qiTgISif4zprgBb5j4hXfp3qhD"});req.post(            {            "id": "ACT985002241",            "asOfDate": "2019-08-24",            "isActive": true,            "type": "INDIVIDUAL",            "displayName": "David Butler",            "firstName": "David",            "middleName": "James",            "lastName": "Butler",            "dateOfBirth": "1966-01-21",            "gender": "MALE",            "addresses": [                {                "type": "HOME",                "line1": "123 Bond Street",                "line2": "Mayfair",                "postcode": "W1S 1EJ",                "city": "London",                "state": "",                "country": "UK"                }            ],            "phones": [                {                "type": "MOBILE",                "number": "07992847294"                }            ],            "emails": [                {                "type": "HOME",                "address": "[email protected]"                }            ],            "nationality": "UK",            "domicile": "US",            "taxResidency": "CH"        });req.end(function (res) {    if (res.error) throw new Error(res.error);    console.log(res.body);});

Step 3 - Ingest Account Data#

Collect your customer's account data and follow the data structure outlined below to ingest it to the Lucinity Platform. Use the provided code snippet to try it out.

Transmitting Accounts Data
var unirest = require("unirest");var req = unirest("POST", "https://api.lucinity.com/accounts");req.headers({    "X-Api-Key": "qiTgISif4zprgBb5j4hXfp3qhD"});req.post(    {        "id": "ACC99140294",        "asOfDate": "2019-08-24",        "accountType": "CURRENT",        "bankCode": "0702",        "accountAgreementId": "ACC99140294",        "currencyCode": "ISK",        "productId": "738983",        "openedDate": "2019-08-24",        "internal": true,        "depositable": true,        "withdrawable": true,        "collateral": false,        "terminated": false,        "terminationDate": "",        "accountInDefault": true,        "accountInDefaultDays": 7,        "interest": {            "interestType": "DEPOSIT",            "interestCode": "X94",            "interestForm": "VARIABLE",            "interestRate": "0.025"        },        "balance": {            "depositBalance": 848204,            "depositBalanceLcy": "",            "depositDisposableBalance": "",            "depositDisposableBalanceLcy": "",            "loanBalance": "",            "loanBalanceLcy": ""        },        "termDeposit": {            "termDepositType": "",            "termDepositPeriod": "",            "termDepositWithdrawalNotice": "",            "termDepositWithdrawalDate": ""        },        "credit": {            "creditType": "",            "creditLimit": "",            "creditLimitLcy": "",            "creditUnused": "",            "creditUnusedLcy": "",            "creditIssueDate": "",            "creditFinalDate": "",            "creditCardNumberMasked": ""        },        "loan": {            "loanType": "",            "loanPrincipal": "",            "loanPrincipalLcy": "",            "loanInstallment": "",            "loanSecured": "",            "loanPeriodRemaining": "",            "loanIssueDate": "",            "loanFinalDate": ""        }    }
);req.end(function (res) {    if (res.error) throw new Error(res.error);    console.log(res.body);});

Step 4 - Ingest Transaction Data#

Collect your customer's transactions data and follow the data structure outlined below to ingest it to the Lucinity Platform. Use the provided code snippet to try it out.

Transmitting Transaction Data
var unirest = require("unirest");var req = unirest("POST", "https://api.lucinity.com/transactions");
req.headers({    "X-Api-Key": "qiTgISif4zprgBb5j4hXfp3qhD"});req.post(    {        "id": "TXN949000250",        "accountId": "ACC99140294",        "accountAgreementId": "ACC99140294",        "amount": 100,        "amountLcy": 100,        "currencyCode": "GBP",        "entryDate": "2020-05-03T14:03:41.089Z",        "valueDate": "2020-05-03T14:03:41.089Z",        "bookingDate": "",        "paidDate": "",        "transactionalGroupId": "8285702980473",        "voidCode": "",        "voidCodeDate": "",        "tellerCode": "AD0001",        "cardNumber": "",        "checkNumber": "",        "balanceRunningLcy": 12000,        "description": "Transfer for products, invoice 4285",        "channelLocationCode": "",        "channelLocationType": "ONLINE",        "method": "TRANSFER",        "categoryCode": "X001",        "categoryPrimaryName": "",        "categoryPrimaryCode": "",        "categorySecondaryName": "",        "categorySecondaryCode": "",        "counterpartyFIID": "W3852",        "counterpartyBankCode": "082992",        "counterpartyAccountNumber": "9582666",        "counterpartyIBAN": "GB29874092300111",        "internationalTransaction": false    }
);req.end(function (res) {    if (res.error) throw new Error(res.error);    console.log(res.body);});

Step 5 - Ingest Actor Account Mapping#

Collect your customer's and customer's account data and follow the data structure outlined below to map Actors to Accounts in the Lucinity Platform. Use the provided code snippet to try it out.

Transmitting Actor-Account Mapping
var unirest = require("unirest");var req = unirest("POST", "https://api.lucinity.com/accounts/ACC99140294/actors");
req.headers({    "X-Api-Key": "qiTgISif4zprgBb5j4hXfp3qhD"});req.post(    {        "asOfDate": "2019-08-24",        "actors": [            {            "id": "ACT985002241",            "role": "OWNER"            }        ]    });req.end(function (res) {    if (res.error) throw new Error(res.error);    console.log(res.body);});

Step 6 - Actor Associates & Risk Assessment (Optional)#

You can enrich the data with any additional information about your Customers to get a better risk overview (entities linked to customers, internal or external risk assessments, etc.). Follow the data structure outlined below. Use the provided code snippet to try it out.

Transmitting Actor Associates
var unirest = require("unirest");var req = unirest("POST", "https://api.lucinity.com/actors/ACT985002241/associates");
req.headers({    "X-Api-Key": "qiTgISif4zprgBb5j4hXfp3qhD"});req.post(    {        "asOfDate": "2019-08-24",        "actorAssociates": [            {            "id": "AA842099",            "name": "Fred Patricks",            "type": "DIRECTOR",            "customer": false            }        ]    });req.end(function (res) {    if (res.error) throw new Error(res.error);    console.log(res.body);});
Transmitting Risk Assesment
var unirest = require("unirest");var req = unirest("POST", "https://api.lucinity.com/actors/ACT985002241/riskAssessment");
req.headers({    "X-Api-Key": "qiTgISif4zprgBb5j4hXfp3qhD"});req.post(   {       "id": "ACT985002241",       "asOfDate": "2019-08-24",       "riskDate": "2019-08-24",       "riskType": "PEP",       "riskValue": "1"   });req.end(function (res) {    if (res.error) throw new Error(res.error);    console.log(res.body);});

Step 7 - Initialize Your Data Batch#

Now that you have sent us all the relevant data, you need to evoke the initialize method to get the batch running and analyzed. The initialization method you use depends on whether you want to run Transaction Monitoring or Actor Intelligence.

For Transaction Monitoring set the processType parameter to AML

For Actor Intelligence set the processType parameter to ACTOR

Use the code examples below to get you started.

Initializing the batch for Transaction Monitoring.
var unirest = require("unirest");var req = unirest("POST", "https://api.lucinity.com/detection/initialize");
req.headers({    "X-Api-Key": "qiTgISif4zprgBb5j4hXfp3qhD"});req.post(    {        "closeOfBusinessDate": "2020-02-01",        "lineOfBusiness": "INDIVIDUAL",        "processType": "AML"    });req.end(function (res) {    if (res.error) throw new Error(res.error);    console.log(res.body);});

All Done!#

That's it! Now you are ready to start to Make Money Good with Lucinity.

Please refer to documentation for Transaction Monitoring and Actor Intelligence for information about how to use some of Lucinity's advanced capabilities through APIs.