Skip to main content
GET
/
api
/
customer
/
{customerId}
/
screen
/
status
getScreeningStatus
curl --request GET \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/status \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
{
  "concluded": true,
  "screeningStatus": "DONE",
  "screeningValid": true
}
This endpoint returns the status and validity of the latest screening for a given Primary Customer. It provides three crucial keys:
  • concluded — final outcome of the screening process (e.g., whether the result indicates a sanction hit, a PEP hit, or no hits at all).
  • screeningValid — a boolean indicating whether the screening result is valid. This will be true unless system errors prevent proper screening.
  • screeningStatus — the current state of the screening process, useful for polling until the screening has finished.

​
Path Parameter

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

​
Example Request

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

​
Example Success Responses

​
✅ Screening Completed and Valid

Below is the following sample JSON response body when it is successful in polling for the validity of the latest screening, which the screening has been completed and it is considered as a valid screening. 
{
  "concluded": false,
  "screeningValid": true,
  "screeningStatus": "DONE"
}

​
⏳ Screening Still Pending

Below is the following sample JSON response body when it is successful in polling for the validity of the latest screening, which the server is still trying to ascertain if the system has completed its screening. 
{
  "concluded": false,
  "screeningValid": false,
  "screeningStatus": "PENDING"
}

​
Notes

This endpoint is useful for polling the system to check when a screening has finished. Once screeningStatus is DONE and screeningValid is true, you can rely on the concluded field for the final outcome. Typical screening statuses may include: PENDING, IN_PROGRESS, DONE, or FAILED.

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

Response

OK

​
concluded
boolean
​
screeningStatus
enum<string>
Available options:
DONE,
FAILED,
NEVER,
PENDING
​
screeningValid
boolean