Skip to main content
MethodEndpoint
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/
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

ParameterTypeDescription
guidstringThe unique identifier of the assessment.

Fields

URL link for customer assessment.
guid
string
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

CodeEndpoint
notFoundAssessment was not found by this unique id
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

ParameterTypeDescription
guidstringThe unique identifier of the screening.

Fields

URL link for customer screening alert.
guid
string
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

CodeEndpoint
notFoundScreening alert was not found by this unique id
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

ParameterTypeDescription
guidstringThe unique identifier of the manual case.

Fields

URL link for manual case.
guid
string
Manual case 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

CodeEndpoint
notFoundManual case was not found by this unique id
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

ParameterTypeDescription
guidstringThe unique identifier of the retrospective assessment.

Fields

URL link for customer retrospective assessment.
guid
string
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

CodeEndpoint
notFoundCustomer retrospective assessment was not found by this unique id
I