API Reference

Veritas API offers a seamless solution for effortless integration of GRMS risk assessment services into various Supplier Management Systems (SMS). Through this integration, users of the SMS can conveniently initiate supplier assessments within the system. The assessment results seamlessly become a part of the SMS, providing users with updated and easily accessible information on supplier assessments.

Veritas API provides the following capabilities:

  • Initiating a risk assessment request
  • Retrieving supplier risk assessment requests with comprehensive updates on individual risk components
  • Accessing a list of available programs for a client account

๐Ÿ” Authentication

For every API call, it is essential to include an access token in the request header labeled as AccessToken.
Obtain this access token by executing the AccessToken API method and supplying the required parameters of APIKey and APISecret.

โ•Be mindful of your tokens! Don't store secret keys in files like .env, and steer clear of sharing them on public platforms such as GitHub. Keep your keys safe!

APIKey and APISecret can be obtained from client services team at [email protected]

โš ๏ธ Errors

โ•It is important to note that all calls to Veritas API return a 200 HTTP response code, accompanied by a JSON body to indicate the outcome of the API transaction.

This JSON body includes the following fields to help you determine if the transaction was successful and if there are any errors present:

  • Success: a boolean value, returning true for a successful call and false otherwise.
  • ResponseCode: a numerical string value corresponding to status messages defined by Veritas.

Response code definitions

As previously mentioned, every call to the Veritas API includes ResponseCode field in the returned JSON body. These codes can help your team to troubleshoot any issues related to the API.

Response CodeDescription
100Standard successful transaction
200Standard failed transaction
201Client account number/ID is not found or does not exist
202Client account number/ID is not active
203Access not allowed for the provided API credentials
204Invalid API credentials
205Missing required request parameter
206Invalid request parameter value
207Duplicate supplier screening request
208Supplier screening request not found
209API access token missing
210Access token invalid or expired