Skip to main content
POST
/
api
/
customer
/
{customerId}
/
screen
triggerScreening
curl --request POST \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/screen \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
This endpoint initiates a screening process for a customer. Screening is used to check the customer’s information against the subscribed engine type. Both query parameters are required and must always be provided, set to either true or false:
  • customerId — This must be the Primary Customer’s ID.
  • includeCrp — screen customer only (false) or customer + CRPs (true).
  • onlyUpdated — always run (false) or only run if profile updated (true).

​
⚠️ Important Notice

You must always include both query parameters (includeCrp and onlyUpdated) in the request URL.
Even if the value is false, it still needs to be explicitly set.

​
Example Requests

​
1. Screen Primary Customer Only, it will create new screening

curl -X POST "{{backend_url}}/api/customer/{{customerId}}/screen?includeCrp=false&onlyUpdated=false" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

​
2. Screen Primary Customer + CRPs, it will create new screening

curl -X POST "{{backend_url}}/api/customer/{{customerId}}/screen?includeCrp=true&onlyUpdated=false" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

​
3. Screen Primary Customer Only, create new screening only if updated profile is updated

curl -X POST "{{backend_url}}/api/customer/{{customerId}}/screen?includeCrp=false&onlyUpdated=true" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

​
4. Screen Primary Customer + CRPs, create new screening only if updated profile is updated

curl -X POST "{{backend_url}}/api/customer/{{customerId}}/screen?includeCrp=true&onlyUpdated=true" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"
Success Code 200 will be shown with an empty message if it manages to conduct screening.

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

​
chosenEngines
enum<string>[]

chosenEngines

​
includeCrp
boolean
default:true
required

includeCrp

​
onlyUpdated
boolean
default:true
required

onlyUpdated

Response

OK