NAV
HTTP

Reis RCS™ v3.0.0-beta

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Reis RCS REST API

Base URLs:

Email: Vneuron Web: Vneuron License: Copyright © 2020, Vneuron. All rights reserved

Authentication

Authentication API

User X Auth Token Controller

Authenticate the user

Code samples

POST /localhost:8098/kyc-web-restful/xauth/authenticate HTTP/1.1

Content-Type: application/json
Accept: application/json
Application-Type: KYC
x-auth-tenant: string

POST /xauth/authenticate

Token based authentication, users should use their username and password in order to obtain a token which allows them to use the other web-services. This method should be called prior to using any other APIs.

Body parameter

{
  "password": "string",
  "user_name": "string"
}

Parameters

Name In Type Required Description
Application-Type header string false Application-Type
x-auth-tenant header string true x-auth-tenant
body body LoginDto true Login payload

Enumerated Values

Parameter Value
Application-Type KYC
Application-Type AML
Application-Type DEFAULT

Example responses

200 Response

{
  "agencyLocation": "string",
  "amlHomePage": "string",
  "dataAdmin": true,
  "display_name": "string",
  "distributionChannel": "string",
  "homePage": "string",
  "id": 0,
  "kycHomePage": "string",
  "priorite": 0,
  "roles": [
    "string"
  ],
  "token": "string",
  "userType": "string",
  "user_name": "string"
}

Responses

Status Meaning Description Schema
200 OK OK AuthenticationInfoDto
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Refresh token

Code samples

GET /localhost:8098/kyc-web-restful/xauth/refreshtoken HTTP/1.1

Accept: application/json
Application-Type: KYC
x-auth-tenant: string

GET /xauth/refreshtoken

Refresh the current auth token before it expire

Parameters

Name In Type Required Description
Application-Type header string true Application-Type
x-auth-tenant header string true x-auth-tenant

Enumerated Values

Parameter Value
Application-Type KYC
Application-Type AML
Application-Type DEFAULT

Example responses

200 Response

{
  "agencyLocation": "string",
  "amlHomePage": "string",
  "dataAdmin": true,
  "display_name": "string",
  "distributionChannel": "string",
  "homePage": "string",
  "id": 0,
  "kycHomePage": "string",
  "priorite": 0,
  "roles": [
    "string"
  ],
  "token": "string",
  "userType": "string",
  "user_name": "string"
}

Responses

Status Meaning Description Schema
200 OK OK AuthenticationInfoDto
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Customers

Customer Controller

Get the customer entity type

Code samples

GET /localhost:8098/kyc-web-restful/customers/v1/getentitytype/{id} HTTP/1.1

Accept: application/json

GET /customers/v1/getentitytype/{id}

Parameters

Name In Type Required Description
id path integer(int64) true id

Example responses

200 Response

"NONE"

Responses

Status Meaning Description Schema
200 OK OK string
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Get the customer status

Code samples

GET /localhost:8098/kyc-web-restful/customers/v1/getstatuscustomer/{id}/{system} HTTP/1.1

Accept: application/json

GET /customers/v1/getstatuscustomer/{id}/{system}

Parameters

Name In Type Required Description
id path integer(int64) true id
system path string true system

Example responses

200 Response

"CUSTOMER"

Responses

Status Meaning Description Schema
200 OK OK string
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Add customer's relations

Code samples

POST /localhost:8098/kyc-web-restful/customers/v1/upsert-connexions-customer HTTP/1.1

Content-Type: application/json
Accept: */*

POST /customers/v1/upsert-connexions-customer

Body parameter

[
  {
    "comment": "string",
    "id": 0,
    "ownerCustomerId": 0,
    "ownerCustomerSysId": "string",
    "ownerSystemId": 0,
    "ownerSystemName": "string",
    "relatedCustomerId": 0,
    "relatedSystemId": 0,
    "relatedSystemName": "string",
    "relationBeginDate": "2019-08-24T14:15:22Z",
    "relationDueDate": "2019-08-24T14:15:22Z",
    "relationEndDate": "2019-08-24T14:15:22Z",
    "relationShipId": 0,
    "relationShipName": "string"
  }
]

Parameters

Name In Type Required Description
body body CustomerConnexionDto true connexions

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Response Schema

Onboarding

Onboarding Controller

Onboard a customer

Code samples

POST /localhost:8098/kyc-web-restful/onboarding/v1/onboard HTTP/1.1

Content-Type: application/json
Accept: */*

POST /onboarding/v1/onboard

Body parameter

{
  "customerId": 0,
  "customerRelationName": "string",
  "formId": 0,
  "items": {
    "booleanValue": true,
    "children": [
      {
        "booleanValue": true,
        "children": [
          {
            "booleanValue": null,
            "children": null,
            "doubleValue": null,
            "id": null,
            "intValue": null,
            "jsonNode": null,
            "key": null,
            "longValue": null,
            "stringValue": null,
            "type": null
          }
        ],
        "doubleValue": 0,
        "id": 0,
        "intValue": 0,
        "jsonNode": {},
        "key": "string",
        "longValue": 0,
        "stringValue": "string",
        "type": "string"
      }
    ],
    "doubleValue": 0,
    "id": 0,
    "intValue": 0,
    "jsonNode": {},
    "key": "string",
    "longValue": 0,
    "stringValue": "string",
    "type": "string"
  },
  "systemId": 0,
  "systemName": "string",
  "useEntityRiskValues": true
}

Parameters

Name In Type Required Description
body body OnboardingDto true onboardingParams

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Response Schema

Onboard a customer using external ID/SYSTEM

Code samples

POST /localhost:8098/kyc-web-restful/onboarding/v1/onboardCustomer HTTP/1.1

Content-Type: application/json
Accept: */*

POST /onboarding/v1/onboardCustomer

Body parameter

{
  "customerId": 0,
  "customerRelationName": "string",
  "formId": 0,
  "items": {
    "booleanValue": true,
    "children": [
      {
        "booleanValue": true,
        "children": [
          {
            "booleanValue": null,
            "children": null,
            "doubleValue": null,
            "id": null,
            "intValue": null,
            "jsonNode": null,
            "key": null,
            "longValue": null,
            "stringValue": null,
            "type": null
          }
        ],
        "doubleValue": 0,
        "id": 0,
        "intValue": 0,
        "jsonNode": {},
        "key": "string",
        "longValue": 0,
        "stringValue": "string",
        "type": "string"
      }
    ],
    "doubleValue": 0,
    "id": 0,
    "intValue": 0,
    "jsonNode": {},
    "key": "string",
    "longValue": 0,
    "stringValue": "string",
    "type": "string"
  },
  "systemId": 0,
  "systemName": "string",
  "useEntityRiskValues": true
}

Parameters

Name In Type Required Description
body body OnboardingDto true customer payload

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Response Schema

Search and onboard a customer using external ID (a shortcut for search then onboard)

Code samples

POST /localhost:8098/kyc-web-restful/onboarding/v1/searchOnboardCustomer HTTP/1.1

Content-Type: application/json
Accept: */*

POST /onboarding/v1/searchOnboardCustomer

Perform search and risk calculation of the customer.

Body parameter

{
  "customerId": 0,
  "customerRelationName": "string",
  "formId": 0,
  "items": {
    "booleanValue": true,
    "children": [
      {
        "booleanValue": true,
        "children": [
          {
            "booleanValue": null,
            "children": null,
            "doubleValue": null,
            "id": null,
            "intValue": null,
            "jsonNode": null,
            "key": null,
            "longValue": null,
            "stringValue": null,
            "type": null
          }
        ],
        "doubleValue": 0,
        "id": 0,
        "intValue": 0,
        "jsonNode": {},
        "key": "string",
        "longValue": 0,
        "stringValue": "string",
        "type": "string"
      }
    ],
    "doubleValue": 0,
    "id": 0,
    "intValue": 0,
    "jsonNode": {},
    "key": "string",
    "longValue": 0,
    "stringValue": "string",
    "type": "string"
  },
  "relations": [
    {
      "customerId": 0,
      "customerRelationName": "string",
      "dueDate": "string",
      "formId": 0,
      "items": {
        "booleanValue": true,
        "children": [
          {
            "booleanValue": null,
            "children": null,
            "doubleValue": null,
            "id": null,
            "intValue": null,
            "jsonNode": null,
            "key": null,
            "longValue": null,
            "stringValue": null,
            "type": null
          }
        ],
        "doubleValue": 0,
        "id": 0,
        "intValue": 0,
        "jsonNode": {},
        "key": "string",
        "longValue": 0,
        "stringValue": "string",
        "type": "string"
      },
      "relationshipComment": "string",
      "relationshipId": 0,
      "systemId": 0,
      "systemName": "string",
      "useEntityRiskValues": true
    }
  ],
  "source": "BRANCH",
  "systemId": 0,
  "systemName": "string",
  "useEntityRiskValues": true
}

