Skip to content

Euthor/watson-api-docs

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
.github
.github
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 

Repository files navigation

Table of Contents

  1. Overview
  2. HTTP Statuses
  3. Authentication
  4. Entities

Overview

Request Headers

All requests require 2 headers:

"x-access-token": "replace-this-with-your-access-token"
"Content-Type": "application/json"

URL placeholders

The URL's posted for entities in this documentation usually contain placeholders. Placeholders in URLs are denoted by square brackets, so when you see for example:

URL: /api/customer/[idInternalCustomerPerson]
Method: GET

you are expected to replace [idInternalCustomer] with the Internal Customer Number of your Customer. An actual example would be:

URL: /api/customer/AC001
Method: GET

...which will retrieve the Customer with Internal Customer Number AC001.

HTTP Statuses

Code Text Description
200 OK Success. There is response data as well.
204 No Content Success. There is no response data.
400 Bad Request The request was invalid, usually because the request contains invalid request body data. If this is the case, the response body will contain a message indicating the invalid properties and their issues.
401 Unauthorized The x-access-token is not valid or the username/password do not match when logging-in.
403 Forbidden The x-access-token is valid but the associated user does not have permissions for this action.
404 Not Found The entity does not exist.
500 Server Error The server encountered an error.

Authentication

You authenticate each request by passing an x-access-token header with a valid token.

You are expected to cycle the access token, by logging-in again, every now and then (ideally every other day) to ensure that a compromised token is not indefinitely valid.

To obtain a valid token:

Method: POST URL: /api/login

Sample Request Body:

{
  "username": "administrator",
  "password": "test"
}

Sample Response:

{
    "success": true,
    "token": "eyJhbGciOiJIUzI1N..."
}

Customer

Create Customer

Method: POST URL: /api/customer

Customer Person

Sample Request Body

{
  "details": {
    "dateBirth": "1965-02-01",
    "firstName": "John",
    "maidenName": "Sierra",
    "lastName": "Doe",
    "idCountryBirth": 137,
    "idCountryNationality": 137,
    "idCountryResidence": 137,
    "idGender": 3,
    "idMaritalStatus": 1,
    "nonFaceToFace": true,
    "profession": "Accountant"
  },
  "main": {
    "idCustomerStatus": 1,
    "idCustomerType": 1,
    "idInternalCustomer": "JD001",
    "idUserResponsibleOfficer": 1,
    "otherInfo": "Lorem Ipsum Comment",
    "relationshipStartDate": "2001-01-19",
    "relationshipEndDate": "2004-12-24"
  }  
}

Customer Organisation

Sample Request Body

{
  "details": {
    "dateIncorporation": "2001-12-20",
    "idCountryActivity": 137,
    "idCountryDomiciliary": 137,
    "idCountryIncorporation": 137,
    "idIncorporationType": 1,
    "mainBusinessActivity": "Trading",
    "registeredName": "ACME Corporation LTD",
    "registrationNo": "CY123",
    "tradeName": null
  },
  "main": {
    "idCustomerStatus": 1,
    "idCustomerType": 2,
    "idInternalCustomer": "AC001",
    "idUserResponsibleOfficer": 1,
    "otherInfo": null,
    "referralAgent": null,
    "relationshipStartDate": "2001-01-19",
    "relationshipEndDate": null
  }
}

Sample Response for both Individual and Organisation:

{
    "idAuditTrail": 17,
    "idRiskTrail": 12
}

Read Customer

Method: GET URL: /api/customer/[idInternalCustomerPerson]

Sample Response:

