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": ""
			},
			"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": ""
			},
			"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": ""
			},
			"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": []
}
Copyright © 2022 Global Risk Management Solutions, LLC. All rights reserved.