Parameters

Name In Type Required Description
body body OnboardingWithRelationsDto true customer payload

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK OnlineOnboardingResultDto
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Search

Search Controller

Get search decisions for a search query

Code samples

POST /localhost:8098/kyc-web-restful/search/getSearchDecision HTTP/1.1

Content-Type: application/json
Accept: application/json

POST /search/getSearchDecision

Body parameter

{
  "action": 0,
  "comment": "string",
  "person_id": 0,
  "search_query_id": 0
}

Parameters

Name In Type Required Description
body body ActionDto true actionDto

Example responses

200 Response

{
  "action": 0,
  "comment": "string",
  "person_id": 0,
  "search_query_id": 0
}

Responses

Status Meaning Description Schema
200 OK OK ActionDto
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Get search results for a search query

Code samples

GET /localhost:8098/kyc-web-restful/search/getsearchresult/{id} HTTP/1.1

Accept: application/json

GET /search/getsearchresult/{id}

Parameters

Name In Type Required Description
id path integer(int64) true id

Example responses

200 Response

{
  "comments": [
    {
      "content": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "id": 0,
      "user": {
        "amlHomePage": "string",
        "dataAdmin": true,
        "email": "string",
        "firstname": "string",
        "id": 0,
        "kycHomePage": "string",
        "lastname": "string",
        "newPassword": "string",
        "password": "string",
        "roles": [
          "string"
        ],
        "userType": "string"
      }
    }
  ],
  "customer_id": 0,
  "highRiskCitizenShip": true,
  "highRiskNationality": true,
  "maxScore": 0,
  "searchRsultItems": {},
  "search_query_id": 0
}

Responses

Status Meaning Description Schema
200 OK OK SearchResultDto
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Search a customer in PEP/SL lists (ENTITY)

Code samples

POST /localhost:8098/kyc-web-restful/search/searchEntityCustomer HTTP/1.1

Content-Type: application/json
Accept: application/json

POST /search/searchEntityCustomer

Body parameter

{
  "beginDate": "2019-08-24T14:15:22Z",
  "birthDate": "string",
  "birth_date": "string",
  "businessName": "string",
  "citizenship": "string",
  "clientCode": "string",
  "customerId": 0,
  "firstName": "string",
  "fuzziness": 0,
  "id": 0,
  "invertFirstAndLastName": true,
  "jobExecutionId": 0,
  "jobName": "string",
  "lastName": "string",
  "listName": "string",
  "listNames": [
    "string"
  ],
  "maidenName": "string",
  "nationality": "string",
  "searchQuerySource": "ONLINE",
  "systemId": 0,
  "systemName": "string",
  "wholeName": "string"
}

Parameters

Name In Type Required Description
body body SeachQueryDto true searchQueryDto

Example responses

200 Response

{
  "comments": [
    {
      "content": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "id": 0,
      "user": {
        "amlHomePage": "string",
        "dataAdmin": true,
        "email": "string",
        "firstname": "string",
        "id": 0,
        "kycHomePage": "string",
        "lastname": "string",
        "newPassword": "string",
        "password": "string",
        "roles": [
          "string"
        ],
        "userType": "string"
      }
    }
  ],
  "customer_id": 0,
  "highRiskCitizenShip": true,
  "highRiskNationality": true,
  "maxScore": 0,
  "searchRsultItems": {},
  "search_query_id": 0
}

Responses

Status Meaning Description Schema
200 OK OK SearchResultDto
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Search a customer in PEP/SL lists (PERSON)

Code samples

POST /localhost:8098/kyc-web-restful/search/searchPersonCustomer HTTP/1.1

Content-Type: application/json
Accept: application/json

POST /search/searchPersonCustomer

Body parameter

{
  "beginDate": "2019-08-24T14:15:22Z",
  "birthDate": "string",
  "birth_date": "string",
  "businessName": "string",
  "citizenship": "string",
  "clientCode": "string",
  "customerId": 0,
  "firstName": "string",
  "fuzziness": 0,
  "id": 0,
  "invertFirstAndLastName": true,
  "jobExecutionId": 0,
  "jobName": "string",
  "lastName": "string",
  "listName": "string",
  "listNames": [
    "string"
  ],
  "maidenName": "string",
  "nationality": "string",
  "searchQuerySource": "ONLINE",
  "systemId": 0,
  "systemName": "string",
  "wholeName": "string"
}

Parameters

Name In Type Required Description
body body SeachQueryDto true searchQueryDto

Example responses

200 Response

{
  "comments": [
    {
      "content": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "id": 0,
      "user": {
        "amlHomePage": "string",
        "dataAdmin": true,
        "email": "string",
        "firstname": "string",
        "id": 0,
        "kycHomePage": "string",
        "lastname": "string",
        "newPassword": "string",
        "password": "string",
        "roles": [
          "string"
        ],
        "userType": "string"
      }
    }
  ],
  "customer_id": 0,
  "highRiskCitizenShip": true,
  "highRiskNationality": true,
  "maxScore": 0,
  "searchRsultItems": {},
  "search_query_id": 0
}

Responses

Status Meaning Description Schema
200 OK OK SearchResultDto
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Search a customer in PEP/SL lists (VEHICULE/VESSEL)

Code samples

POST /localhost:8098/kyc-web-restful/search/searchVehicleCustomer HTTP/1.1

Content-Type: application/json
Accept: application/json

POST /search/searchVehicleCustomer

Body parameter

{
  "beginDate": "2019-08-24T14:15:22Z",
  "birthDate": "string",
  "birth_date": "string",
  "businessName": "string",
  "citizenship": "string",
  "clientCode": "string",
  "customerId": 0,
  "firstName": "string",
  "fuzziness": 0,
  "id": 0,
  "invertFirstAndLastName": true,
  "jobExecutionId": 0,
  "jobName": "string",
  "lastName": "string",
  "listName": "string",
  "listNames": [
    "string"
  ],
  "maidenName": "string",
  "nationality": "string",
  "searchQuerySource": "ONLINE",
  "systemId": 0,
  "systemName": "string",
  "wholeName": "string"
}

Parameters

Name In Type Required Description
body body SeachQueryDto true searchQueryDto

Example responses

200 Response

{
  "comments": [
    {
      "content": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "id": 0,
      "user": {
        "amlHomePage": "string",
        "dataAdmin": true,
        "email": "string",
        "firstname": "string",
        "id": 0,
        "kycHomePage": "string",
        "lastname": "string",
        "newPassword": "string",
        "password": "string",
        "roles": [
          "string"
        ],
        "userType": "string"
      }
    }
  ],
  "customer_id": 0,
  "highRiskCitizenShip": true,
  "highRiskNationality": true,
  "maxScore": 0,
  "searchRsultItems": {},
  "search_query_id": 0
}

Responses

Status Meaning Description Schema
200 OK OK SearchResultDto
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Update search decisions for a search query result

Code samples

POST /localhost:8098/kyc-web-restful/search/updateAction HTTP/1.1

Content-Type: application/json

POST /search/updateAction

Body parameter

{
  "action": 0,
  "comment": "string",
  "person_id": 0,
  "search_query_id": 0
}

Parameters

Name In Type Required Description
body body ActionDto true actionDto

Responses

Status Meaning Description Schema
200 OK OK None
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

TFS APIs

TFS Controller

Real-time financial transaction filtering

Code samples

POST /localhost:8098/kyc-web-restful/tfs/v1/scan HTTP/1.1

Content-Type: application/json
Accept: */*

POST /tfs/v1/scan

Body parameter

{
  "amount": {
    "balance": 0,
    "currencyIso": "AED"
  },
  "beneficiary": {
    "accountNumber": "string",
    "address": {
      "addressFree": "string",
      "countryCode": "AF"
    },
    "bank": {
      "code": "string",
      "country": "AF",
      "description": "string",
      "label": "string"
    },
    "bankIdentifierCode": "string",
    "birthDate": "string",
    "customerId": "string",
    "entityType": "string",
    "firstName": "string",
    "kycCustomerId": 0,
    "lastName": "string",
    "middleName": "string",
    "name": "string",
    "nationality": "AF",
    "system": "string",
    "wholeName": "string"
  },
  "code": "string",
  "intermediaryBank": {
    "code": "string",
    "country": "AF",
    "description": "string",
    "label": "string"
  },
  "narrativeText": "string",
  "orderingCustomer": {
    "accountNumber": "string",
    "address": {
      "addressFree": "string",
      "countryCode": "AF"
    },
    "bank": {
      "code": "string",
      "country": "AF",
      "description": "string",
      "label": "string"
    },
    "bankIdentifierCode": "string",
    "birthDate": "string",
    "customerId": "string",
    "entityType": "string",
    "firstName": "string",
    "kycCustomerId": 0,
    "lastName": "string",
    "middleName": "string",
    "name": "string",
    "nationality": "AF",
    "system": "string",
    "wholeName": "string"
  },
  "originalAmountCurrency": "AED",
  "receiverCorrespondentBank": {
    "code": "string",
    "country": "AF",
    "description": "string",
    "label": "string"
  },
  "reference": "string",
  "senderCorrespondentBank": {
    "code": "string",
    "country": "AF",
    "description": "string",
    "label": "string"
  },
  "valueDate": "string"
}

Parameters

Name In Type Required Description
body body TFSTransactionDto true tx

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK TFScanResult
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Reis real-time person filtering

Code samples

POST /localhost:8098/kyc-web-restful/tfs/v1/search HTTP/1.1

Content-Type: application/json
Accept: */*