{
    "singles": {
        "main": {
            "idCustomer": 3,
            "idUserLastModified": 2,
            "idInternalCustomer": "200",
            "relationshipStartDate": "2017-02-01",
            "relationshipEndDate": null,
            "referralAgent": null,
            "otherInfo": null,
            "idCustomerStatus": 1,
            "idCustomerType": 1,
            "idUserResponsibleOfficer": 2,
            "idUser": 5,
            "printName": "200"
        },
        "details": {
            "idCustomer": 3,
            "firstName": "John",
            "maidenName": null,
            "lastName": "Doe",
            "dateBirth": "1940-11-12",
            "nonFaceToFace": false,
            "idCountryNationality": 137,
            "idCountryBirth": 137,
            "idCountryResidence": 137,
            "idGender": 1,
            "idMaritalStatus": 6,
            "profession": null
        }
    },
    "lists": {
        "addresses": {
            "contents": [
                {
                    "idAddress": 1,
                    "idCustomer": 3,
                    "idCountry": 137,
                    "streetName": "Makariou",
                    "postcode": "4787",
                    "city": "Nicosia",
                    "filename": " ",
                    "verified": false,
                    "id": 1
                }
            ],
            "deletedRows": [],
            "id": "idAddress"
        },
        "screeningRisks": {
            "contents": [],
            "deletedRows": [],
            "id": "idScreeningRisk"
        },
        "communicationMeans": {
            "contents": [
                {
                    "idCommunicationMeans": 136,
                    "idCommunicationMeansType": 1,
                    "value": "99999999",
                    "idCustomer": 3,
                    "id": 1
                },
                {
                    "idCommunicationMeans": 7,
                    "idCommunicationMeansType": 4,
                    "value": "[email protected]",
                    "idCustomer": 3,
                    "id": 7
                }
            ],
            "deletedRows": [],
            "id": "idCommunicationMeans"
        },
        "annualIncomeEntries": {
            "contents": [
                {
                    "idAnnualIncome": 1,
                    "source": "Salesperson",
                    "idAnnualIncomeScale": 2,
                    "idAnnualIncomeStatus": 1,
                    "idCustomer": 3,
                    "id": 1
                }
            ],
            "deletedRows": [],
            "id": "idAnnualIncome"
        },
        "stakesOut": {
            "contents": [],
            "deletedRows": [],
            "id": "idStake"
        },
        "rolesOut": {
            "contents": [],
            "deletedRows": [],
            "id": "idCustomerAssociation"
        },
        "wealthEntries": {
            "contents": [],
            "deletedRows": [],
            "id": "idWealth"
        },
        "documents": {
            "contents": [],
            "deletedRows": [],
            "id": "idDocument"
        },
        "idCards": {
            "contents": [
                {
                    "idIdCard": 2,
                    "idIdCardType": 4,
                    "idCustomer": 3,
                    "number": "624323",
                    "filename": null,
                    "copy": true,
                    "expirationDate": "2020-11-25",
                    "id": 2
                }
            ],
            "deletedRows": [],
            "id": "idIdCard"
        },
        "events": {
            "contents": [],
            "deletedRows": [],
            "id": "idEvent"
        }
    },
    "checkedLists": {
        "checkedDocuments": {
            "contents": [ 
					1,
					5
				],
            "added": [],
            "removed": [],
            "listId": "npkxth",
            "types": [
                {
                    "id": 1,
                    "name": "Reference letter"
                },
                {
                    "id": 2,
                    "name": "Due Diligence QUESTIONAIRE"
                },
                {
                    "id": 3,
                    "name": "Signature"
                },
                {
                    "id": 4,
                    "name": "World Compliance Questionnaire"
                },
                {
                    "id": 5,
                    "name": "Tax Declaration"
                },
                {
                    "id": 6,
                    "name": "Memorandum and Articles of Association"
                },
                {
                    "id": 7,
                    "name": "Group/ Organization Chart"
                },
                {
                    "id": 8,
                    "name": "Certificate of directors"
                },
                {
                    "id": 9,
                    "name": "Certificate of shareholders"
                },
                {
                    "id": 10,
                    "name": "Certificate of registered office"
                },
                {
                    "id": 11,
                    "name": "Certificate of good standing"
                },
                {
                    "id": 12,
                    "name": "Trust deed"
                },
                {
                    "id": 13,
                    "name": "Board resolution"
                },
                {
                    "id": 14,
                    "name": "Engagement letter"
                },
                {
                    "id": 15,
                    "name": "Company relationship form"
                }
            ]
        },
        "checkedActivityRisks": {
            "contents": [],
            "added": [],
            "removed": [],
            "listId": "kenpiu",
            "types": [
                {
                    "id": 1,
                    "name": "Art Dealer"
                },
                {
                    "id": 2,
                    "name": "High Value transactions"
                },
                {
                    "id": 3,
                    "name": "Precious stones"
                },
                {
                    "id": 4,
                    "name": "High Risk trading / Casino gaming"
                },
                {
                    "id": 5,
                    "name": "Internet based business"
                },
                {
                    "id": 6,
                    "name": "Cash based business"
                },
                {
                    "id": 7,
                    "name": "Electronic Money Institution"
                },
                {
                    "id": 8,
                    "name": "Business generating high volumes of cash"
                },
                {
                    "id": 9,
                    "name": "Money Service Business"
                },
                {
                    "id": 10,
                    "name": "Art Dealer"
                },
                {
                    "id": 11,
                    "name": "Precious stones"
                },
                {
                    "id": 12,
                    "name": "High risk trading / Casino gaming"
                },
                {
                    "id": 13,
                    "name": "Internet based business"
                },
                {
                    "id": 14,
                    "name": "Cash based business"
                },
                {
                    "id": 15,
                    "name": "Electronic Money Institution"
                },
                {
                    "id": 16,
                    "name": "High Value transactions"
                },
                {
                    "id": 17,
                    "name": "Money Service Business"
                },
                {
                    "id": 18,
                    "name": "Business generating high volumes of cash"
                },
                {
                    "id": 19,
                    "name": "Bearer Shares"
                }
            ]
        },
        "checkedBehaviorRisks": {
            "contents": [
				3,
				5
			],
            "added": [],
            "removed": [],
            "listId": "sdvfkd",
            "types": [
                {
                    "id": 1,
                    "name": "Frequent changes of address"
                },
                {
                    "id": 2,
                    "name": "Avoidance of authorities"
                },
                {
                    "id": 3,
                    "name": "Difficult to reach"
                },
                {
                    "id": 4,
                    "name": "Criminal proceedings"
                },
                {
                    "id": 5,
                    "name": "Unwillingness to provide (KYC) documentation/information requested"
                },
                {
                    "id": 6,
                    "name": "Unwillingness to provide details on source of funds"
                },
                {
                    "id": 7,
                    "name": "Provides unusual suspicious ID docs that cannot be easily verified"
                },
                {
                    "id": 8,
                    "name": "Client acting nervous"
                },
                {
                    "id": 9,
                    "name": "Client in depth knowledge of AML requirements"
                },
                {
                    "id": 10,
                    "name": "Frequent changes of address"
                },
                {
                    "id": 11,
                    "name": "Reluctant to provide information"
                },
                {
                    "id": 12,
                    "name": "Not clear business activity"
                },
                {
                    "id": 13,
                    "name": "Difficult to reach"
                },
                {
                    "id": 14,
                    "name": "Avoidance of authorities"
                }
            ]
        },
        "checkedEnhancedChecks": {
            "contents": [
                3
            ],
            "added": [],
            "removed": [],
            "listId": "pehsld",
            "types": [
                {
                    "id": 1,
                    "name": "Second Identification Document"
                },
                {
                    "id": 2,
                    "name": "Registered Mail with required response"
                },
                {
                    "id": 3,
                    "name": "Called customer at home phone number"
                },
                {
                    "id": 4,
                    "name": "Home visit"
                },
                {
                    "id": 5,
                    "name": "Visited their offices"
                },
                {
                    "id": 6,
                    "name": "Lawyer Certification"
                },
                {
                    "id": 7,
                    "name": "Received Apostilled documents"
                },
                {
                    "id": 8,
                    "name": "Called at their offices"
                },
                {
                    "id": 9,
                    "name": "Visited their website"
                }
            ]
        }
    }
}

