Skip to main content
GET
/
api
/
customer
/
{customerId}
/
screen
/
summary
getScreeningSummary
curl --request GET \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
{
  "content": [
    {
      "customer": {
        "active": true,
        "assignees": [
          {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          }
        ],
        "createdAt": {
          "date": 123,
          "day": 123,
          "hours": 123,
          "minutes": 123,
          "month": 123,
          "nanos": 123,
          "seconds": 123,
          "time": 123,
          "timezoneOffset": 123,
          "year": 123
        },
        "createdBy": {
          "email": "<string>",
          "firstName": "<string>",
          "fullName": "<string>",
          "id": 123,
          "lastName": "<string>"
        },
        "forms": {},
        "id": 123,
        "lastRiskAssessment": "2023-11-07T05:31:56Z",
        "listRoleAsText": [
          "<string>"
        ],
        "notes": {},
        "other": {},
        "parentId": 123,
        "particular": {},
        "profileId": 123,
        "profileReferenceId": "<string>",
        "referenceId": "<string>",
        "riskRating": "HIGH",
        "roles": [
          {
            "appointedDate": "2023-12-25",
            "createdAt": {
              "date": 123,
              "day": 123,
              "hours": 123,
              "minutes": 123,
              "month": 123,
              "nanos": 123,
              "seconds": 123,
              "time": 123,
              "timezoneOffset": 123,
              "year": 123
            },
            "createdBy": {
              "email": "<string>",
              "firstName": "<string>",
              "fullName": "<string>",
              "id": 123,
              "lastName": "<string>"
            },
            "id": 123,
            "resignedDate": "2023-12-25",
            "role": "<string>",
            "updatedAt": {
              "date": 123,
              "day": 123,
              "hours": 123,
              "minutes": 123,
              "month": 123,
              "nanos": 123,
              "seconds": 123,
              "time": 123,
              "timezoneOffset": 123,
              "year": 123
            },
            "updatedBy": {
              "email": "<string>",
              "firstName": "<string>",
              "fullName": "<string>",
              "id": 123,
              "lastName": "<string>"
            }
          }
        ],
        "status": "ACCEPTED",
        "type": "CORPORATE",
        "updatedAt": {
          "date": 123,
          "day": 123,
          "hours": 123,
          "minutes": 123,
          "month": 123,
          "nanos": 123,
          "seconds": 123,
          "time": 123,
          "timezoneOffset": 123,
          "year": 123
        },
        "updatedBy": {
          "email": "<string>",
          "firstName": "<string>",
          "fullName": "<string>",
          "id": 123,
          "lastName": "<string>"
        },
        "vendorEntityGuid": "<string>",
        "vendorName": "<string>"
      },
      "parentCustomer": {
        "active": true,
        "assignees": [
          {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          }
        ],
        "createdAt": {
          "date": 123,
          "day": 123,
          "hours": 123,
          "minutes": 123,
          "month": 123,
          "nanos": 123,
          "seconds": 123,
          "time": 123,
          "timezoneOffset": 123,
          "year": 123
        },
        "createdBy": {
          "email": "<string>",
          "firstName": "<string>",
          "fullName": "<string>",
          "id": 123,
          "lastName": "<string>"
        },
        "forms": {},
        "id": 123,
        "lastRiskAssessment": "2023-11-07T05:31:56Z",
        "listRoleAsText": [
          "<string>"
        ],
        "notes": {},
        "other": {},
        "parentId": 123,
        "particular": {},
        "profileId": 123,
        "profileReferenceId": "<string>",
        "referenceId": "<string>",
        "riskRating": "HIGH",
        "roles": [
          {
            "appointedDate": "2023-12-25",
            "createdAt": {
              "date": 123,
              "day": 123,
              "hours": 123,
              "minutes": 123,
              "month": 123,
              "nanos": 123,
              "seconds": 123,
              "time": 123,
              "timezoneOffset": 123,
              "year": 123
            },
            "createdBy": {
              "email": "<string>",
              "firstName": "<string>",
              "fullName": "<string>",
              "id": 123,
              "lastName": "<string>"
            },
            "id": 123,
            "resignedDate": "2023-12-25",
            "role": "<string>",
            "updatedAt": {
              "date": 123,
              "day": 123,
              "hours": 123,
              "minutes": 123,
              "month": 123,
              "nanos": 123,
              "seconds": 123,
              "time": 123,
              "timezoneOffset": 123,
              "year": 123
            },
            "updatedBy": {
              "email": "<string>",
              "firstName": "<string>",
              "fullName": "<string>",
              "id": 123,
              "lastName": "<string>"
            }
          }
        ],
        "status": "ACCEPTED",
        "type": "CORPORATE",
        "updatedAt": {
          "date": 123,
          "day": 123,
          "hours": 123,
          "minutes": 123,
          "month": 123,
          "nanos": 123,
          "seconds": 123,
          "time": 123,
          "timezoneOffset": 123,
          "year": 123
        },
        "updatedBy": {
          "email": "<string>",
          "firstName": "<string>",
          "fullName": "<string>",
          "id": 123,
          "lastName": "<string>"
        },
        "vendorEntityGuid": "<string>",
        "vendorName": "<string>"
      },
      "screening": {
        "additionalInformation": {
          "djMonitoringCaseId": "<string>",
          "djMonitoringTxId": "<string>",
          "faceCompareDocumentId": "<string>",
          "faceCompareSelfieId": "<string>",
          "ocrDocumentId": "<string>"
        },
        "createdAt": {
          "date": 123,
          "day": 123,
          "hours": 123,
          "minutes": 123,
          "month": 123,
          "nanos": 123,
          "seconds": 123,
          "time": 123,
          "timezoneOffset": 123,
          "year": 123
        },
        "createdBy": {
          "email": "<string>",
          "firstName": "<string>",
          "fullName": "<string>",
          "id": 123,
          "lastName": "<string>"
        },
        "facInformation": {
          "faceCompareDocumentId": 123,
          "faceCompareSelfieId": 123
        },
        "finalStatus": "DONE",
        "hasHit": true,
        "id": 123,
        "isPeriodic": true,
        "ocrInformation": {
          "ocrDocumentId": 123
        },
        "oddStatus": "CLOSED",
        "profileId": 123,
        "quickscanName": "<string>",
        "quickscanType": "CORPORATE",
        "remarks": [
          "<string>"
        ],
        "screenedWith": [
          "ARTEMISCAN"
        ],
        "screeningConclusion": [
          "ADVERSE_MEDIA"
        ],
        "status": {
          "createdAt": {
            "date": 123,
            "day": 123,
            "hours": 123,
            "minutes": 123,
            "month": 123,
            "nanos": 123,
            "seconds": 123,
            "time": 123,
            "timezoneOffset": 123,
            "year": 123
          },
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          },
          "id": 123,
          "profileId": 123,
          "screeningId": 123,
          "status": {},
          "updatedAt": {
            "date": 123,
            "day": 123,
            "hours": 123,
            "minutes": 123,
            "month": 123,
            "nanos": 123,
            "seconds": 123,
            "time": 123,
            "timezoneOffset": 123,
            "year": 123
          },
          "updatedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          }
        },
        "updatedAt": {
          "date": 123,
          "day": 123,
          "hours": 123,
          "minutes": 123,
          "month": 123,
          "nanos": 123,
          "seconds": 123,
          "time": 123,
          "timezoneOffset": 123,
          "year": 123
        },
        "updatedBy": {
          "email": "<string>",
          "firstName": "<string>",
          "fullName": "<string>",
          "id": 123,
          "lastName": "<string>"
        },
        "valid": true
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}
This endpoint returns the latest screening summary for a Primary Customer and all of its associated CRP(s).
  • If multiple screenings were initiated for the same customer, only the most recent one is returned.
  • The response includes a unique screeningId and its status, which indicates whether the screening providers have concluded their checks.

​
Path Parameter

  • customerId — This must be the Primary Customer’s ID.

​
Example Request

curl -X GET "{{backend_url}}/api/customer/{{customerId}}/screen/summary" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

​
Example Success Response

​
Succes code 200

Success Code 200

{
    "content": [
        {
            "customer": {
                "id": 926,
                "createdAt": "2022-07-26T04:28:23.297+00:00",
                "updatedAt": "2022-07-26T04:43:55.636+00:00",
                "createdBy": null,
                "updatedBy": {...},
                "active": true,
                "parentId": null,
                "profileId": 916,
                "type": "CORPORATE",
                "referenceId": null,
                "profileReferenceId": "180162353535F",
                "particular": {...},
                "other": {...},
                "vendorName": null,
                "vendorEntityGuid": null,
                "lastRiskAssessment": null,
                "status": "PENDING",
                "riskRating": "UNKNOWN",
                "roles": [],
                "listRoleAsText": []
            },
            "screening": {
                "id": 1682,
                "createdAt": "2022-07-26T04:41:21.228+00:00",
                "updatedAt": "2022-07-26T04:41:31.086+00:00",
                "createdBy": {...},
                "updatedBy": {...},
                "customerId": 926,
                "finalStatus": "DONE",
                "isPeriodic": null,
                "hasHit": false,
                "status": {
                    "id": 1682,
                    "createdAt": "2022-07-26T04:41:21.252+00:00",
                    "updatedAt": "2022-07-26T04:41:31.056+00:00",
                    "createdBy": {...},
                    "updatedBy": {...},
                    "screeningId": 1682,
                    "customerId": 926,
                    "status": {
                        "DJ": {
                            "status": "DONE",
                            "message": ""
                        },
                        "TR": {
                            "status": "DONE",
                            "message": ""
                        },
                        "ARTEMISCAN": {
                            "status": "DONE",
                            "message": ""
                        },
                        "INTERNET_SEARCH": {
                            "status": "DONE",
                            "message": ""
                        },
                        "OWN_RESTRICTED_LIST": {
                            "status": "DONE",
                            "message": ""
                        }
                    }
                },
                "screenedWith": [
                    "INTERNET_SEARCH",
                    "TR",
                    "DJ",
                    "ARTEMISCAN",
                    "OWN_RESTRICTED_LIST"
                ],
                "screeningConclusion": [
                    "NO_HIT"
                ],
                "valid": true,
                "remarks": null,
                "quickscanName": null,
                "quickscanType": null,
                "additionalInformation": {
                    "djMonitoringCaseId": "2c64f19f-e903-4524-9458-7f5a8117e80b",
                    "djMonitoringTxId": "ad99364f-2c10-4eb4-a405-1c6b45ade42c",
                    "faceCompareDocumentId": null,
                    "faceCompareSelfieId": null,
                    "ocrDocumentId": null
                },
                "ocrInformation": null,
                "facInformation": null
            }
     ],
    "pageable": {
        "sort": {
            "sorted": true,
            "unsorted": false,
            "empty": false
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 20,
        "paged": true,
        "unpaged": false
    },
    "totalPages": 1,
    "totalElements": 1,
    "last": true,
    "size": 20,
    "number": 0,
    "sort": {
        "sorted": true,
        "unsorted": false,
        "empty": false
    },
    "numberOfElements": 1,
    "first": true,
    "empty": false
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-Domain-ID
integer
required

X-Domain-ID

Path Parameters

​
customerId
integer
required

customerId

Query Parameters

​
offset
integer
​
paged
boolean
​
pageNumber
integer
​
pageSize
integer
​
sort.sorted
boolean
​
sort.unsorted
boolean
​
unpaged
boolean

Response

OK

​
content
CustomerScreeningSummaryResponseDto · object[]
​
empty
boolean
​
first
boolean
​
last
boolean
​
number
integer
​
numberOfElements
integer
​
pageable
object
​
size
integer
​
sort
object
​
totalElements
integer
​
totalPages
integer