REST API: Pull Supplier Risk Assessment

Documentation Last Update
End Point - Live https://developer.globalrms.com/api/assess/detail
End Point - Sandbox https://sandbox-api.globalrms.com/api/assess/detail
HTTP Method GET
Description Pull supplier risk assessment request record which contains supplier data, related ratings, and status.
Request Object Type Query string parameter
Request Object Parameters "id": accept the risk assessment request transaction ID
Response Type JSON
Invalid Response
{
	"RequestDate": "0001-01-01T00:00:00",
	"LastUpdate": "0001-01-01T00:00:00",
	"ProcessingStatus": 0,
	"ProcessingStatusDescription": null,
	"RiskAssessmentRequest": null,
	"RiskComponents": [],
	"Success": false,
	"ResponseCode": 208,
	"ResponseMessages": [
		"Supplier risk assessment record is not found for transaction ENTER-TRANSACTION-ID"
	],
	"TransactionIDType": null,
	"TransactionID": null
}
                            
Valid Reponse
{
   "RequestDate":"0001-01-01T00:00:00",
   "LastUpdate":"2017-05-13T21:11:35.463",
   "ProcessingStatus":2,
   "ProcessingStatusDescription":"Processing",
   "RiskAssessmentRequest":{
      "PartnerAccountNumber":"CUST001",
      "PartnerName":"ABC Procurement",
      "PartnerSubDivision":null,
      "SubClient1ID":null,
      "SubClient1Name":null,
      "SubClient2ID":null,
      "SubClient2Name":null,
      "SubClient3ID":null,
      "SubClient3Name":null,
      "SubscriptionProgramCode":null,
      "PromotionCode":null,
      "CallBackUrl":null,
      "SupplierRecordID":null,
      "ParentCompanyName":null,
      "ParentCompanyTaxID":null,
      "CompanyName":"AMCE, Inc",
      "CompanyDBA":"AMCE Supply",
      "TaxID":"100-20-3000",
      "ContactFirstName":null,
      "ContactLastName":null,
      "ContactEmail":null,
      "ContactPhone":null,
      "AddressStreet1":null,
      "AddressStreet2":null,
      "AddressCity":null,
      "AddressState":null,
      "AddressPostalCode":null,
      "AddressCountryCode":null,
      "ProductServiceType":null,
      "ProductsOrServicesDescription":null,
      "UnlistedProductsOrServices":null,
      "CustomQuestion1": "TEST",
      "CustomQuestion1Answer": null,
      "CustomQuestion2": "TEST",
      "CustomQuestion2Answer": null,
      "CustomQuestion3": null,
      "CustomQuestion3Answer": null,
      "CustomQuestion4": null,
      "CustomQuestion4Answer": null,
      "DiversitySelection": null,
      "IsNewEnrollment": true,
      "IsExpired": false,
      "RenewalTransactionID": ""
   },
   "RiskComponents":[
      {
         "RiskModuleGroup": "Health and Safety",
         "RiskComponentID": 1234,
         "ParentRiskComponentID": 0,
         "RiskComponentCode":"GWL",         
         "RiskComponentTitle":"Global Watch List Monitoring",
         "RiskAssessmentResult":"Global Watch List Monitoring risk assessment result goes here",
         "RiskAssessmentResultPDF": "https://veritas.globalrms.com/content/pdf/riskComponent.aspx?requestID=bb35d387-b95c-444f&componentID=1",
         "RiskAssessmentResultHtmlView": "https://veritas.globalrms.com/supplier/riskComponent.aspx?requestID=bb35d387-b95c-444f3&componentID=1",
         "RatingCode":"GRADE1",
         "RatingDescription":"Grade 1",
         "RatingCompletionDate": "2017-01-13T13:03:35.433",
         "WeightedRatingScore": 0,
         "Documents": [
                {
                    "FileURL": "http://api.globalrms.com/uploads/assess-documents/548e0c39-b42e-4455-91cb-a2646f4399x5.pdf",
                    "Name": "File 1 name",
                    "Description": "File 1 description",
                    "UploadedDate": "2022-07-13T13:03:35.433"
                },
                {
                    "FileURL": "http://api.globalrms.com/uploads/assess-documents/548e0c39-b42e-4455-91cb-a2646f4399x5.pdf",
                    "Name": "File 2 name",
                    "Description": "File 2 description",
                    "UploadedDate": "2022-07-13T13:03:35.433"
                },
        ],
        "InsurancePolicies": [
                {
                    "PolicyType": "Commercial General Liability",
                    "PolicyNumber": "XY12345",
                    "PolicyEffectiveDate": "2022-02-28T00:00:00",
                    "PolicyExpireDate": "2023-02-28T00:00:00",
                    "RiskRating": "Compliant",
                    "InsurerName": "ABC Insurance",
                    "InsurerNaic": "0",
                    "InsuranceAgencyName": "AMCE Insurance Agency ",
                    "InsuranceAgencyAddress": "111 Main St ",
                    "InsuranceAgencyCity": "Any City",
                    "InsuranceAgencyState": "XY",
                    "InsuranceAgencyPostalCode": "12345",
                    "InsuranceAgentName": "John Doe",
                    "Limits": [
                        {
                            "LimitType": "Bodily Injury And Property Damage Liability",
                            "LimitAmount": 0,
                            "HasDeductible": true,
                            "DeductibleAmount": 0
                        },
                        {
                            "LimitType": "General Aggregate",
                            "LimitAmount": 5000000,
                            "HasDeductible": true,
                            "DeductibleAmount": 0
                        },
                        {
                            "LimitType": "Each  Occurrence",
                            "LimitAmount": 1000000,
                            "HasDeductible": true,
                            "DeductibleAmount": 2500
                        }
                    ],
                    "Coverages": [
                        {
                            "CoverageType": "Occurrence"
                        },
                        {
                            "CoverageType": "Employers Liability"
                        },
                        {
                            "CoverageType": "Cross Liability"
                        },
                        {
                            "CoverageType": "Waiver Of Subrogation"
                        },
                        {
                            "CoverageType": "Tenants Legal Liability"
                        },
                        {
                            "CoverageType": "Non-owned Automobiles"
                        },
                        {
                            "CoverageType": "Hired Automobiles"
                        },
                        {
                            "CoverageType": "Products And / Or Completed Operations"
                        },
                        {
                            "CoverageType": "Other  1"
                        }
                    ],
                    "Endorsements": [
                        {
                            "EndorsementType": "Additional Insured",
                            "EndorsementDocumentUrl": "http://api.globalrms.com/uploads/assess-documents/548e0c39-b42e-4455-91cb-a2646f4399x5.pdf"
                        },
                        {
                            "EndorsementType": "Waiver of Subrogation",
                            "EndorsementDocumentUrl": "http://api.globalrms.com/uploads/assess-documents/548e0c39-b42e-4455-91cb-a2646f4399x5.pdf"
                        }
                    ]
                },
                {
                    "PolicyType": "Excess Liability",
                    "PolicyNumber": "XY22222",
                    "PolicyEffectiveDate": "2022-02-28T00:00:00",
                    "PolicyExpireDate": "2023-02-28T00:00:00",
                    "RiskRating": "Compliant",
                    "InsurerName": "ABC Insurance",
                    "InsurerNaic": "0",
                    "InsuranceAgencyName": "AMCE Insurance Agency ",
                    "InsuranceAgencyAddress": "111 Main St ",
                    "InsuranceAgencyCity": "Any City",
                    "InsuranceAgencyState": "XY",
                    "InsuranceAgencyPostalCode": "12345",
                    "InsuranceAgentName": "John Doe",
                    "Limits": [
                        {
                            "LimitType": "Each Occurrence",
                            "LimitAmount": 9000000,
                            "HasDeductible": true,
                            "DeductibleAmount": 0
                        },
                        {
                            "LimitType": "Aggregate",
                            "LimitAmount": 9000000,
                            "HasDeductible": true,
                            "DeductibleAmount": 0
                        },
                        {
                            "LimitType": "Other1",
                            "LimitAmount": 0,
                            "HasDeductible": false,
                            "DeductibleAmount": 0
                        }
                    ],
                    "Coverages": [
                        {
                            "CoverageType": "Umbrella Form"
                        }
                    ],
                    "Endorsements": []
                }
            ],
            "Survey": {
                "SurveyTitle": "Human Rights Survey",
                "SurveyParts": [
                    {
                        "SurveySectionTitle": "Human Rights Survey",
                        "QuestionAnswerCollection": [
                            {
                                "SurveyQuestion": "1. Does your company invest in community development and volunteer activities in the countries it operates in?",
                                "SurveyQuestionAnswer": "Yes"
                            },
                            {
                                "SurveyQuestion": "2. Does your company have a policy that prohibits use of child and slave labor by your company's vendors and their subsidiaries, affiliates and subcontractors?",
                                "SurveyQuestionAnswer": "Yes"
                            },
                            {
                                "SurveyQuestion": "3. Does your organization abide by the business relevant principles of the Universal Declaration of Human Rights (UDHR)?\r\n(https://www.un.org/en/universal-declaration-human-rights/)",
                                "SurveyQuestionAnswer": "Yes"
                            },
                            {
                                "SurveyQuestion": "4. In the last three years, have any finding of unlawful discrimination been made against your organization by any court or employment tribunal or equivalent body?",
                                "SurveyQuestionAnswer": "No"
                            },
                            {
                                "SurveyQuestion": "5. Does your company have an established Code of Conduct that adheres to basic guidelines for social, economic and environmental responsibility?",
                                "SurveyQuestionAnswer": "Yes"
                            },
                            {
                                "SurveyQuestion": "Please upload Code of Conduct",
                                "SurveyQuestionAnswer": "http://api.globalrms.com/uploads/assess-documents/548e0c39-b42e-4455-91cb-a2646f4399x5.pdf"
                            }
                        ]
                    }
                ]
            },
            "DiversityTypes": [
                {
                    "DiversityTypes": "Indigenous Business",
                    "Agency": "Supply Nation",
                    "IsBillionDollarRoundtable": true,
                    "CertificationNumber": "TESTCERT123",
                    "FileURL": "http://api.globalrms.com/uploads/assess-documents/548e0c39-b42e-4455-91cb-a2646f4399e5.pdf",
                    "ExpirationDate": "2022-12-31T00:00:00.000",
                }
            ]
      },
      {
         "RiskComponentCode":"EFSR",
         "RiskComponentTitle":"Experian Financial Stability Risk Score",
         "RiskAssessmentResult":"Experian Financial Stability Risk Score search result goes here...",
         "RatingCode":"GRADE2",
         "RatingDescription":"Grade 2",
         "RatingCompletionDate": "2017-01-13T13:03:35.433",
         "Documents": [],
         "DiversityTypes": []
      }
   ],
   "Success":true,
   "ResponseCode":100,
   "ResponseMessages":[

   ],
   "TransactionIDType":null,
   "TransactionID":null
}
                                