Update Customer

Method: PUT URL: /api/customer/[idInternalCustomerPerson]

Customer Person

Sample Request Body

{
  "details": {
    "profession": "Programmer"
  },
  "main": {
    "otherInfo": "Lorem Ipsum Comment 2"
  }
}

Customer Organisation

Sample Request Body

{
  "details": {
    "registrationNo": "CY-456"
  },
  "main": {
    "otherInfo": "Lorem Ipsum Comment 2"
  }
}

Sample Response for both Individual and Organisation:

{
    "idAuditTrail": 21,
    "idRiskTrail": 14
}

Delete Customer

Method: DELETE URL: /api/customer/[idInternalCustomerPerson]

The response has no body (empty)

Customer Lists

Customer Lists can be passed an Array with 1 or more elements. For brevity only 1 element is passed in the sample request bodies for the following lists.

Customer ID Card

Create ID Card

URL: /api/customer/[idInternalCustomer]/id-card Method: POST

Sample Request Body

[
  {
    "idIdCardType": 3,
    "number": "CY-JD-001",
    "expirationDate": "2080-01-04",
    "copy": true
  }
]

Sample Response

{
    "idAuditTrail": 30,
    "idRiskTrail": 13
}

Read ID Card

URL: /api/customer/[idInternalCustomer]/id-card Method: GET

