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
   },
   "RiskComponents":[
      {
         "RiskComponentCode":"GWL",         
         "RiskComponentTitle":"Global Watch List Monitoring",
         "RiskAssessmentResult":"Global Watch List Monitoring risk assessment result goes here",
         "RatingCode":"GRADE1",
         "RatingDescription":"Grade 1",
         "RatingCompletionDate": "2017-01-13T13:03:35.433",
		 "Documents": [
				{
					"FileURL": "http://api.globalrms.com/uploads/assess-documents/548e0c39-b42e-4455-91cb-a2646f4399e5.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-a2646f4399e5.pdf",
					"Name": "File 2 name",
					"Description": "File 2 description",
					"UploadedDate": "2022-07-13T13:03:35.433"
				},
		 ]
      },
      {
         "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": []
      }
   ],
   "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 string Date of the risk assessment request
LastUpdate NA string Date when the risk assessment last updated
ProcessingStatus NA numeric Numeric value of risk assessment processing status
ProcessingStatusDescription NA string Description of risk assessment processing status
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
RatingDescription NA string Risk grading description
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.
Copyright © 2022 Global Risk Management Solutions, LLC. All rights reserved.