Search Supplier Risk Assessments

REST API: Search Risk Assessments

Documentation Last Update

End Point - Live

https://developer.globalrms.com/api/assess/search

End Point - Sandbox

https://sandbox-api.globalrms.com/api/assess/search

HTTP Method

GET

Description

Parameterized search for supplier risk assessment request records

Request Object Type

Query string parameters

Request Parameters Definition

Field	Required	Data Type	Definition
PartnerAccountNumber	Yes	string	a partner account number created by GRMS
ProgramCode	Yes	string	a program code that is assigned to or associated with risk assessment request
RequestDateBegin	No	string	a date string (in format mm/dd/yyyy) that specify starting date of the risk assesessment request
RequestDateEnd	No	string	a date string (in format mm/dd/yyyy) that specify ending date of the risk assesessment request

Response Type

JSON

Invalid Response

{
	"Success": false,
	"ResponseCode": 208,
	"ResponseMessages": [
		"Error message"
	]
}

Valid Reponse

{
	"RiskAssessmentRecordsCount": 3,
	"RiskAssessmentRecords": [
		{
			"RequestDate": "0001-01-01T00:00:00",
			"LastUpdate": "2018-07-01T17:30:00",
			"ProcessingStatus": 2,
			"ProcessingStatusDescription": "Processing",
			"RiskAssessmentRequest": {
				"PartnerAccountNumber": "XY1000",
				"PartnerName": "AMCE, Inc.",
				"SubClient1Name": "",
				"SubscriptionProgramCode": "PACKAGE-A",
				"ClientEnrollmentCode": "NBTY17",
				"CallBackUrl": "",
				"SupplierRecordID": "",
				"ParentCompanyName": "",
				"ParentCompanyTaxID": "",
				"CompanyName": "Curran Transfer Inc",
				"CompanyDBA": "Straight Shot Express",
				"TaxID": "88-7779999",
				"ContactFirstName": "Vinh",
				"ContactLastName": "Luu",
				"AddressStreet1": "111 Main st",
				"AddressStreet2": "",
				"AddressCity": "Westminster",
				"AddressState": "CA",
				"AddressPostalCode": "92683",
				"AddressCountryCode": "US",
				"ServiceLocation": "",
				"ProductServiceType": "Both Products/Services",
				"ProductsOrServicesDescription": "Hardware|Human Resources",
				"UnlistedProductsOrServices": "Unlised services goes here",
			        "CustomQuestion1": "Custom question 1 goes here",
			        "CustomQuestion2": "Custom question 2 goes here",
			        "CustomQuestion3": "Custom question 3 goes here",
			        "CustomQuestion4": "Custom question 4 goes here",
				"DiversitySelection": "",
                                "IsNewEnrollment": true,
                                "IsExpired": true,
                                "RenewalTransactionID": ""
			},
			"RiskComponents": [
				{
					"RiskComponentCode": "Custom Search 48",
					"RiskComponentTitle": "Tax Form - (W-8BEN-E)",
					"RatingDescription": "",
					"Documents": []
				},
				{
					"RiskComponentCode": "INSURANCE-CERT",
					"RiskComponentTitle": "Insurance Certificate Verification",
					"RatingDescription": "",
					"Documents": []
				},
				{
					"RiskComponentCode": "FINANCIAL-EVAL",
					"RiskComponentTitle": "Financial Evaluation",
					"RatingDescription": "",
					"Documents": []
				}
			],
			"TransactionID": "008f82d3-f22c-4616-8195-4368f0d9f486"
		},
		{
			"RequestDate": "0001-01-01T00:00:00",
			"LastUpdate": "2018-07-01T17:23:17.773",
			"ProcessingStatus": 1,
			"ProcessingStatusDescription": "Ready To Process",
			"RiskAssessmentRequest": {
				"PartnerAccountNumber": "XY1000",
				"PartnerName": "AMCE, Inc.",
				"SubClient1Name": "",
				"SubscriptionProgramCode": "PACKAGE-A",
				"ClientEnrollmentCode": "NBTY17",
				"CallBackUrl": "",
				"ParentCompanyName": "",
				"ParentCompanyTaxID": "",
				"CompanyName": "Test Only",
				"CompanyDBA": "Test Only",
				"TaxID": "77-6655478",
				"ContactFirstName": "Vinh",
				"ContactLastName": "Luu",
				"AddressStreet1": "111 Main st",
				"AddressStreet2": "",
				"AddressCity": "Westminster",
				"AddressState": "CA",
				"AddressPostalCode": "92683",
				"AddressCountryCode": "US",
				"ServiceLocation": "",
				"ProductServiceType": "Services",
				"ProductsOrServicesDescription": "Hardware",
				"UnlistedProductsOrServices": "Unlised services goes here",
			        "CustomQuestion1": "Custom question 1 goes here",
			        "CustomQuestion2": "Custom question 2 goes here",
			        "CustomQuestion3": "Custom question 3 goes here",
			        "CustomQuestion4": "Custom question 4 goes here",
				"DiversitySelection": "",
                                "IsNewEnrollment": true,
                                "IsExpired": false,
                                "RenewalTransactionID": ""
			},
			"RiskComponents": [
				{
					"RiskComponentCode": "Custom Search 48",
					"RiskComponentTitle": "Tax Form - (W-8BEN-E)",
					"RatingDescription": "",
					"Documents": []
				},
				{
					"RiskComponentCode": "INSURANCE-CERT",
					"RiskComponentTitle": "Insurance Certificate Verification",
					"RatingDescription": "",
					"Documents": []
				},
				{
					"RiskComponentCode": "FINANCIAL-EVAL",
					"RiskComponentTitle": "Financial Evaluation",
					"RatingDescription": "",
					"Documents": []
				}
			],
			"TransactionID": "3ba0f4d1-d593-49ff-96b7-f28561418307"
		},
		{
			"RequestDate": "0001-01-01T00:00:00",
			"LastUpdate": "2018-07-01T17:30:00",
			"ProcessingStatus": 2,
			"ProcessingStatusDescription": "Processing",
			"RiskAssessmentRequest": {
				"PartnerAccountNumber": "XY1000",
				"PartnerName": "AMCE, Inc.",
				"SubClient1Name": "",
				"SubscriptionProgramCode": "PACKAGE-A",
				"ClientEnrollmentCode": "NBTY17",
				"CallBackUrl": "",
				"SupplierRecordID": "",
				"ParentCompanyName": "",
				"ParentCompanyTaxID": "",
				"CompanyName": "Test Only",
				"CompanyDBA": "Test Only",
				"TaxID": "88-7779997",
				"ContactFirstName": "Vinh",
				"ContactLastName": "Luu",
				"AddressStreet1": "111 Main st",
				"AddressStreet2": "",
				"AddressCity": "Westminster",
				"AddressState": "CA",
				"AddressPostalCode": "92683",
				"AddressCountryCode": "US",
				"ServiceLocation": "",
				"ProductServiceType": "Both Products/Services",
				"ProductsOrServicesDescription": "",
				"UnlistedProductsOrServices": "Unlised services goes here",
			        "CustomQuestion1": "Custom question 1 goes here",
			        "CustomQuestion2": "Custom question 2 goes here",
			        "CustomQuestion3": "Custom question 3 goes here",
			        "CustomQuestion4": "Custom question 4 goes here",
				"DiversitySelection": "",
                                "IsNewEnrollment": false,
                                "IsExpired": true,
                                "RenewalTransactionID": "3ba0f4d1-d593-49ff-96b7-f28561418307"
			},
			"RiskComponents": [
				{
					"RiskComponentCode": "Custom Search 48",
					"RiskComponentTitle": "Tax Form - (W-8BEN-E)",
					"RatingDescription": "",
					"Documents": []
				},
				{
					"RiskComponentCode": "INSURANCE-CERT",
					"RiskComponentTitle": "Insurance Certificate Verification",
					"RatingDescription": "",
					"Documents": []
				},
				{
					"RiskComponentCode": "FINANCIAL-EVAL",
					"RiskComponentTitle": "Financial Evaluation",
					"RatingDescription": "",
					"Documents": []
				}
			],
			"TransactionID": "9a8f79ee-eefb-404a-858e-9eff7f15555e"
		}
	],
	"Success": true,
	"ResponseMessages": []
}

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.