Sample Response:

[
    {
        "idIdCard": 4,
        "idIdCardType": 4,
        "idCustomer": 5,
        "number": "704473",
        "filename": null,
        "copy": false,
        "expirationDate": "2018-04-07",
        "id": 4
    },
    {
        "idIdCard": 7,
        "idIdCardType": 2,
        "idCustomer": 5,
        "number": "12345",
        "filename": null,
        "copy": true,
        "expirationDate": "2020-01-01",
        "id": 7
    }
]

Update ID Card

URL: /api/customer/[idInternalCustomer]/id-card/[idIdCard] Method: PUT

Sample Request Body

{
  "copy": false,
  "number": "CY-JD-002"
}

Sample Response

{
    "idAuditTrail": 32,
    "idRiskTrail": 13
}

Delete ID Card

URL: /api/customer/[idInternalCustomer]/id-card/[idIdCard] Method: DELETE

Sample Response

{
    "idAuditTrail": 55,
    "idRiskTrail": 26
}

Customer Address

Create Address

URL: /api/customer/[idInternalCustomer]/addresses Method: POST

Sample Request Body

[
  {
    "streetName": "13 Nelsonos Street",
    "city": "Nicosia",
    "postcode": "2029",
    "idCountry": 137,
    "verified": true
  }
]

Sample Response

{
    "idAuditTrail": 35,
    "idRiskTrail": 15
}

Read Address

URL: /api/customer/[idInternalCustomer]/addresses Method: GET

Sample Response

[
    {
        "idAddress": 2,
        "idCustomer": 4,
        "idCountry": 137,
        "streetName": "Digeni Akrita",
        "postcode": "4498",
        "city": "Limassol",
        "filename": " ",
        "verified": false,
        "id": 2
    },
    {
        "idAddress": 6,
        "idCustomer": 4,
        "idCountry": 137,
        "streetName": "Mpizaniou",
        "postcode": "4493",
        "city": "Limassol",
        "filename": null,
        "verified": true,
        "id": 6
    }
]

Update Address

URL: /api/customer/[idInternalCustomer]/addresses/[idAddress] Method: PUT

Sample Request Body

{
  "streetName": "55 Fykardou Street",
  "postcode": "2010",
  "verified": false
}

Sample Response:

{
    "idAuditTrail": 37,
    "idRiskTrail": 15
}

Delete Address

URL: /api/customer/[idInternalCustomer]/addresses/[idAddress] Method: DELETE

Sample Response:

{
    "idAuditTrail": 39,
    "idRiskTrail": 15
}

Customer Communication Means

Create Communication Means

URL: /api/customer/[idInternalCustomer]/communication-means Method: POST

Sample Request Body

[
  {
    "idCommunicationMeansType": 4,
    "value": "[email protected]"
  }
]

Sample Response

{
    "idAuditTrail": 40,
    "idRiskTrail": 15
}

Read Communication Means

URL: /api/customer/[idInternalCustomer]/communication-means Method: GET

Sample Response

[
    {
        "idCommunicationMeans": 8,
        "idCommunicationMeansType": 1,
        "value": "99999999",
        "idCustomer": 4,
        "id": 8
    },
    {
        "idCommunicationMeans": 10,
        "idCommunicationMeansType": 3,
        "value": "98561898",
        "idCustomer": 4,
        "id": 10
    },
    {
        "idCommunicationMeans": 36,
        "idCommunicationMeansType": 4,
        "value": "[email protected]",
        "idCustomer": 4,
        "id": 36
    }
]