POST /tfs/v1/search

Body parameter

{
  "accountNumber": "string",
  "address": {
    "addressFree": "string",
    "countryCode": "AF"
  },
  "bank": {
    "code": "string",
    "country": "AF",
    "description": "string",
    "label": "string"
  },
  "bankIdentifierCode": "string",
  "birthDate": "string",
  "customerId": "string",
  "entityType": "string",
  "firstName": "string",
  "kycCustomerId": 0,
  "lastName": "string",
  "middleName": "string",
  "name": "string",
  "nationality": "AF",
  "system": "string",
  "wholeName": "string"
}

Parameters

Name In Type Required Description
body body TFSPartyDto true customer

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK TFScanResult
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

TFS Audit trail

TFS History Controller

Get scan result detail

Code samples

GET /localhost:8098/kyc-web-restful/tfshistory/v1/getsearchdetail/{id} HTTP/1.1

Accept: */*

GET /tfshistory/v1/getsearchdetail/{id}

Parameters

Name In Type Required Description
id path integer(int64) true id

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK TFSSearchResultDetail
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

TFS Config

TFS Config Controller

Get current Reis TFS config

Code samples

GET /localhost:8098/kyc-web-restful/tfsconfig/v1/getconfig HTTP/1.1

Accept: */*

GET /tfsconfig/v1/getconfig

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK TFSConfigDto
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Get current Reis TFS rule configs

Code samples

GET /localhost:8098/kyc-web-restful/tfsconfig/v1/getruleconfig HTTP/1.1

Accept: */*

GET /tfsconfig/v1/getruleconfig

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK Inline
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [TFSRuleConfigDto] false none none
» TFSRuleConfigDto TFSRuleConfigDto false none none
»» id integer(int64) false none none
»» ruleId integer(int64) false none none
»» status string false none none
»» workflowName string false none none

Enumerated Values

Property Value
status CLEAN
status HOLD
status BLOCKED

Update current Reis TFS config

Code samples

POST /localhost:8098/kyc-web-restful/tfsconfig/v1/updateconfig HTTP/1.1

Content-Type: application/json
Accept: */*

POST /tfsconfig/v1/updateconfig

Body parameter

{
  "defaultMaxScore": 0,
  "scorePerList": {
    "property1": 0,
    "property2": 0
  },
  "searchFuzziness": 0
}

Parameters

Name In Type Required Description
body body TFSConfigDto true configDto

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK TFSConfigDto
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Update current Reis rule TFS config

Code samples

POST /localhost:8098/kyc-web-restful/tfsconfig/v1/updateruleconfig HTTP/1.1

