| Request Object |
{
"PartnerAccountNumber": "CLIENT001",
"PartnerName": "",
"PartnerSubDivision": "",
"SubClient1ID": "SUB-CLIENT-1234",
"SubClient1Name": "Name of Sub-Client",
"SubscriptionProgramCode": "PROGRAM-CODE-A",
"CallBackUrl": "http://domain.com/callback/riskAssessmentUpdate.aspx",
"SupplierRecordID": "CLIENT001-SUP001",
"ParentCompanyName": "XYZ, Co.",
"ParentCompanyTaxID": "11-889990",
"CompanyName": "Supplier, Inc.",
"CompanyDBA": "Supplier DBA",
"TaxID": "00-123456789",
"ContactFirstName": "John",
"ContactLastName": "Doe",
"ContactEmail": "john@amce.com",
"ContactPhone": "800-123-4567",
"AddressStreet1": "111 Main St",
"AddressStreet2": "",
"AddressCity": "Any City",
"AddressState": "XY",
"AddressPostalCode": "12345",
"AddressCountryCode": "US",
"ProductServiceType": "Product and Services",
"ProductsOrServicesDescription": "Enter Product/Service Description here...",
"UnlistedProductsOrServices": "Enter Unlisted Products/Services information here...",
"RiskTier": "Tier 1",
"CustomQuestion1": "Enter any custom question here",
"CustomQuestion2": "Or enter another custom question here...",
"DiversitySelection": "Diversity Selection 1"
}
|
|
Sample Invalid Response
|
{
"Success": false,
"ResponseCode": 210,
"ResponseMessages": [
"API access token is invalid or expired"
],
"TransactionIDType": null,
"TransactionID": null
}
|
|
Sample Success Response
|
{
"Success": true,
"ResponseCode": 100,
"ResponseMessages": [
"Supplier risk assessment request is accepted"
],
"TransactionIDType": "SUPPLIER-RISK-ASSESSMENT-REQUEST",
"TransactionID": "d7ab8fe6-47c8-4657-8e43-2341027441fc"
}
|
| Request Object Definition |
| Field |
Required |
Data Type |
Definition |
| PartnerAccountNumber |
Yes
|
string |
GRMS creates a partner account number which is used to identify the partner system as part of the API credentials. (GWXXXX) |
| PartnerName |
No |
string |
GRMS creates a partner account name which is used to identify the partner system as part of the API credentials |
| PartnerSubDivision |
No |
string |
|
| SubClient1ID |
No |
string |
For Supplier Management Platforms, GRMS creates a sub client–ID number to identify their client(s) that utilize GRMS’ services. (GWXXXX)
|
| SubClient1Name |
No |
string |
For Supplier Management Platforms, GRMS creates a sub client–ID name for their clients that utilize GRMS’ services |
| SubscriptionProgramCode |
Yes |
string |
The GRMS risk assessment program code used for the risk assessment request.
|
| CallBackUrl |
Yes |
string |
A call URL that GRMS will notify client when status of risk assessment request is changed.
GRMS will submit a "POST" to call back url with the risk assessment request transaction ID.
Click here for info about call back URL
|
| SupplierRecordID |
Yes |
string |
Unique Supplier Identification Number from requesting system
|
| ParentCompanyName |
No |
string |
Name of supplier's parent company |
| ParentCompanyTaxID |
No |
string |
Tax identification number of supplier's parent company |
| CompanyName |
Yes |
string |
Supplier company name
|
| CompanyDBA |
No |
string |
Supplier DBA name(s) |
| TaxID |
Yes |
string |
Supplier tax identification number (TIN) |
| ContactFirstName |
Yes |
string |
Main supplier contact first name |
| ContactLastName |
Yes |
string |
Main supplier contact last name |
| ContactEmail |
Yes |
string |
Main supplier contact email address |
| ContactPhone |
Yes |
string |
Main supplier contact email telephone (U.S. \ International Format) |
| AddressStreet1 |
Yes |
string |
Supplier street address |
| AddressStreet2 |
No |
string |
Supplier street address 2 |
| AddressCity |
Yes |
string |
Supplier city\town |
| AddressState |
Yes |
string |
Supplier state\ province\ county |
| AddressPostalCode |
Yes |
string |
Supplier postal code |
| AddressCountryCode |
Yes |
string |
Supplier country code (2 characters) |
| ProductServiceType |
Yes |
string |
A value of: Product | Service | Both |
| ProductsOrServicesDescription |
Yes |
string |
Dropdown of product and service selection |
| UnlistedProductsOrServices |
No |
string |
If product or service is not listed on the dropdown selection |
| DiversitySelection |
No |
string |
Supplier Diversity Status Selection based on dropdown selections.
|
| RiskTier |
No |
string |
Insurance risk tier/level requirement for supplier.
|
| CustomQuestion1 |
No |
string |
Depending on the screening package, GRMS may need to ask the supplier additional custom questions as part of the risk assessment process, the answer to these questions will be displayed here.
|
| CustomQuestion2 |
No |
string |
Depending on the screening package, GRMS may need to ask the supplier additional custom questions as part of the risk assessment process, the answer to these questions will be displayed here.
|
|