Update Communication Means

URL: /api/customer/[idInternalCustomer]/communication-means/[idCommunicationMeans] Method: PUT

Sample Request Body

{
  "value": "[email protected]"
}

Sample Response

{
    "idAuditTrail": 41,
    "idRiskTrail": 15
}

Delete Communication Means

URL: /api/customer/[idInternalCustomer]/communication-means/[idCommunicationMeans] Method: DELETE

Sample Response

{
    "idAuditTrail": 42,
    "idRiskTrail": 15
}

Customer Wealth

Create Wealth

URL: /api/customer/[idInternalCustomer]/wealth Method: POST

Sample Request Body

[
  {
    "idWealthScale": 1,
    "idWealthStatus": 1,
    "source": "Oil Investments"
  }
]

Sample Response

{
    "idAuditTrail": 43,
    "idRiskTrail": 15
}

Read Wealth

URL: /api/customer/[idInternalCustomer]/wealth Method: GET

Sample Response

[
    {
        "idWealth": 1,
        "idCustomer": 4,
        "idWealthScale": 6,
        "idWealthStatus": 1,
        "source": "Oil Investments",
        "id": 1
    },
    {
        "idWealth": 2,
        "idCustomer": 4,
        "idWealthScale": 2,
        "idWealthStatus": 2,
        "source": "Inheritance",
        "id": 2
    }
]

Update Wealth

URL: /api/customer/[idInternalCustomer]/wealth/[idWealth] Method: PUT

Sample Request Body

{
  "source": "Lottery Winnings"
}

Sample Response

{
    "idAuditTrail": 46,
    "idRiskTrail": 15
}

Delete Wealth

URL: /api/customer/[idInternalCustomer]/wealth/[idWealth] Method: DELETE

Sample Response

{
    "idAuditTrail": 47,
    "idRiskTrail": 16
}

Customer Annual Income

Create Annual Income

URL: /api/customer/[idInternalCustomer]/annual-income Method: POST

Sample Request Body

[
  {
    "idAnnualIncomeScale": 1,
    "idAnnualIncomeStatus": 1,
    "source": "Oil Investments"
  }
]

Sample Response

{
    "idAuditTrail": 48,
    "idRiskTrail": 16
}

Read Annual Income

URL: /api/customer/[idInternalCustomer]/annual-income Method: GET

Sample Response

[
    {
        "idAnnualIncome": 2,
        "source": "Politician",
        "idAnnualIncomeScale": 2,
        "idAnnualIncomeStatus": 1,
        "idCustomer": 4,
        "id": 2
    },
    {
        "idAnnualIncome": 6,
        "source": "Oil Investments",
        "idAnnualIncomeScale": 1,
        "idAnnualIncomeStatus": 1,
        "idCustomer": 4,
        "id": 6
    }
]

Update Annual Income

URL: /api/customer/[idInternalCustomer]/annual-income/[idAnnualIncome] Method: PUT

Sample Request Body

{
  "source": "Lottery Winnings"
}

Sample Response:

{
    "idAuditTrail": 49,
    "idRiskTrail": 17
}

Delete Annual Income

URL: /api/customer/[idInternalCustomer]/annual-income[idAnnualIncome] Method: DELETE

Sample Response:

{
    "idAuditTrail": 53,
    "idRiskTrail": 17
}

Customer Counterparty

Create Counterparty

URL: /api/customer/[idInternalCustomer]/counterparty Method: POST

Sample Request Body

[
  {
    "counterpartName": "Mary Jane",
    "idCountry": 137,
    "idFundType": 1,
    "comments": "Lorem Ipsum"
  },
  {
    "counterpartName": "John Doe",
    "idCountry": 128,
    "idFundType": 2,
    "comments": "The comments"
  }
]

Sample Response:

{
    "idAuditTrail": 54,
    "idRiskTrail": 18
}

Read Counterparty

URL: /api/customer/[idInternalCustomer]/counterparty Method: GET

Sample Response:

