Search
Introduction
Customer Feedback
Quick Start
Environments
Resources
Versioning and Changes
Access
Authentication
post
Authenticate
User Administration
get
Subscription Details
get
List of Active Users
get
Logged In User Details
Credit and Risk
Companies
get
Languages Available For Company Reports For Selected Country
get
Company Search Criteria
get
Company Search
get
Company Credit Report
get
Confidence Match Search
People/Directors
get
People/Director Search Criteria
get
Director Search
get
Director Report
GB Consumers and AML
post
Submits a GB Consumer or AML Search
put
Resolves a picklist against a given UniqueId
get
Retrieves a prior identitysearch's input
get
Retrieves a prior identitysearch result.
get
Gets identitysearch Reasons.
get
Gets a list of identitysearch history items
put
Sets the reference for an existing history item
put
Revalidate a given identitysearch with additional documents
Images
get
Company Image Documents
get
Image Document Category Types
get
Company Image
Fresh Investigations
post
Create Fresh Investigation
get
Get Fresh Investigations
get
Retrieve FreshInvestigation Order
del
Delete Fresh Investigations
patch
Update FreshInvestigation Report Content
post
Upload attachments for fresh investigation orderId
get
Get attachments for the given fresh investigation orderId
get
Get attachment for the given fresh investigation attachment Id
post
Comments for fresh investigation orderId
get
Retrieve comments of specified FreshInvestigation Report
get
Retrieve FreshInvestigation Report Content
Global monitoring
Global Monitoring Introduction
GM User Details
get
Monitoring User Details
GM Create and View All Portfolios
get
List All Portfolios
post
Create Monitoring Portfolio
GM Importing Portfolios
post
Import A Portfolio File
post
Sync A Portfolio File
GM User Management of Portfolios
get
Retrieve Portfolio By Id
del
Delete Portfolio
patch
Update Portfolio Details
post
Copy Companies Between Portfolios
post
Move Companies Between Portfolios
get
Portfolio User Permissions
patch
Share Portfolio With Users
GM Individual Portfolio Management
get
List Countries of Monitored Companies
get
List Companies In A Portfolio
post
Add Company To Portfolio
patch
Clear Companies From Portfolio
get
Get Company Details From A Portfolio
del
Delete Company From Portfolio
patch
Update Company Details In Portfolio
get
List Portfolio Event Rules
get
List Portfolio Event Rules By Country
put
Update EventRules
put
Set Portfolio Default Rules
get
Portfolio Risk Summary
get
List Portfolio Notifications
get
List Company Specific NotificationEvents
GM Event Rules and Notifications
get
List Company Events
get
All EventRules
get
Filtered EventRules
get
All Notification Events
Check and Decide
Decision Engine Introduction
Instance Management
get
Return All Available Instances
get
Instance Configuration
put
Update Instance Configuration
Decision Trees
get
Decision Trees
get
User Data Fields
Decision Logs
get
Decision History
get
Get Decision Log
patch
Update Decision Log
Run Decision
post
Run Decision Tree
Decision Outcome
get
Return Decision Outcome
patch
Update Decision Outcome
Compliance
Protect Introduction
Protect Audit
get
Retrieve Protect Audit Log
post
Export Audit Log File
Protect IDV
post
IDV Search
get
Returns IDV Report
Local Solutions
LS Introduction
Bank Match
get
Bank Match
Bank Verification
post
Single Request
post
Validate Bank Verification Request
get
Returns Request History By ID
patch
Update CustomerReference by HistoryId
get
Requests Search History
Land Registry
get
GB Land Registry
Finance Agreements
get
Finance Agreements
US Search Support
post
US Fresh Investigation Request
FR Bank Match
get
Bank Match
get
Bank Match Status
NL KVK
get
Return NL Extract
Data cleaning
DC Introduction
DC Create and View All Jobs
post
Create Job Request
get
Returns all Data Cleaning Jobs
DC Individual Job Management
get
Returns Job by {id} number
post
Upload a Job File with an {id}
put
Update Mappings Request
post
Submit Job Request
put
Update Enrichments Request
post
Start Enrichment Request
get
Returns Enriched Job File
post
Archive Job by id
KYC Protect
KYC Introduction
KYC Administrator Resources
get
Return Profile Types
get
Returns Accepted Currency Codes
get
Return Accepted Country Codes
get
Return Profile Document Types
KYC Audit
get
Return Audit Trail
KYC Profile Management
post
Create Profile From Company Report
post
Create Profile
get
Return Created Profiles
del
Delete All Profiles
get
Return Profile By Profile Id
del
Delete Profile By Profile Id
put
Assign Profile To User
put
Assigns A List Of Profiles To User
KYC Profile Updates
put
Update Profile By Profile Id
post
Create Profile Note
get
Return Profile Notes
get
Return Profile Notes By Note Id
put
Update Profile Note By Note Id
del
Deletes Profile Note By Note Id
post
Add An Attachment To The Given Profile
get
Return List Of Attachments On The Given Profile
get
Return A Profile Attachment By Profile And Attachment Id
put
Update Profile Attachment By Profile And Attachment Id
del
Delete Attachment By Profile And Attachment Id
get
Download Profile Attachment By Profile And Attachment Id
KYC Profile Key Parties
post
Creates A Key Party Folder Linked To The Profile Id
get
Return All Key Party Records Linked To A Profile
put
Update A Batch Of Key Parties
del
Delete a batch of key parties
get
Return All Key Party Searches
del
Deletes A Batch Of Key Party Searches
post
Request Multiple Searches Linked To A Key Party Asynchronously
post
Links Searches To Key Parties
put
Updates The Key Party By Profile Id and Key Party Id
del
Deletes a Key PArty By Key Party Id
KYC Batch Uploads
get
Return Template For Batch Upload
post
Request Batch Upload
get
Return A List Of Requested Uploads
get
Return Batch Upload File Details
get
Download Batch Upload Error File
put
Retry Previous Upload
KYC Profile Business / Individual Details
get
Return Profile Details
put
Update Profile Details
post
Creates An Address For Profile
get
Return Lists Of Addresses
get
Return Profile Address Details By Profile And Address Id
put
Update Profile Address Details By Profile Id And Address Id
del
Delete Profile Address Details By Profile Id And Address Id
KYC AML Screening - Profile Management
get
Return List Of AML Searches On The Given Profile
del
Deletes AML searches linked to a profile
post
Adds AML Searches To The Given Profile
get
Return All Schedules By ProfileId And Modified Date
get
Return Schedule By ProfileId And ScheduleId
get
Return All Hits Linked To The Profile
get
Return All Hits Of Searches Linked To A Profile
get
Alert Metrics
KYC AML Screening - Businesses
post
Performs An AML Search For A Business And Saves The Results To The Database
get
Returns Business AML Searches
put
Update Business AML Searches
get
Return Business AML Search By Search Id
put
Update A Business AML Search By Search Id
get
Return Business AML Search Hits
put
Update Batch Of Business AML Search Hits
get
Return Full AML Search Hit Information By SearchId And HitId
put
Update A Single Business Hit
get
Download AML Details for a Hit
post
Download A PDF File For A Business AML Screening
post
Download PDF Business Search Report
KYC AML Screening - Individuals
post
Performs An AML Search For An Individual And Saves The Results To The Database
get
Returns Individual AML Searches
put
Update Individual AML Searches
get
Return Individual AML Search By Search Id
put
Updates An Individual AML Search By SearchID
get
Returns Individual AML Search Hits
put
Updates A Batch Of individual AML search Hits
get
Return Full AML Search Hit Information By SearchId And HitId
put
Update A Single Individual Hit
get
Download AML Details for a Hit
post
Download A PDF File For An Individual AML Screening
post
Download PDF Business Search Report
KYC AML Bulk Screening
post
Perform Bulk AML Screening
KYC AML Monitoring Management
post
Add Search To AML Monitoring
get
Return All Ordered Schedules
del
Delete Searches From AML Monitoring
put
Update Schedules
get
Returns A Schedule
del
Delete A Search From AML Monitoring
put
Update A Schedule In Monitoring
get
Return All Hits For A Schedule By Created Date
KYC Async AML
get
Return All Async AML Jobs
get
Return Async AML Jobs By Id
get
Return Async Job Criteria By Id
KYC Global Monitoring
get
Returns Available Country Codes
post
Add Profiles To Monitoring
del
Delete Profiles From Monitoring
get
Return List Of Alerts By Profile
get
Return Alert By Alert Id And ProfileId
put
Update Status of Alert By Profile Id And Alert Id
KYC Reporting
get
Retrieve Report Criteria
post
Create AML / Audit Report
get
Returns Report By Type
get
Retrieve a Single Report by ID
get
Download a Report by ID
Consumers and Misc
Consumers
get
Consumer Report
get
Consumer Search Criteria
Misc
get
Report Schema
get
Custom Report Parameters
Change Log
Change Log
Return Accepted Country Codes
Returns the list of accepted country-codes.
Security
bearerToken
Responses
200
400
401
403
get
/compliance/kyc-protect/lookup/countryCodes
Request samples
curl
JavaScript
Python
C#
Java
PHP
Ruby
2 more
PHP
Ruby
2 more
Copy
Response samples
200
400
401
403
application/json
Copy
[
"GB"
]
➔ Next to
Return Profile Document Types