Method | Endpoint |
---|
GET | /api/integration-services/customer/v1/risk-scoring-assessments/ |
GET | /api/integration-services/customer/v1/screening-alerts/ |
GET | /api/integration-services/customer/v1/manual-assessments/ |
GET | /api/integration-services/customer/v1/retrospective-assessments/ |
Get Customer assessment short link by GUID
This endpoint retrieves an assessment short link by its unique GUID.
Endpoint
GET http://{{baseUrl}}/api/integration-services/customer/v1/risk-scoring-assessments/{guid}
Path Parameters
Parameter | Type | Description |
---|
guid | string | The unique identifier of the assessment. |
Fields
URL link for customer assessment.
List of possible responses
200 OK
{
"result": {
"shortlink": "https://uiHost/shortlinks/guid",
"guid": "guid"
}
}
404 Not Found
{
"errors": [
{
"code": "notFound"
}
]
}
List of possible errors
Code | Endpoint |
---|
notFound | Assessment was not found by this unique id |
Get Customer screening short link by GUID
This endpoint retrieves a screening alert short link by its unique GUID.
Endpoint
GET http://{{baseUrl}}/api/integration-services/customer/v1/screening-alerts/{guid}
Path Parameters
Parameter | Type | Description |
---|
guid | string | The unique identifier of the screening. |
Fields
URL link for customer screening alert.
Screening alert unique id.
List of possible responses
200 OK
{
"result": {
"shortlink": "https://uiHost/shortlinks/guid",
"guid": "guid"
}
}
404 Not Found
{
"errors": [
{
"code": "notFound"
}
]
}
List of possible errors
Code | Endpoint |
---|
notFound | Screening alert was not found by this unique id |
Get Manual assessments short link by GUID
This endpoint retrieves a manual assessment short link by its unique GUID.
Endpoint
GET http://{{baseUrl}}/api/integration-services/customer/v1/manual-assessments/{guid}
Path Parameters
Parameter | Type | Description |
---|
guid | string | The unique identifier of the manual case. |
Fields
URL link for manual case.
List of possible responses
200 OK
{
"result": {
"shortlink": "https://uiHost/shortlinks/guid",
"guid": "guid"
}
}
404 Not Found
{
"errors": [
{
"code": "notFound"
}
]
}
List of possible errors
Code | Endpoint |
---|
notFound | Manual case was not found by this unique id |
Get Customer retrospective assessment short link by GUID
This endpoint retrieves a retrospective assessment short link by its unique GUID.
Endpoint
GET http://{{baseUrl}}/api/integration-services/customer/v1/retrospective-assessments/{guid}
Path Parameters
Parameter | Type | Description |
---|
guid | string | The unique identifier of the retrospective assessment. |
Fields
URL link for customer retrospective assessment.
Customer retrospective assessment unique id.
List of possible responses
200 OK
{
"result": {
"shortlink": "https://uiHost/shortlinks/guid",
"guid": "guid"
}
}
404 Not Found
{
"errors": [
{
"code": "notFound"
}
]
}
List of possible errors
Code | Endpoint |
---|
notFound | Customer retrospective assessment was not found by this unique id |