The API provides, among other features:
- The ability to screen entity names, with or without secondary fields such as date of birth for individuals. These names are called “cases” within the World-Check One system.
- The ability to retrieve the results of the screening process from the World-Check database.
- The ability to flag cases for Ongoing Screening, and retrieve the World-Check results from the Ongoing Screening process.
- The ability to upload internal and third-party lists to screen against on the World-Check One platform using Watchlist Screening.
- The ability to use either synchronous or asynchronous screening API requests.
The World-Check One API is delivered as a REST/JSON web service, accessible exclusively over HTTPS. An API schema is available that describes all features and data used within the API. This schema is in Swagger 2.0 format (also known as the OpenAPI specification format), so developers integrating with the World-Check One API can benefit from the many supporting tools, documentation, and resources available within the Swagger/OpenAPI ecosystem.
The World-Check One API will be updated over time as new functionality is added to the overall World-Check One platform. To accommodate this change, the API is fully versioned, and wherever possible existing API methods will be added to newer versions of the API with a goal of backward compatibility. To accommodate these version updates, all that a developer should need to do is update the version of the API being integrated within their configuration management database. Integration code will only need to be modified if there are new features made available in a more recent version of the API that would like to take advantage of.
Message authentication is managed via API keys and HMAC-based message signatures. Every API request needs a message signature in order for it to be processed. Credentials-based authentication or session management is not required when using the World-Check One API. A throttling policy is enforced on all API requests to ensure a positive experience for all World-Check One users. The total volume of transactions is capped by the chosen client subscription volume(s).
Below is a diagram illustrating a high-level sample interaction between your internal system and the World-Check One API.
As the World-Check One API is a commercial offering, access to it needs to be enabled via product licensing within the World-Check One administration interface before integration can complete.
As a developer, you have full access to the World-Check One API developer portal resources, as well as access to the World-Check One API integration environment (the “pilot” environment), which you can use to verify your integration in a pre-production setting without the risk of affecting production data. Once the integration has passed your UAT criteria, it can be progressed to the World-Check One API production environment for real-world use. The only change required to promote to the production environment is updating the API base URL within your configuration database.
For more information send us a sales enquiry at https://www.refinitiv.com/en/contact-us
Read more about our products at https://www.refinitiv.com/
Find out how to contact your local office https://www.refinitiv.com/en/locations
To contact our support team on World-Check One API Please Click Here