Request Parameters Definition
Field Required Data Type Definition
id Yes string Screening request transaction ID. This transaction ID is returned by REST API method Submit Supplier Risk Assessment..
Response Object Definition
Field Required Data Type Definition
Success NA boolean Return "true" if screening request is sucessfully submitted.
Return "false" if GRMS is unable to process screening request.
ResponseCode NA string GRMS response code for the screening request API call
ResponseMessages NA string array List of messages related to screening request API call
TransactionIDType NA string Describe TransactionID type
TransactionID NA string GRMS's risk assessment record ID
RequestDate NA DateTime Date of the risk assessment request
LastUpdate NA DateTime Date when the risk assessment last updated
ProcessingStatus NA numeric Numeric value of risk assessment processing status. Possible values:
{ 1, 2, 3, 4, 5, 6 }
ProcessingStatusDescription NA string Description of risk assessment processing status. Possible values:
{ "Ready To Process", "Processing", "Completed", "Canceled", "Pending Payment", "Expired" }
IsNewEnrollment NA boolean Return "true" if risk assesment is new (first time enrolled).
Return "false" otherwise
IsExpired NA boolean Return "true" if risk assesment is expired/inactivated.
Return "false" otherwise
RenewalTransactionID NA string Return a transaction ID of the new risk asessment if the current risk assessment is renewed.
RiskAssessmentRequest NA literal object String literal object holding the data fields that provide detail information about the risk assessment
RiskComponents NA array/list Array/list of risk component objects
RiskModuleGroup NA string Name of the risk module that the risk component is assigned to
ParentRiskComponentID NA numeric Record ID of the parent risk component
RiskComponentID NA numeric Record ID of the risk component
RiskComponentCode NA string Code of the risk component
RiskComponentTitle NA string Name of the risk component
RiskAssessmentResult NA string/html Detail research result about the risk assessment component. Return data contains plain text and HTML. Most of the time the return data is HTML.
RiskAssessmentResultPDF NA string/URI URL to PDF version of the research result of the risk component
RiskAssessmentResultHtmlView NA string/URI URL to HTML web page version of the research result of the risk component
RatingCode NA string Risk grading code. Possible values:
{ 
    "Compliant", 
    "Pass - Exception Granted", 
    "Alert - Needs Client Review", 
    "Exempt", 
    "Fail - No Document", 
    "Fail - Expired", 
    "Non - Compliant", 
    "Processing", 
    "Fail - No Response", 
    "Uploaded", 
    "Alert - No Response", 
    "Alert - Under Client Review", 
    "Low Risk", 
    "Medium Risk", 
    "High Risk" 
}
RatingDescription NA string Risk grading description. Possible values:
{ 
    "Compliant", 
    "Pass - Exception Granted", 
    "Alert - Needs Client Review", 
    "Exempt", 
    "Fail - No Document", 
    "Fail - Expired", 
    "Non - Compliant", 
    "Processing", 
    "Fail - No Response", 
    "Uploaded", 
    "Alert - No Response", 
    "Alert - Under Client Review", 
    "Low Risk", 
    "Medium Risk", 
    "High Risk" 
}
RatingCompletionDate NA date Date when the risk component is completed the risk research process.
WeightedRatingScore NA numeric Weighted rating score of the risk component
Documents NA array/list Array/list of document objects. Each document object includes Name(file name), Description(file description), FileURL, and UploadedDate.
DiversityTypes NA array/list Array/list of DiversityTypes objects. Each DiversityType object includes DiversityType(name), Agency, IsBillionDollarRoundtable (boolean), CertificationNumber, FileURL to certification document, and ExpirationDate
InsurancePolicies NA array/list Array/list of insurance policy policies.
Survey NA literal object String literal object holding the data fields that provide detail information about a survey.
Response Codes IMPORTANT! The error response codes are NOT HTTP response codes.

The table below lists error response codes that being generated by GRMS Veritas API. All GRMS Veritas API methods/endpoints return a "200" HTTP response code with a JSON body that contains a boolean "Success" field, which indicates whether the API transaction is success or fail. The JSON body also contains numeric "ResponseCode" field, which indicates different response statuses correspond to different technical errors and business rules that being handled by GRMS Veritas API.

Response Code Description
100 Standard success transaction.
200 Standard failure transaction.
201 GRMS's client account number/ID is not found/exist on GRMS Veritas platform.
202 GRMS's client account number/ID is not active on GRMS Veritas platform.
203 API access is not allowed for the provided API credentials.
204 Invalid API credentials.
205 Missing input parameter(s) required by the respective GRMS Veritas API method/endpoint.
206 Invalid input parameter value(s) that being submitted to the respective GRMS Veritas API method/endpoint.
207 Duplicate supplier screening request. GRMS Veritas API finds an active supplier screening request.
208 Supplier screening request record is not found by GRMS Veritas API.
209 Missing GRMS Veritas API access token.
210 Invalid or expired GRMS Veritas API access token.
Copyright © 2024 Global Risk Management Solutions, LLC. All rights reserved.