[
    {
        "idFund": 1,
        "idFundType": 1,
        "idCountry": 137,
        "comments": "Lorem Ipsum",
        "counterpartName": "Mary Jane",
        "id": 1
    },
    {
        "idFund": 2,
        "idFundType": 2,
        "idCountry": 128,
        "comments": "The comments",
        "counterpartName": "John Doe",
        "id": 2
    }
]

Update Counterparty

URL: /api/customer/[idInternalCustomer]/counterparty/[idFund] Method: PUT

Sample Request Body

{
  "comments": "Lorem Ipsum Dolor Sit Amet"
}

Sample Response:

{
    "idAuditTrail": 55,
    "idRiskTrail": 18
}

Delete Counterparty

URL: /api/customer/[idInternalCustomer]/counterparty/[idFund] Method: DELETE

Sample Response:

{
    "idAuditTrail": 56,
    "idRiskTrail": 18
}

Customer Financial Statement

Create Financial Statement

URL: /api/customer/[idInternalCustomer]/financial-statement Method: POST

Sample Request Body

[
  {
    "copy": true,
    "idStatementType": 1,
    "income": "500000.00",
    "year": 2005
  }
]

Sample Response:

{
    "idAuditTrail": 56,
    "idRiskTrail": 18
}

Read Financial Statement

URL: /api/customer/[idInternalCustomer]/financial-statement Method: GET

Sample Response:

[
    {
        "idStatement": 1,
        "idStatementType": 1,
        "year": 2005,
        "income": 500000,
        "expenses": null,
        "copy": true,
        "id": 1
    }
]

Update Financial Statement

URL: /api/customer/[idInternalCustomer]/financial-statement/[idStatement] Method: PUT

Sample Request Body

{
  "year": 2006
}

Sample Response:

{
    "idAuditTrail": 58,
    "idRiskTrail": 18
}

Delete Financial Statement

URL: /api/customer/[idInternalCustomer]/financial-statement/[idStatement] Method: DELETE

Sample Response:

{
    "idAuditTrail": 60,
    "idRiskTrail": 19
}

Customer Country Presence

Create Country Presence

URL: /api/customer/[idInternalCustomer]/country-presence Method: POST

Sample Request Body

[
  {
    "idCountry": 1,
    "year": 2005
  }
]

Sample Response:

{
    "idAuditTrail": 61,
    "idRiskTrail": 19
}

Read Country Presence

URL: /api/customer/[idInternalCustomer]/country-presence Method: GET

Sample Response:

[
    {
        "idCountryPresence": 1,
        "idCountry": 1,
        "year": 2005,
        "id": 1
    },
    {
        "idCountryPresence": 3,
        "idCountry": 90,
        "year": 2009,
        "id": 3
    }
]

Update Country Presence

URL: /api/customer/[idInternalCustomer]/country-presence/[idCountryPresence] Method: PUT

Sample Request Body

{
  "year": 2006
}

Sample Response:

{
    "idAuditTrail": 65,
    "idRiskTrail": 19
}

Delete Country Presence

URL: /api/customer/[idInternalCustomer]/country-presence/[idCountryPresence] Method: DELETE

Sample Response:

{
    "idAuditTrail": 66,
    "idRiskTrail": 20
}

Customer Screening Risks

Create Screening Risks

URL: /api/customer/[idInternalCustomer]/screening-risks Method: POST

Sample Request Body

[
  {
    "idScreeningRiskType": 1,
    "full_name": "Donald Trump",
    "score": 97,
    "inspected": true,
    "confirmed": false,
    "manual_addition": true
  }
]

Sample Response:

{
    "idAuditTrail": 69,
    "idRiskTrail": 21
}

Read Screening Risks

URL: /api/customer/[idInternalCustomer]/screening-risks Method: GET

Sample Response:

