This quick start gives you some technical details, and explains some concepts. It also links to further reading to facilitate your elarning process. Please read this quick start as your first learning step.
The Qual-ID API is a stateless web service based on RESTful architecture.
The production endpoint is supported solely on HTTPS, all requests need to be SSL/TLS compliant. The base URL for the API is https://api.globaldatacompany.com
The API uses built-in HTTP features, such as HTTP authentication, errors and verbs which are understood by standard HTTP clients.
For all requests, the body must be in standard JSON format, and the following header must be set:
The response body is also in JSON format. It should not be treated as fixed or as a schema, new fields may be added as the API evolves, and the order of fields might change. Your applications must therefore be resilient to the reordering of fields within a JSON object.
Qual-ID requires product specific credentials. If you do not have any, please contact your local Refinitiv account manager.
The Qual-ID API uses Basic Authentication for access control. Basic Authentication uses standard fields in the HTTPS request header to avoid the need for handshakes. The Authorization header is constructed by the following process:
- The Qual-ID username and password are combined into a string username:password
- The resulting string is encoded using the RFC2045-MIME variant of Base64, except that the 76 character per line limitation is not applied. This encoded string will simply be referred to as ACCESS_TOKEN in our examples.
- The authorization method and a space, in this case "Basic ", are put before the encoded string, so the resulting header is "Authorization: Basic ACCESS_TOKEN"
Many popular tools (such as Postman or SOAPUI) and HTTP client libraries in most programming languages will do the encoding work for you, requiring you to simply provide the username and password.
Making a Test Verification
If this is your first integration with Qual-ID you should have access to a demo account, which is your sandbox environment. If you are unsure whether you have a sandbox environment, or how to access it, please contact your local Refinitiv account manager.
The sandbox environment is intended to let you get a feel for how Qual-ID API works, but does not perform live transactions against real data. Rather, it checks the given identity against a static test database. For this reason you will need to use a test entity.
A test entity is a dummy identity provided by Qual-ID, which matches a record in our test database. Test entities can be safely verified in demo accounts without having any impact on real people or data.
There are 2 ways to obtain test entity data.
The first is to log into the Qual-ID web portal, select "Verify" in the left-hand menu, choose any country, hit the "Populate" button, and copy the test data from the UI.
The second is to make an API call to get a list of test entities:
Note that this call takes an input parameter for the country code, a 2 letter code (ISO 3166). To find out which ones are available to you, see Step 3 - Get Country Codes in the Identity Verification - HTTP tutorial for details.
Building Your Production Integration
Integration & Best Practices
Once you've read this quickstart guide, and have worked through the tutorials, we recommend working closely with the Refinitiv Professional Service team to ensure you are set up for success. You will receive any assistance you need to guarantee that your integration goes as smoothly as possible. For more information about Qual-ID API Professional Services assistance, please contact your account manager.
Live API Credentials
Once you're satisfied with your initial test of the API, you should contact you account manager to receive live API credentials. This will allow you to begin checking identities against live datasources, rather than the hardcoded test entities.