Content-Type: application/json
Accept: */*

POST /tfsconfig/v1/updateruleconfig

Body parameter

{
  "id": 0,
  "ruleId": 0,
  "status": "CLEAN",
  "workflowName": "string"
}

Parameters

Name In Type Required Description
body body TFSRuleConfigDto true configDto

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK TFSRuleConfigDto
201 Created Created None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
404 Not Found Not Found None

Schemas

ActionDto

{
  "action": 0,
  "comment": "string",
  "person_id": 0,
  "search_query_id": 0
}

ActionDto

Properties

Name Type Required Restrictions Description
action integer(int32) false none none
comment string false none none
person_id integer(int64) false none none
search_query_id integer(int64) false none none

AmlAddressDto

{
  "addressFree": "string",
  "countryCode": "AF"
}

AmlAddressDto

Properties

Name Type Required Restrictions Description
addressFree string false none none
countryCode string false none none

Enumerated Values

Property Value
countryCode AF
countryCode AX
countryCode AL
countryCode DZ
countryCode AS
countryCode AD
countryCode AO
countryCode AI
countryCode AQ
countryCode AG
countryCode AR
countryCode AM
countryCode AW
countryCode AU
countryCode AT
countryCode AZ
countryCode BS
countryCode BH
countryCode BD
countryCode BB
countryCode BY
countryCode BE
countryCode BZ
countryCode BJ
countryCode BM
countryCode BT
countryCode BO
countryCode BQ
countryCode BA
countryCode BW
countryCode BV
countryCode BR
countryCode IO
countryCode BN
countryCode BG
countryCode BF
countryCode BI
countryCode KH
countryCode CM
countryCode CA
countryCode CV
countryCode KY
countryCode CF
countryCode TD
countryCode CL
countryCode CN
countryCode CX
countryCode CC
countryCode CO
countryCode KM
countryCode CG
countryCode CD
countryCode CK
countryCode CR
countryCode CI
countryCode HR
countryCode CU
countryCode CW
countryCode CY
countryCode CZ
countryCode DK
countryCode DJ
countryCode DM
countryCode DO
countryCode EC
countryCode EG
countryCode SV
countryCode GQ
countryCode ER
countryCode EE
countryCode ET
countryCode FK
countryCode FO
countryCode FJ
countryCode FI
countryCode FR
countryCode GF
countryCode PF
countryCode TF
countryCode GA
countryCode GM
countryCode GE
countryCode DE
countryCode GH
countryCode GI
countryCode GR
countryCode GL
countryCode GD
countryCode GP
countryCode GU
countryCode GT
countryCode GG
countryCode GN
countryCode GW
countryCode GY
countryCode HT
countryCode HM
countryCode VA
countryCode HN
countryCode HK
countryCode HU
countryCode IS
countryCode IN
countryCode ID
countryCode IR
countryCode IQ
countryCode IE
countryCode IM
countryCode IL
countryCode IT
countryCode JM
countryCode JP
countryCode JE
countryCode JO
countryCode KZ
countryCode KE
countryCode KI
countryCode XK
countryCode KP
countryCode KR
countryCode KW
countryCode KG
countryCode LA
countryCode LV
countryCode LB
countryCode LS
countryCode LR
countryCode LY
countryCode LI
countryCode LT
countryCode LU
countryCode MO
countryCode MK
countryCode MG
countryCode MW
countryCode MY
countryCode MV
countryCode ML
countryCode MT
countryCode MH
countryCode MQ
countryCode MR
countryCode MU
countryCode YT
countryCode MX
countryCode FM
countryCode MD
countryCode MC
countryCode MN
countryCode ME
countryCode MS
countryCode MA
countryCode MZ
countryCode MM
countryCode NA
countryCode NR
countryCode NP
countryCode NL
countryCode NC
countryCode NZ
countryCode NI
countryCode NE
countryCode NG
countryCode NU
countryCode NF
countryCode MP
countryCode NO
countryCode OM
countryCode PK
countryCode PW
countryCode PS
countryCode PA
countryCode PG
countryCode PY
countryCode PE
countryCode PH
countryCode PN
countryCode PL
countryCode PT
countryCode PR
countryCode QA
countryCode RE
countryCode RO
countryCode RU
countryCode RW
countryCode BL
countryCode SH
countryCode KN
countryCode LC
countryCode MF
countryCode PM
countryCode VC
countryCode WS
countryCode SM
countryCode ST
countryCode SA
countryCode SN
countryCode RS
countryCode SC
countryCode SL
countryCode SG
countryCode SX
countryCode SK
countryCode SI
countryCode SB
countryCode SO
countryCode ZA
countryCode GS
countryCode SS
countryCode ES
countryCode LK
countryCode SD
countryCode SR
countryCode SJ
countryCode SZ
countryCode SE
countryCode CH
countryCode SY
countryCode TW
countryCode TJ
countryCode TZ
countryCode TH
countryCode TL
countryCode TG
countryCode TK
countryCode TO
countryCode TT
countryCode TN
countryCode TR
countryCode TM
countryCode TC
countryCode TV
countryCode UG
countryCode UA
countryCode AE
countryCode GB
countryCode US
countryCode UM
countryCode UY
countryCode UZ
countryCode VU
countryCode VE
countryCode VN
countryCode VG
countryCode VI
countryCode WF
countryCode EH
countryCode YE
countryCode ZM
countryCode ZW

AmlBankDto

{
  "code": "string",
  "country": "AF",
  "description": "string",
  "label": "string"
}

AmlBankDto

Properties

Name Type Required Restrictions Description
code string false none none
country string false none none
description string false none none
label string false none none

Enumerated Values

Property Value
country AF
country AX
country AL
country DZ
country AS
country AD
country AO
country AI
country AQ
country AG
country AR
country AM
country AW
country AU
country AT
country AZ
country BS
country BH
country BD
country BB
country BY
country BE
country BZ
country BJ
country BM
country BT
country BO
country BQ
country BA
country BW
country BV
country BR
country IO
country BN
country BG
country BF
country BI
country KH
country CM
country CA
country CV
country KY
country CF
country TD
country CL
country CN
country CX
country CC
country CO
country KM
country CG
country CD
country CK
country CR
country CI
country HR
country CU
country CW
country CY
country CZ
country DK
country DJ
country DM
country DO
country EC
country EG
country SV
country GQ
country ER
country EE
country ET
country FK
country FO
country FJ
country FI
country FR
country GF
country PF
country TF
country GA
country GM
country GE
country DE
country GH
country GI
country GR
country GL
country GD
country GP
country GU
country GT
country GG
country GN
country GW
country GY
country HT
country HM
country VA
country HN
country HK
country HU
country IS
country IN
country ID
country IR
country IQ
country IE
country IM
country IL
country IT
country JM
country JP
country JE
country JO
country KZ
country KE
country KI
country XK
country KP
country KR
country KW
country KG
country LA
country LV
country LB
country LS
country LR
country LY
country LI
country LT
country LU
country MO
country MK
country MG
country MW
country MY
country MV
country ML
country MT
country MH
country MQ
country MR
country MU
country YT
country MX
country FM
country MD
country MC
country MN
country ME
country MS
country MA
country MZ
country MM
country NA
country NR
country NP
country NL
country NC
country NZ
country NI
country NE
country NG
country NU
country NF
country MP
country NO
country OM
country PK
country PW
country PS
country PA
country PG
country PY
country PE
country PH
country PN
country PL
country PT
country PR
country QA
country RE
country RO
country RU
country RW
country BL
country SH
country KN
country LC
country MF
country PM
country VC
country WS
country SM
country ST
country SA
country SN
country RS
country SC
country SL
country SG
country SX
country SK
country SI
country SB
country SO
country ZA
country GS
country SS
country ES
country LK
country SD
country SR
country SJ
country SZ
country SE
country CH
country SY
country TW
country TJ
country TZ
country TH
country TL
country TG
country TK
country TO
country TT
country TN
country TR
country TM
country TC
country TV
country UG
country UA
country AE
country GB
country US
country UM
country UY
country UZ
country VU
country VE
country VN
country VG
country VI
country WF
country EH
country YE
country ZM
country ZW

AmountDto

{
  "balance": 0,
  "currencyIso": "AED"
}

AmountDto

Properties

Name Type Required Restrictions Description
balance number false none none
currencyIso string false none none

Enumerated Values

Property Value
currencyIso AED
currencyIso AFN
currencyIso ALL
currencyIso AMD
currencyIso ANG
currencyIso AOA
currencyIso ARS
currencyIso AUD
currencyIso AWG
currencyIso AZN
currencyIso BAM
currencyIso BBD
currencyIso BDT
currencyIso BGN
currencyIso BHD
currencyIso BIF
currencyIso BMD
currencyIso BND
currencyIso BOB
currencyIso BOV
currencyIso BRL
currencyIso BSD
currencyIso BTN
currencyIso BWP
currencyIso BYR
currencyIso BZD
currencyIso CAD
currencyIso CDF
currencyIso CHE
currencyIso CHF
currencyIso CHW
currencyIso CLF
currencyIso CLP
currencyIso CNY
currencyIso COP
currencyIso COU
currencyIso CRC
currencyIso CUC
currencyIso CUP
currencyIso CVE
currencyIso CZK
currencyIso DJF
currencyIso DKK
currencyIso DOP
currencyIso DZD
currencyIso EGP
currencyIso ERN
currencyIso ETB
currencyIso EUR
currencyIso FJD
currencyIso FKP
currencyIso GBP
currencyIso GEL
currencyIso GHS
currencyIso GIP
currencyIso GMD
currencyIso GNF
currencyIso GTQ
currencyIso GYD
currencyIso HKD
currencyIso HNL
currencyIso HRK
currencyIso HTG
currencyIso HUF
currencyIso IDR
currencyIso ILS
currencyIso INR
currencyIso IQD
currencyIso IRR
currencyIso ISK
currencyIso JMD
currencyIso JOD
currencyIso JPY
currencyIso KES
currencyIso KGS
currencyIso KHR
currencyIso KMF
currencyIso KPW
currencyIso KRW
currencyIso KWD
currencyIso KYD
currencyIso KZT
currencyIso LAK
currencyIso LBP
currencyIso LKR
currencyIso LRD
currencyIso LSL
currencyIso LTL
currencyIso LVL
currencyIso LYD
currencyIso MAD
currencyIso MDL
currencyIso MGA
currencyIso MKD
currencyIso MMK
currencyIso MNT
currencyIso MOP
currencyIso MRO
currencyIso MUR
currencyIso MVR
currencyIso MWK
currencyIso MXN
currencyIso MXV
currencyIso MYR
currencyIso MZN
currencyIso NAD
currencyIso NGN
currencyIso NIO
currencyIso NOK
currencyIso NPR
currencyIso NZD
currencyIso OMR
currencyIso PAB
currencyIso PEN
currencyIso PGK
currencyIso PHP
currencyIso PKR
currencyIso PLN
currencyIso PYG
currencyIso QAR
currencyIso RON
currencyIso RSD
currencyIso RUB
currencyIso RWF
currencyIso SAR
currencyIso SBD
currencyIso SCR
currencyIso SDG
currencyIso SEK
currencyIso SGD
currencyIso SHP
currencyIso SLL
currencyIso SOS
currencyIso SRD
currencyIso SSP
currencyIso STD
currencyIso SVC
currencyIso SYP
currencyIso SZL
currencyIso THB
currencyIso TJS
currencyIso TMT
currencyIso TND
currencyIso TOP
currencyIso TRY
currencyIso TTD
currencyIso TWD
currencyIso TZS
currencyIso UAH
currencyIso UGX
currencyIso USD
currencyIso USN
currencyIso USS
currencyIso UYI
currencyIso UYU
currencyIso UZS
currencyIso VEF
currencyIso VND
currencyIso VUV
currencyIso WST
currencyIso XAF
currencyIso XAG
currencyIso XAU
currencyIso XBA
currencyIso XBB
currencyIso XBC
currencyIso XBD
currencyIso XCD
currencyIso XDR
currencyIso XFU
currencyIso XOF
currencyIso XPD
currencyIso XPF
currencyIso XPT
currencyIso XSU
currencyIso XUA
currencyIso XXX
currencyIso YER
currencyIso ZAR
currencyIso ZMW
currencyIso ZWL

AuthenticationInfoDto

{
  "agencyLocation": "string",
  "amlHomePage": "string",
  "dataAdmin": true,
  "display_name": "string",
  "distributionChannel": "string",
  "homePage": "string",
  "id": 0,
  "kycHomePage": "string",
  "priorite": 0,
  "roles": [
    "string"
  ],
  "token": "string",
  "userType": "string",
  "user_name": "string"
}

AuthenticationInfoDto

Properties

Name Type Required Restrictions Description
agencyLocation string false none none
amlHomePage string false none none
dataAdmin boolean false none none
display_name string false none none
distributionChannel string false none none
homePage string false none none
id integer(int64) false none none
kycHomePage string false none none
priorite integer(int32) false none none
roles [string] false none none
token string false none none
userType string false none none
user_name string false none none

BirthDateDto

{
  "birth_date": "string",
  "birth_id": 0,
  "exact_date": true,
  "interval_max_date": "string",
  "interval_min_date": "string"
}

BirthDateDto

Properties

Name Type Required Restrictions Description
birth_date string false none none
birth_id integer(int64) false none none
exact_date boolean false none none
interval_max_date string false none none
interval_min_date string false none none

CommentDto

{
  "content": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "id": 0,
  "user": {
    "amlHomePage": "string",
    "dataAdmin": true,
    "email": "string",
    "firstname": "string",
    "id": 0,
    "kycHomePage": "string",
    "lastname": "string",
    "newPassword": "string",
    "password": "string",
    "roles": [
      "string"
    ],
    "userType": "string"
  }
}

CommentDto

Properties

Name Type Required Restrictions Description
content string false none none
createdOn string(date-time) false none none
id integer(int64) false none none
user UserDto false none none

CustomerConnexionDto

{
  "comment": "string",
  "id": 0,
  "ownerCustomerId": 0,
  "ownerCustomerSysId": "string",
  "ownerSystemId": 0,
  "ownerSystemName": "string",
  "relatedCustomerId": 0,
  "relatedSystemId": 0,
  "relatedSystemName": "string",
  "relationBeginDate": "2019-08-24T14:15:22Z",
  "relationDueDate": "2019-08-24T14:15:22Z",
  "relationEndDate": "2019-08-24T14:15:22Z",
  "relationShipId": 0,
  "relationShipName": "string"
}

CustomerConnexionDto

Properties

Name Type Required Restrictions Description
comment string false none none
id integer(int64) false none none
ownerCustomerId integer(int64) false none none
ownerCustomerSysId string false none none
ownerSystemId integer(int64) false none none
ownerSystemName string false none none
relatedCustomerId integer(int64) false none none
relatedSystemId integer(int64) false none none
relatedSystemName string false none none
relationBeginDate string(date-time) false none none
relationDueDate string(date-time) false none none
relationEndDate string(date-time) false none none
relationShipId integer(int64) false none none
relationShipName string false none none

FormVariableDto

{
  "booleanValue": true,
  "children": [
    {
      "booleanValue": true,
      "children": [
        {
          "booleanValue": true,
          "children": [
            {}
          ],
          "doubleValue": 0,
          "id": 0,
          "intValue": 0,
          "jsonNode": {},
          "key": "string",
          "longValue": 0,
          "stringValue": "string",
          "type": "string"
        }
      ],
      "doubleValue": 0,
      "id": 0,
      "intValue": 0,
      "jsonNode": {},
      "key": "string",
      "longValue": 0,
      "stringValue": "string",
      "type": "string"
    }
  ],
  "doubleValue": 0,
  "id": 0,
  "intValue": 0,
  "jsonNode": {},
  "key": "string",
  "longValue": 0,
  "stringValue": "string",
  "type": "string"
}

FormVariableDto

Properties

Name Type Required Restrictions Description
booleanValue boolean false none none
children [FormVariableDto] false none none
doubleValue number(double) false none none
id integer(int64) false none none
intValue integer(int32) false none none
jsonNode JsonNode false none none
key string false none none
longValue integer(int64) false none none
stringValue string false none none
type string false none none

Enumerated Values

Property Value
type string
type integer
type double
type boolean
type array
type object
type long

Instruction

{
  "blocking": true,
  "createdOn": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": 0,
  "label": "string",
  "name": "string"
}

Instruction

Properties

Name Type Required Restrictions Description
blocking boolean false none none
createdOn string(date-time) false none none
description string false none none
id integer(int64) false none none
label string false none none
name string false none none

JsonNode

{}

JsonNode

Properties

None

LoginDto

{
  "password": "string",
  "user_name": "string"
}

LoginDto

Properties

Name Type Required Restrictions Description
password string false none none
user_name string false none none

NameDTO

{
  "first_name": "string",
  "last_name": "string",
  "name_id": 0,
  "original_script_name": "string",
  "whole_name": "string"
}

NameDTO

Properties

Name Type Required Restrictions Description
first_name string false none none
last_name string false none none
name_id integer(int64) false none none
original_script_name string false none none
whole_name string false none none

NationalityDto

{
  "country": "string",
  "nationality_id": 0
}

NationalityDto

Properties

Name Type Required Restrictions Description
country string false none none
nationality_id integer(int64) false none none

OnboardingDto

{
  "customerId": 0,
  "customerRelationName": "string",
  "formId": 0,
  "items": {
    "booleanValue": true,
    "children": [
      {
        "booleanValue": true,
        "children": [
          {
            "booleanValue": null,
            "children": null,
            "doubleValue": null,
            "id": null,
            "intValue": null,
            "jsonNode": null,
            "key": null,
            "longValue": null,
            "stringValue": null,
            "type": null
          }
        ],
        "doubleValue": 0,
        "id": 0,
        "intValue": 0,
        "jsonNode": {},
        "key": "string",
        "longValue": 0,
        "stringValue": "string",
        "type": "string"
      }
    ],
    "doubleValue": 0,
    "id": 0,
    "intValue": 0,
    "jsonNode": {},
    "key": "string",
    "longValue": 0,
    "stringValue": "string",
    "type": "string"
  },
  "systemId": 0,
  "systemName": "string",
  "useEntityRiskValues": true
}

OnboardingDto

Properties

Name Type Required Restrictions Description
customerId integer(int64) false none none
customerRelationName string false none none
formId integer(int64) false none none
items FormVariableDto false none none
systemId integer(int64) false none none
systemName string false none none
useEntityRiskValues boolean false none none

OnboardingRelationDto

{
  "customerId": 0,
  "customerRelationName": "string",
  "dueDate": "string",
  "formId": 0,
  "items": {
    "booleanValue": true,
    "children": [
      {
        "booleanValue": true,
        "children": [
          {
            "booleanValue": null,
            "children": null,
            "doubleValue": null,
            "id": null,
            "intValue": null,
            "jsonNode": null,
            "key": null,
            "longValue": null,
            "stringValue": null,
            "type": null
          }
        ],
        "doubleValue": 0,
        "id": 0,
        "intValue": 0,
        "jsonNode": {},
        "key": "string",
        "longValue": 0,
        "stringValue": "string",
        "type": "string"
      }
    ],
    "doubleValue": 0,
    "id": 0,
    "intValue": 0,
    "jsonNode": {},
    "key": "string",
    "longValue": 0,
    "stringValue": "string",
    "type": "string"
  },
  "relationshipComment": "string",
  "relationshipId": 0,
  "systemId": 0,
  "systemName": "string",
  "useEntityRiskValues": true
}

OnboardingRelationDto

Properties

Name Type Required Restrictions Description
customerId integer(int64) false none none
customerRelationName string false none none
dueDate string false none none
formId integer(int64) false none none
items FormVariableDto false none none
relationshipComment string false none none
relationshipId integer(int64) false none none
systemId integer(int64) false none none
systemName string false none none
useEntityRiskValues boolean false none none

OnboardingWithRelationsDto

{
  "customerId": 0,
  "customerRelationName": "string",
  "formId": 0,
  "items": {
    "booleanValue": true,
    "children": [
      {
        "booleanValue": true,
        "children": [
          {
            "booleanValue": null,
            "children": null,
            "doubleValue": null,
            "id": null,
            "intValue": null,
            "jsonNode": null,
            "key": null,
            "longValue": null,
            "stringValue": null,
            "type": null
          }
        ],
        "doubleValue": 0,
        "id": 0,
        "intValue": 0,
        "jsonNode": {},
        "key": "string",
        "longValue": 0,
        "stringValue": "string",
        "type": "string"
      }
    ],
    "doubleValue": 0,
    "id": 0,
    "intValue": 0,
    "jsonNode": {},
    "key": "string",
    "longValue": 0,
    "stringValue": "string",
    "type": "string"
  },
  "relations": [
    {
      "customerId": 0,
      "customerRelationName": "string",
      "dueDate": "string",
      "formId": 0,
      "items": {
        "booleanValue": true,
        "children": [
          {
            "booleanValue": null,
            "children": null,
            "doubleValue": null,
            "id": null,
            "intValue": null,
            "jsonNode": null,
            "key": null,
            "longValue": null,
            "stringValue": null,
            "type": null
          }
        ],
        "doubleValue": 0,
        "id": 0,
        "intValue": 0,
        "jsonNode": {},
        "key": "string",
        "longValue": 0,
        "stringValue": "string",
        "type": "string"
      },
      "relationshipComment": "string",
      "relationshipId": 0,
      "systemId": 0,
      "systemName": "string",
      "useEntityRiskValues": true
    }
  ],
  "source": "BRANCH",
  "systemId": 0,
  "systemName": "string",
  "useEntityRiskValues": true
}

OnboardingWithRelationsDto

Properties

Name Type Required Restrictions Description
customerId integer(int64) false none none
customerRelationName string false none none
formId integer(int64) false none none
items FormVariableDto false none none
relations [OnboardingRelationDto] false none none
source string false none none
systemId integer(int64) false none none
systemName string false none none
useEntityRiskValues boolean false none none

Enumerated Values

Property Value
source BRANCH
source ONLINE
source OTHER

OnlineOnboardingResultDto

{
  "errorMessage": "string",
  "instruction": {
    "blocking": true,
    "createdOn": "2019-08-24T14:15:22Z",
    "description": "string",
    "id": 0,
    "label": "string",
    "name": "string"
  },
  "reisId": 0,
  "riskCalculationId": 0,
  "status": "CLEAN"
}

OnlineOnboardingResultDto

Properties

Name Type Required Restrictions Description
errorMessage string false none none
instruction Instruction false none none
reisId integer(int64) false none none
riskCalculationId integer(int64) false none none
status string false none After screening and risk calculation; possible output are:
CLEAN: Bank Agent can proceed
HOLD : Bank Agent must continue on Reis KYC
PENDING : BANK Agent must wait for Compliance decision
REJECT : Customer is blacklisted, Bank Agent can't proceed any further

Enumerated Values

Property Value
status CLEAN
status HOLD
status PENDING
status REJECT

SeachQueryDto

{
  "beginDate": "2019-08-24T14:15:22Z",
  "birthDate": "string",
  "birth_date": "string",
  "businessName": "string",
  "citizenship": "string",
  "clientCode": "string",
  "customerId": 0,
  "firstName": "string",
  "fuzziness": 0,
  "id": 0,
  "invertFirstAndLastName": true,
  "jobExecutionId": 0,
  "jobName": "string",
  "lastName": "string",
  "listName": "string",
  "listNames": [
    "string"
  ],
  "maidenName": "string",
  "nationality": "string",
  "searchQuerySource": "ONLINE",
  "systemId": 0,
  "systemName": "string",
  "wholeName": "string"
}

SeachQueryDto

Properties

Name Type Required Restrictions Description
beginDate string(date-time) false none none
birthDate string false none none
birth_date string false none none
businessName string false none none
citizenship string false none none
clientCode string false none none
customerId integer(int64) false none none
firstName string false none none
fuzziness number(float) false none none
id integer(int64) false none none
invertFirstAndLastName boolean false none none
jobExecutionId integer(int64) false none none
jobName string false none none
lastName string false none none
listName string false none none
listNames [string] false none none
maidenName string false none none
nationality string false none none
searchQuerySource string false none none
systemId integer(int64) false none none
systemName string false none none
wholeName string false none none

Enumerated Values

Property Value
searchQuerySource ONLINE
searchQuerySource KYC
searchQuerySource AML
searchQuerySource BATCH
searchQuerySource TFS
searchQuerySource NONE

SearchResultDto

{
  "comments": [
    {
      "content": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "id": 0,
      "user": {
        "amlHomePage": "string",
        "dataAdmin": true,
        "email": "string",
        "firstname": "string",
        "id": 0,
        "kycHomePage": "string",
        "lastname": "string",
        "newPassword": "string",
        "password": "string",
        "roles": [
          "string"
        ],
        "userType": "string"
      }
    }
  ],
  "customer_id": 0,
  "highRiskCitizenShip": true,
  "highRiskNationality": true,
  "maxScore": 0,
  "searchRsultItems": {},
  "search_query_id": 0
}

SearchResultDto

Properties

Name Type Required Restrictions Description
comments [CommentDto] false none none
customer_id integer(int64) false none none
highRiskCitizenShip boolean false none none
highRiskNationality boolean false none none
maxScore number(float) false none none
searchRsultItems Iterable_SearchResultItemDto_ false none none
search_query_id integer(int64) false none none

SearchResultItemDto

{
  "action": 0,
  "birth_date": [
    {
      "birth_date": "string",
      "birth_id": 0,
      "exact_date": true,
      "interval_max_date": "string",
      "interval_min_date": "string"
    }
  ],
  "business_name": "string",
  "customListed": true,
  "deceased": "string",
  "gender": "string",
  "hasRiskedCountry": true,
  "id_inList": "string",
  "images": [
    "string"
  ],
  "isCustomListed": true,
  "isPEP": true,
  "isSanctionned": true,
  "list_name": "string",
  "msg": "string",
  "name": [
    {
      "first_name": "string",
      "last_name": "string",
      "name_id": 0,
      "original_script_name": "string",
      "whole_name": "string"
    }
  ],
  "nameType": "string",
  "nationality": [
    {
      "country": "string",
      "nationality_id": 0
    }
  ],
  "pep": true,
  "person_id": 0,
  "person_type": "string",
  "reject": true,
  "sanctionned": true,
  "score": 0,
  "sub_list_names": [
    "string"
  ],
  "sublists": [
    "string"
  ],
  "tags": [
    "string"
  ]
}

SearchResultItemDto

Properties

Name Type Required Restrictions Description
action integer(int32) false none none
birth_date [BirthDateDto] false none none
business_name string false none none
customListed boolean false none none
deceased string false none none
gender string false none none
hasRiskedCountry boolean false none none
id_inList string false none none
images [string] false none none
isCustomListed boolean false none none
isPEP boolean false none none
isSanctionned boolean false none none
list_name string false none none
msg string false none none
name [NameDTO] false none none
nameType string false none none
nationality [NationalityDto] false none none
pep boolean false none none
person_id integer(int64) false none none
person_type string false none none
reject boolean false none none
sanctionned boolean false none none
score number(float) false none none
sub_list_names [string] false none none
sublists [string] false none none
tags [string] false none none

TFSConfigDto

{
  "defaultMaxScore": 0,
  "scorePerList": {
    "property1": 0,
    "property2": 0
  },
  "searchFuzziness": 0
}

TFSConfigDto

Properties

Name Type Required Restrictions Description
defaultMaxScore number(float) false none none
scorePerList object false none none
» additionalProperties number(float) false none none
searchFuzziness number(float) false none none

TFSPartyDto

{
  "accountNumber": "string",
  "address": {
    "addressFree": "string",
    "countryCode": "AF"
  },
  "bank": {
    "code": "string",
    "country": "AF",
    "description": "string",
    "label": "string"
  },
  "bankIdentifierCode": "string",
  "birthDate": "string",
  "customerId": "string",
  "entityType": "string",
  "firstName": "string",
  "kycCustomerId": 0,
  "lastName": "string",
  "middleName": "string",
  "name": "string",
  "nationality": "AF",
  "system": "string",
  "wholeName": "string"
}

TFSPartyDto

Properties

Name Type Required Restrictions Description
accountNumber string false none none
address AmlAddressDto false none none
bank AmlBankDto false none none
bankIdentifierCode string false none none
birthDate string false none none
customerId string false none none
entityType string false none none
firstName string false none none
kycCustomerId integer(int64) false none none
lastName string false none none
middleName string false none none
name string false none none
nationality string false none none
system string false none none
wholeName string false none none

Enumerated Values

Property Value
nationality AF
nationality AX
nationality AL
nationality DZ
nationality AS
nationality AD
nationality AO
nationality AI
nationality AQ
nationality AG
nationality AR
nationality AM
nationality AW
nationality AU
nationality AT
nationality AZ
nationality BS
nationality BH
nationality BD
nationality BB
nationality BY
nationality BE
nationality BZ
nationality BJ
nationality BM
nationality BT
nationality BO
nationality BQ
nationality BA
nationality BW
nationality BV
nationality BR
nationality IO
nationality BN
nationality BG
nationality BF
nationality BI
nationality KH
nationality CM
nationality CA
nationality CV
nationality KY
nationality CF
nationality TD
nationality CL
nationality CN
nationality CX
nationality CC
nationality CO
nationality KM
nationality CG
nationality CD
nationality CK
nationality CR
nationality CI
nationality HR
nationality CU
nationality CW
nationality CY
nationality CZ
nationality DK
nationality DJ
nationality DM
nationality DO
nationality EC
nationality EG
nationality SV
nationality GQ
nationality ER
nationality EE
nationality ET
nationality FK
nationality FO
nationality FJ
nationality FI
nationality FR
nationality GF
nationality PF
nationality TF
nationality GA
nationality GM
nationality GE
nationality DE
nationality GH
nationality GI
nationality GR
nationality GL
nationality GD
nationality GP
nationality GU
nationality GT
nationality GG
nationality GN
nationality GW
nationality GY
nationality HT
nationality HM
nationality VA
nationality HN
nationality HK
nationality HU
nationality IS
nationality IN
nationality ID
nationality IR
nationality IQ
nationality IE
nationality IM
nationality IL
nationality IT
nationality JM
nationality JP
nationality JE
nationality JO
nationality KZ
nationality KE
nationality KI
nationality XK
nationality KP
nationality KR
nationality KW
nationality KG
nationality LA
nationality LV
nationality LB
nationality LS
nationality LR
nationality LY
nationality LI
nationality LT
nationality LU
nationality MO
nationality MK
nationality MG
nationality MW
nationality MY
nationality MV
nationality ML
nationality MT
nationality MH
nationality MQ
nationality MR
nationality MU
nationality YT
nationality MX
nationality FM
nationality MD
nationality MC
nationality MN
nationality ME
nationality MS
nationality MA
nationality MZ
nationality MM
nationality NA
nationality NR
nationality NP
nationality NL
nationality NC
nationality NZ
nationality NI
nationality NE
nationality NG
nationality NU
nationality NF
nationality MP
nationality NO
nationality OM
nationality PK
nationality PW
nationality PS
nationality PA
nationality PG
nationality PY
nationality PE
nationality PH
nationality PN
nationality PL
nationality PT
nationality PR
nationality QA
nationality RE
nationality RO
nationality RU
nationality RW
nationality BL
nationality SH
nationality KN
nationality LC
nationality MF
nationality PM
nationality VC
nationality WS
nationality SM
nationality ST
nationality SA
nationality SN
nationality RS
nationality SC
nationality SL
nationality SG
nationality SX
nationality SK
nationality SI
nationality SB
nationality SO
nationality ZA
nationality GS
nationality SS
nationality ES
nationality LK
nationality SD
nationality SR
nationality SJ
nationality SZ
nationality SE
nationality CH
nationality SY
nationality TW
nationality TJ
nationality TZ
nationality TH
nationality TL
nationality TG
nationality TK
nationality TO
nationality TT
nationality TN
nationality TR
nationality TM
nationality TC
nationality TV
nationality UG
nationality UA
nationality AE
nationality GB
nationality US
nationality UM
nationality UY
nationality UZ
nationality VU
nationality VE
nationality VN
nationality VG
nationality VI
nationality WF
nationality EH
nationality YE
nationality ZM
nationality ZW

TFSRuleConfigDto

{
  "id": 0,
  "ruleId": 0,
  "status": "CLEAN",
  "workflowName": "string"
}

TFSRuleConfigDto

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
ruleId integer(int64) false none none
status string false none none
workflowName string false none none

Enumerated Values

Property Value
status CLEAN
status HOLD
status BLOCKED

TFSScanResultDetail

{
  "beneficiaryCustomer": {
    "beginDate": "2019-08-24T14:15:22Z",
    "birthDate": "string",
    "birth_date": "string",
    "businessName": "string",
    "citizenship": "string",
    "clientCode": "string",
    "customerId": 0,
    "firstName": "string",
    "fuzziness": 0,
    "id": 0,
    "invertFirstAndLastName": true,
    "jobExecutionId": 0,
    "jobName": "string",
    "lastName": "string",
    "listName": "string",
    "listNames": [
      "string"
    ],
    "maidenName": "string",
    "nationality": "string",
    "searchQuerySource": "ONLINE",
    "systemId": 0,
    "systemName": "string",
    "wholeName": "string"
  },
  "customerQuery": {
    "beginDate": "2019-08-24T14:15:22Z",
    "birthDate": "string",
    "birth_date": "string",
    "businessName": "string",
    "citizenship": "string",
    "clientCode": "string",
    "customerId": 0,
    "firstName": "string",
    "fuzziness": 0,
    "id": 0,
    "invertFirstAndLastName": true,
    "jobExecutionId": 0,
    "jobName": "string",
    "lastName": "string",
    "listName": "string",
    "listNames": [
      "string"
    ],
    "maidenName": "string",
    "nationality": "string",
    "searchQuerySource": "ONLINE",
    "systemId": 0,
    "systemName": "string",
    "wholeName": "string"
  },
  "decision": "CLEAN",
  "handleDate": "2019-08-24T14:15:22Z",
  "listNames": [
    "string"
  ],
  "orderingCustomerQuery": {
    "beginDate": "2019-08-24T14:15:22Z",
    "birthDate": "string",
    "birth_date": "string",
    "businessName": "string",
    "citizenship": "string",
    "clientCode": "string",
    "customerId": 0,
    "firstName": "string",
    "fuzziness": 0,
    "id": 0,
    "invertFirstAndLastName": true,
    "jobExecutionId": 0,
    "jobName": "string",
    "lastName": "string",
    "listName": "string",
    "listNames": [
      "string"
    ],
    "maidenName": "string",
    "nationality": "string",
    "searchQuerySource": "ONLINE",
    "systemId": 0,
    "systemName": "string",
    "wholeName": "string"
  },
  "queryId": 0,
  "queryType": "string",
  "ruleId": 0,
  "ruleName": "string",
  "status": "CLEAN",
  "transaction": {
    "amount": {
      "balance": 0,
      "currencyIso": "AED"
    },
    "beneficiary": {
      "accountNumber": "string",
      "address": {
        "addressFree": "string",
        "countryCode": "AF"
      },
      "bank": {
        "code": "string",
        "country": "AF",
        "description": "string",
        "label": "string"
      },
      "bankIdentifierCode": "string",
      "birthDate": "string",
      "customerId": "string",
      "entityType": "string",
      "firstName": "string",
      "kycCustomerId": 0,
      "lastName": "string",
      "middleName": "string",
      "name": "string",
      "nationality": "AF",
      "system": "string",
      "wholeName": "string"
    },
    "code": "string",
    "intermediaryBank": {
      "code": "string",
      "country": "AF",
      "description": "string",
      "label": "string"
    },
    "narrativeText": "string",
    "orderingCustomer": {
      "accountNumber": "string",
      "address": {
        "addressFree": "string",
        "countryCode": "AF"
      },
      "bank": {
        "code": "string",
        "country": "AF",
        "description": "string",
        "label": "string"
      },
      "bankIdentifierCode": "string",
      "birthDate": "string",
      "customerId": "string",
      "entityType": "string",
      "firstName": "string",
      "kycCustomerId": 0,
      "lastName": "string",
      "middleName": "string",
      "name": "string",
      "nationality": "AF",
      "system": "string",
      "wholeName": "string"
    },
    "originalAmountCurrency": "AED",
    "receiverCorrespondentBank": {
      "code": "string",
      "country": "AF",
      "description": "string",
      "label": "string"
    },
    "reference": "string",
    "senderCorrespondentBank": {
      "code": "string",
      "country": "AF",
      "description": "string",
      "label": "string"
    },
    "valueDate": "string"
  }
}

TFSScanResultDetail

Properties

Name Type Required Restrictions Description
beneficiaryCustomer SeachQueryDto false none none
customerQuery SeachQueryDto false none none
decision string false none none
handleDate string(date-time) false none none
listNames [string] false none none
orderingCustomerQuery SeachQueryDto false none none
queryId integer(int64) false none none
queryType string false none none
ruleId integer(int64) false none none
ruleName string false none none
status string false none none
transaction TFSTransactionDto false none none

Enumerated Values

Property Value
decision CLEAN
decision HOLD
decision BLOCKED
status CLEAN
status HOLD
status BLOCKED

TFSSearchResultDetail

{
  "customerQuery": {
    "beginDate": "2019-08-24T14:15:22Z",
    "birthDate": "string",
    "birth_date": "string",
    "businessName": "string",
    "citizenship": "string",
    "clientCode": "string",
    "customerId": 0,
    "firstName": "string",
    "fuzziness": 0,
    "id": 0,
    "invertFirstAndLastName": true,
    "jobExecutionId": 0,
    "jobName": "string",
    "lastName": "string",
    "listName": "string",
    "listNames": [
      "string"
    ],
    "maidenName": "string",
    "nationality": "string",
    "searchQuerySource": "ONLINE",
    "systemId": 0,
    "systemName": "string",
    "wholeName": "string"
  },
  "decision": "CLEAN",
  "handleDate": "2019-08-24T14:15:22Z",
  "listNames": [
    "string"
  ],
  "queryId": 0,
  "queryType": "string",
  "ruleId": 0,
  "ruleName": "string",
  "status": "CLEAN"
}

TFSSearchResultDetail

Properties

Name Type Required Restrictions Description
customerQuery SeachQueryDto false none none
decision string false none none
handleDate string(date-time) false none none
listNames [string] false none none
queryId integer(int64) false none none
queryType string false none none
ruleId integer(int64) false none none
ruleName string false none none
status string false none none

Enumerated Values

Property Value
decision CLEAN
decision HOLD
decision BLOCKED
status CLEAN
status HOLD
status BLOCKED

TFSTransactionDto

{
  "amount": {
    "balance": 0,
    "currencyIso": "AED"
  },
  "beneficiary": {
    "accountNumber": "string",
    "address": {
      "addressFree": "string",
      "countryCode": "AF"
    },
    "bank": {
      "code": "string",
      "country": "AF",
      "description": "string",
      "label": "string"
    },
    "bankIdentifierCode": "string",
    "birthDate": "string",
    "customerId": "string",
    "entityType": "string",
    "firstName": "string",
    "kycCustomerId": 0,
    "lastName": "string",
    "middleName": "string",
    "name": "string",
    "nationality": "AF",
    "system": "string",
    "wholeName": "string"
  },
  "code": "string",
  "intermediaryBank": {
    "code": "string",
    "country": "AF",
    "description": "string",
    "label": "string"
  },
  "narrativeText": "string",
  "orderingCustomer": {
    "accountNumber": "string",
    "address": {
      "addressFree": "string",
      "countryCode": "AF"
    },
    "bank": {
      "code": "string",
      "country": "AF",
      "description": "string",
      "label": "string"
    },
    "bankIdentifierCode": "string",
    "birthDate": "string",
    "customerId": "string",
    "entityType": "string",
    "firstName": "string",
    "kycCustomerId": 0,
    "lastName": "string",
    "middleName": "string",
    "name": "string",
    "nationality": "AF",
    "system": "string",
    "wholeName": "string"
  },
  "originalAmountCurrency": "AED",
  "receiverCorrespondentBank": {
    "code": "string",
    "country": "AF",
    "description": "string",
    "label": "string"
  },
  "reference": "string",
  "senderCorrespondentBank": {
    "code": "string",
    "country": "AF",
    "description": "string",
    "label": "string"
  },
  "valueDate": "string"
}

TFSTransactionDto

Properties

Name Type Required Restrictions Description
amount AmountDto false none none
beneficiary TFSPartyDto false none none
code string false none none
intermediaryBank AmlBankDto false none none
narrativeText string false none none
orderingCustomer TFSPartyDto false none none
originalAmountCurrency string false none none
receiverCorrespondentBank AmlBankDto false none none
reference string false none none
senderCorrespondentBank AmlBankDto false none none
valueDate string false none none

Enumerated Values

Property Value
originalAmountCurrency AED
originalAmountCurrency AFN
originalAmountCurrency ALL
originalAmountCurrency AMD
originalAmountCurrency ANG
originalAmountCurrency AOA
originalAmountCurrency ARS
originalAmountCurrency AUD
originalAmountCurrency AWG
originalAmountCurrency AZN
originalAmountCurrency BAM
originalAmountCurrency BBD
originalAmountCurrency BDT
originalAmountCurrency BGN
originalAmountCurrency BHD
originalAmountCurrency BIF
originalAmountCurrency BMD
originalAmountCurrency BND
originalAmountCurrency BOB
originalAmountCurrency BOV
originalAmountCurrency BRL
originalAmountCurrency BSD
originalAmountCurrency BTN
originalAmountCurrency BWP
originalAmountCurrency BYR
originalAmountCurrency BZD
originalAmountCurrency CAD
originalAmountCurrency CDF
originalAmountCurrency CHE
originalAmountCurrency CHF
originalAmountCurrency CHW
originalAmountCurrency CLF
originalAmountCurrency CLP
originalAmountCurrency CNY
originalAmountCurrency COP
originalAmountCurrency COU
originalAmountCurrency CRC
originalAmountCurrency CUC
originalAmountCurrency CUP
originalAmountCurrency CVE
originalAmountCurrency CZK
originalAmountCurrency DJF
originalAmountCurrency DKK
originalAmountCurrency DOP
originalAmountCurrency DZD
originalAmountCurrency EGP
originalAmountCurrency ERN
originalAmountCurrency ETB
originalAmountCurrency EUR
originalAmountCurrency FJD
originalAmountCurrency FKP
originalAmountCurrency GBP
originalAmountCurrency GEL
originalAmountCurrency GHS
originalAmountCurrency GIP
originalAmountCurrency GMD
originalAmountCurrency GNF
originalAmountCurrency GTQ
originalAmountCurrency GYD
originalAmountCurrency HKD
originalAmountCurrency HNL
originalAmountCurrency HRK
originalAmountCurrency HTG
originalAmountCurrency HUF
originalAmountCurrency IDR
originalAmountCurrency ILS
originalAmountCurrency INR
originalAmountCurrency IQD
originalAmountCurrency IRR
originalAmountCurrency ISK
originalAmountCurrency JMD
originalAmountCurrency JOD
originalAmountCurrency JPY
originalAmountCurrency KES
originalAmountCurrency KGS
originalAmountCurrency KHR
originalAmountCurrency KMF
originalAmountCurrency KPW
originalAmountCurrency KRW
originalAmountCurrency KWD
originalAmountCurrency KYD
originalAmountCurrency KZT
originalAmountCurrency LAK
originalAmountCurrency LBP
originalAmountCurrency LKR
originalAmountCurrency LRD
originalAmountCurrency LSL
originalAmountCurrency LTL
originalAmountCurrency LVL
originalAmountCurrency LYD
originalAmountCurrency MAD
originalAmountCurrency MDL
originalAmountCurrency MGA
originalAmountCurrency MKD
originalAmountCurrency MMK
originalAmountCurrency MNT
originalAmountCurrency MOP
originalAmountCurrency MRO
originalAmountCurrency MUR
originalAmountCurrency MVR
originalAmountCurrency MWK
originalAmountCurrency MXN
originalAmountCurrency MXV
originalAmountCurrency MYR
originalAmountCurrency MZN
originalAmountCurrency NAD
originalAmountCurrency NGN
originalAmountCurrency NIO
originalAmountCurrency NOK
originalAmountCurrency NPR
originalAmountCurrency NZD
originalAmountCurrency OMR
originalAmountCurrency PAB
originalAmountCurrency PEN
originalAmountCurrency PGK
originalAmountCurrency PHP
originalAmountCurrency PKR
originalAmountCurrency PLN
originalAmountCurrency PYG
originalAmountCurrency QAR
originalAmountCurrency RON
originalAmountCurrency RSD
originalAmountCurrency RUB
originalAmountCurrency RWF
originalAmountCurrency SAR
originalAmountCurrency SBD
originalAmountCurrency SCR
originalAmountCurrency SDG
originalAmountCurrency SEK
originalAmountCurrency SGD
originalAmountCurrency SHP
originalAmountCurrency SLL
originalAmountCurrency SOS
originalAmountCurrency SRD
originalAmountCurrency SSP
originalAmountCurrency STD
originalAmountCurrency SVC
originalAmountCurrency SYP
originalAmountCurrency SZL
originalAmountCurrency THB
originalAmountCurrency TJS
originalAmountCurrency TMT
originalAmountCurrency TND
originalAmountCurrency TOP
originalAmountCurrency TRY
originalAmountCurrency TTD
originalAmountCurrency TWD
originalAmountCurrency TZS
originalAmountCurrency UAH
originalAmountCurrency UGX
originalAmountCurrency USD
originalAmountCurrency USN
originalAmountCurrency USS
originalAmountCurrency UYI
originalAmountCurrency UYU
originalAmountCurrency UZS
originalAmountCurrency VEF
originalAmountCurrency VND
originalAmountCurrency VUV
originalAmountCurrency WST
originalAmountCurrency XAF
originalAmountCurrency XAG
originalAmountCurrency XAU
originalAmountCurrency XBA
originalAmountCurrency XBB
originalAmountCurrency XBC
originalAmountCurrency XBD
originalAmountCurrency XCD
originalAmountCurrency XDR
originalAmountCurrency XFU
originalAmountCurrency XOF
originalAmountCurrency XPD
originalAmountCurrency XPF
originalAmountCurrency XPT
originalAmountCurrency XSU
originalAmountCurrency XUA
originalAmountCurrency XXX
originalAmountCurrency YER
originalAmountCurrency ZAR
originalAmountCurrency ZMW
originalAmountCurrency ZWL

TFScanResult

{
  "id": 0,
  "status": "CLEAN"
}

TFScanResult

Properties

Name Type Required Restrictions Description
id integer(int64) false none none
status string false none none

Enumerated Values

Property Value
status CLEAN
status HOLD
status BLOCKED

UserDto

{
  "amlHomePage": "string",
  "dataAdmin": true,
  "email": "string",
  "firstname": "string",
  "id": 0,
  "kycHomePage": "string",
  "lastname": "string",
  "newPassword": "string",
  "password": "string",
  "roles": [
    "string"
  ],
  "userType": "string"
}

UserDto

Properties

Name Type Required Restrictions Description
amlHomePage string false none none
dataAdmin boolean false none none
email string false none none
firstname string false none none
id integer(int64) false none none
kycHomePage string false none none
lastname string false none none
newPassword string false none none
password string false none none
roles [string] false none none
userType string false none none

Iterable_SearchResultItemDto_

{}

Iterable«SearchResultItemDto»

Properties

None