[
    {
        "idScreeningRisk": 3,
        "idCustomer": 15,
        "idScreeningRiskType": 2,
        "identifier": "10101729617",
        "score": 100,
        "inspected": true,
        "confirmed": false,
        "type": "PEP List",
        "full_name": "Donald John Jr. Trump",
        "json": "{\"ID\":\"10101729617\",\"Relative_ID\":\"10101192552\",\"Title\":\"Mr.\",\"Gender\":\"Male\",\"First_Name\":\"Donald John Jr.\",\"Last_Name\":\"Trump\",\"Full_Name\":\"\",\"Other_Names\":\"Trump, Don\",\"Alternative_Script\":\"\",\"Function\":\"Relatives of High Officials, Son of Donald John Trump, CATEGORY: Close Relatives of PEPs\",\"Category\":\"Close Relatives of PEPs\",\"DOB\":\"31.12.1977\",\"POB\":\"Manhattan, New York, United States of America\",\"Country\":\"United States of America\",\"Code\":\"USA\",\"Additional_Information\":\"\",\"Country_Of_Origin\":\"\",\"Country_Of_Activity\":\"\"}",
        "md5": "3dafa6c51cd6b6af7d1e1c66fcbc3002",
        "manual_addition": false,
        "id": 3
    },
    {
        "idScreeningRisk": 4,
        "idCustomer": 15,
        "idScreeningRiskType": 2,
        "identifier": "10101192552",
        "score": 100,
        "inspected": true,
        "confirmed": true,
        "type": "PEP List",
        "full_name": "Donald John Trump",
        "json": "{\"ID\":\"10101192552\",\"Relative_ID\":\"10101192552\",\"Title\":\"Mr.\",\"Gender\":\"Male\",\"First_Name\":\"Donald John\",\"Last_Name\":\"Trump\",\"Full_Name\":\"\",\"Other_Names\":\"\",\"Alternative_Script\":\"\",\"Function\":\"Executive Office of the President, White House Office, President of the United States of America, CATEGORY: Heads of State, Major Government Offices and Support; OTHER FUNCTION: Armed Forces, Commander-in-Chief, CATEGORY: Military; OTHER FUNCTION: Executive Office of the President, National Security Council, Chairperson, CATEGORY: Heads of State, Major Government Offices and Support\",\"Category\":\"Heads of State, Major Government Offices and Support; Military\",\"DOB\":\"14.06.1946\",\"POB\":\"Queens, New York City, New York, United States of America\",\"Country\":\"United States of America\",\"Code\":\"USA\",\"Additional_Information\":\"Net Worth: $2.9 B; Source: television, real estate\",\"Country_Of_Origin\":\"\",\"Country_Of_Activity\":\"\"}",
        "md5": "9104e278e9b2458b2686e1841472f541",
        "manual_addition": false,
        "id": 4
    },
    {
        "idScreeningRisk": 6,
        "idCustomer": 15,
        "idScreeningRiskType": 1,
        "identifier": null,
        "score": 100,
        "inspected": true,
        "confirmed": false,
        "type": null,
        "full_name": "Donald Trump",
        "json": null,
        "md5": null,
        "manual_addition": true,
        "id": 6
    }
]

Update Screening Risks

URL: /api/customer/[idInternalCustomer]/screening-risks/[idScreeningRisk] Method: PUT

Sample Request Body

{
  "confirmed": true
}

Sample Response:

{
    "idAuditTrail": 71,
    "idRiskTrail": 21
}

Delete Screening Risks

URL: /api/customer/[idInternalCustomer]/screening-risks/[idScreeningRisk] Method: DELETE

Sample Response:

{
    "idAuditTrail": 72,
    "idRiskTrail": 21
}

Risk Analysis

URL: /api/customer/[idInternalCustomerPerson]/risk Method: GET

Sample Response for Person:

{
    "totals": {
        "screening": {
            "name": "Screening Risks",
            "contents": [
                {
                    "name": "Screening",
                    "score": 300
                }
            ],
            "score": 300
        },
        "kyc": {
            "name": "KYC Risks",
            "contents": [
                {
                    "name": "Non Face to Face",
                    "score": 0
                },
                {
                    "name": "ID Card",
                    "score": 300
                },
                {
                    "name": "Address",
                    "score": 300
                },
                {
                    "name": "Communication Means",
                    "score": 20
                },
                {
                    "name": "Missing Documents",
                    "score": 0
                }
            ],
            "score": 620
        },
        "economicProfile": {
            "name": "Economic Profile Risks",
            "contents": [
                {
                    "name": "Activity",
                    "score": 0
                },
                {
                    "name": "Wealth",
                    "score": 0
                }
            ],
            "score": 0
        },
        "countries": {
            "name": "Country Risks",
            "contents": [
                {
                    "name": "Countries",
                    "score": 180
                }
            ],
            "score": 180
        },
        "general": {
            "name": "General Risks",
            "contents": [
                {
                    "name": "Referred by third party",
                    "score": 0
                },
                {
                    "name": "Relationship Length",
                    "score": 20
                },
                {
                    "name": "Behavior",
                    "score": 0
                }
            ],
            "score": 20
        }
    },
    "contaminators": [
        {
            "idCustomer": 2,
            "newCalculatedRisk": 1140
        }
    ],
    "global": {
        "score": 1120
    }
}

