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, returningtrue
for a successful call andfalse
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 Code | Description |
---|---|
100 | Standard successful transaction |
200 | Standard failed transaction |
201 | Client account number/ID is not found or does not exist |
202 | Client account number/ID is not active |
203 | Access not allowed for the provided API credentials |
204 | Invalid API credentials |
205 | Missing required request parameter |
206 | Invalid request parameter value |
207 | Duplicate supplier screening request |
208 | Supplier screening request not found |
209 | API access token missing |
210 | Access token invalid or expired |
Updated 12 months ago