Thursday, February 22, 2024

Welcome to KYC360 APIX

Eliminating Financial Crime Through Smart Technology

KYC360 APIX is used to enable integration between your KYC360 subscription and your existing business systems, 3rd party services or a custom interface you have created.

What is an API?

API is short for Application Programming Interface and it allows for one application to talk to another.

How to obtain your KYC360 API Key?

In order to gain access to KYC360 APIX, you will need to first obtain your API Key. The API Key can be thought of as your password to your KYC360 subscription. Your API Key is provided to you in your ‘welcome pack’ once you have applied for an API subscription with us. You will need to use this key in the header of each request made while using KYC360 APIX.

Subscriptions

There are 4 API subscription levels available to suit your business’s specific screening & risk governance requirements.

Subscription Levels Data Client Onboarding Interactive
Screening
Static
Search X - - - -
Essential Batch X X - - X
Interactive Batch X X - X X
Interactive Batch + Onboarding X X X X X

Search

Provides you with access to the Data methods of the API. Data methods allow you to search the Dow Jones dataset using our technology including features such as country and year filtering and control the data you require to be returned. This subscription is typically used for one off searches of the dataset.

Essential Batch

Provides you with access to the Client and Static methods of the API (does not include access to interactive screening options). Client methods allow you to add your customers into your KYC360 subscription and work the resultant match potentials. Customers added to your subscription are automatically screened daily, usually at 6pm BST unless otherwise notified. Match Potential data generated from the screening process can then be accessed and worked. This subscription is typically used for ongoing client screening.

Interactive Batch

Provides you with access to the Client and Static methods of the API including access to interactive screening options. Interactive Batch allows you to screen customers in real time without having to wait for the daily batch run to occur. This subscription is typically used for customer onboarding and ongoing client screening.

Interactive Batch + Onboarding

Provides you with access to the Client Onboarding methods for onboarding prospects starting from Data collection, Identity verification, Screening and eventually onboarding them as customers after compliance approval. This subscription can be used to manage your entire Onboarding workflow, document and data collection requirements.

Terminology

APIX provides you with the functionality of KYC360 platform. The available functionality is split into four sections being Client, Static, Data and Reporting. Each section is described below:

  • Client relates to your customer data and any Match data that results from screening it.
  • Static relates to system Static data such as Country lists, Gender classifications, etc.
  • Data relates to the Data set that your information is screened against.
  • Reporting relates to report methods within each of the above sections. (coming soon...)

Terminology used within KYC360 is detailed in the table below:

Terminology Explanation
ActionDays The number of days taken to action a Match Potential record to either a Discount or Flag result. Action Days is the number of days between the Generated Date and Matched Date.
API-Key Your private key that must be provided in each and every call made to the API.
AVM Adverse Media (Entity records only.)
ClientEntity A Client Entity is effectively your customer record. Your customer "Fred Smith" would be a Client Entity record within KYC360.
ClientEntityID Client Entity Identifiers are unique internal identifiers to KYC360 that identify each and every Client Entity.
Criteria Criteria is a term used within KYC360 for a set of parameters that are used while screening. The Criteria dictates how a search is to be performed and is set on a Client Entity basis. You may choose to setup multiple Criteria and assign them to different groups of Client Entities. KYC360 has two Criteria setup by default, Person and Entity.
EntityID Is the unique identifier used for Entities within the Data section. Each search result in the Data set being screened against has a unique EntityID as the data is profiled. However, when multiple matches occur on Primary Name and Alias records the Serial number should be taken into account.
ExternalReference Is a synonym for InterfaceReference.
InteractiveScreen Interactive screening allows you to screen your customer instantly with the resultant Match Potentials being generated. All active Client Entity records are screened daily but this process usually occurs overnight. If you need to screen immediately without waiting until the following day then you should use Interactive Screening.
InterfaceReference Interface References are your unique identifiers that uniquely identify your customers. Each Client Entity can be attributed with a single Interface Reference. You can use API methods based on either the internal or external references.
InternalReference Is a synonym for ClientEntityID.
MatchDiscount Match Discount records are generated as a result of Discounting a Match Potential as a false positive. These records allow KYC360 to remember actions taken and not serve them up again in subsequent screening runs.
MatchFlag Match Flag records are generated as a result of Flagging a Match Potential as a true hit. These records allow KYC360 to remember actions taken and not serve them up again in subsequent screening runs.
MatchPotential When screening a customer Match Potential records are generated for each potential match that falls within the Criteria used for the search. Match Potential records can be actioned turning them into Match Discount or Flag records.
MatchPotentialSummary Match Potential Summary records provide you with a summary for each Client Entity that has outstanding Match Potentials including the overall volume of potentials along with classification volumes.
MetaBump Meta Bumps are defined within Criteria records and assign different numeric values to Match Potential records dependant on Meta Data matches.
MetaData Meta Data means the ancillary data used outside of the standard name data. Your customers Date and Country information is the searches meta data.
NotifyChange Notify Change is a process that results from daily Data set updates. These records are generated for any Data Entity records affected by a change that you have Discounted or Flagged.
PEP Politically Exposed Person (Person records only)
Priority When using Risk classifications you can define a Priority value for each classification. This is assigned to Match Potential records enabling you to sort your results so that higher priority records can be dealt with first.
RCA Relative or Close Associate (Person records only)
Risk Static Risk categories are assigned to your Client Entity records to enable you to group your data set into different categories relating to Risk.
SAN Sanctioned
WBL Watch or Black Listed
UNK Unclassified