Sample Response for Organisation:

{
    "totals": {
        "screening": {
            "name": "Screening Risks",
            "contents": [
                {
                    "name": "Screening",
                    "score": 0
                }
            ],
            "score": 0
        },
        "kyc": {
            "name": "KYC Risks",
            "contents": [
                {
                    "name": "Entity Type",
                    "score": 0
                },
                {
                    "name": "Address",
                    "score": 300
                },
                {
                    "name": "Communication Means",
                    "score": 20
                },
                {
                    "name": "Missing Documents",
                    "score": 40
                }
            ],
            "score": 360
        },
        "economicProfile": {
            "name": "Economic Profile Risks",
            "contents": [
                {
                    "name": "Activity",
                    "score": 0
                },
                {
                    "name": "Wealth",
                    "score": 0
                },
                {
                    "name": "Financial Statements",
                    "score": 100
                }
            ],
            "score": 100
        },
        "countries": {
            "name": "Country Risks",
            "contents": [
                {
                    "name": "Countries",
                    "score": 0
                },
                {
                    "name": "Country Presence",
                    "score": 270
                },
                {
                    "name": "Counterparty",
                    "score": 400
                }
            ],
            "score": 670
        },
        "general": {
            "name": "General Risks",
            "contents": [
                {
                    "name": "Referred by third party",
                    "score": 0
                },
                {
                    "name": "Relationship Length",
                    "score": 10
                },
                {
                    "name": "Behavior",
                    "score": 0
                }
            ],
            "score": 10
        }
    },
    "contaminators": [],
    "global": {
        "score": 1140
    }
}

Review

Read Reviews

URL: /api/customer/[idInternalCustomer]/reviews Method: GET

Sample Response:

[
    {
        "id": 8,
        "idReview": 8,
        "createdDate": null,
        "scheduledDate": "2020-01-17",
        "reviewedDate": null,
        "reviewed": false,
        "comments": null,
        "idCustomer": 15,
        "idUserScheduler": null,
        "idUserReviewer": null,
        "userReviewerName": null
    },
    {
        "id": 7,
        "idReview": 7,
        "createdDate": null,
        "scheduledDate": "2020-01-17",
        "reviewedDate": "2019-10-17",
        "reviewed": true,
        "comments": "",
        "idCustomer": 15,
        "idUserScheduler": null,
        "idUserReviewer": 2,
        "userReviewerName": "approver"
    }
]

Read Last Review - PENDING

Review Last Review - PENDING

Risk Trail

Read Risk Trails - PENDING

Read Last Risk Trail

URL: /api/customer/[idInternalCustomer]/risk-trails?limits=1 Method: GET

Sample Response:

{
    "id": 20,
    "idRiskTrail": 20,
    "reviewed": false,
    "reviewedDate": null,
    "comments": null,
    "idCustomer": 2,
    "idRiskType": null,
    "idUserReviewer": null,
    "userReviewerName": null,
    "idApprovalStatus": null,
    "approvalStatusName": null
}

Update/Approve Risk Trail

URL: /api/customer/risk-trails/[idRiskTrail] Method: PUT

Sample Request Body:

{
  "idApprovalStatus": 1,
  "idRiskType": 1,
  "comments": "Lorem Ipsum"
}

Sample Response:

[
    {
        "idReview": 6
    }
]

About

EuComply/Watson API Documentation

Topics

api documentation rest watson eucomply

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

3 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •