Artemis Documentation
API Documentation
- GETgetAllCustomers
- POSTcreateNewCustomer
- DELDelete a Customer Related Party (CRP)
- POSTbatchUpload
- GETbatchUpload
- GETgetBatchUploadTemplate
- GETdownloadBatchUploadFile
- GETcheckIfProfileUsedByOthers
- POSTcreateNewCustomerWithCrp
- GETdownloadCustomerCSV
- GETgetProfileListByName
- GETgetScreeningHitPDFReport
- GETgetCustomerDetails
- PUTupdateCustomerProfile
- GETgenerateCustomerAcceptanceForm
- GETgetCustomerAssigneesByCustomerId
- POSTcreateNewAssignee
- GETgetCustomerAssigneesByCustomerIdOnAnotherDomain
- POSTcreateNewAssigneeOnAnotherDomain
- GETgetCustomerAssignee
- PUTupdateCustomerAssignee
- DELdeleteAssignee
- GETgetCustomerCloning
- POSTcloneCustomer
- GETgetCRP
- POSTcreateNewCRP
- GETgetRolesFromCrp
- POSTaddRoleToCrp
- PUTupdateCrpRole
- DELdeleteCRPRole
- GETgetCRPDetails
- PUTupdateCRP
- DELdeleteCrp
- GETgetCustomerShareSameProfile
- GETgenerateCustomerReport
- GETgetAllDocumentsForCustomer
- POSTaddDocument
- GETgetDocumentFromCustomer
- PUTupdateDocument
- DELdeleteDocument
- GETgetFileFromCustomer
- DELdeleteDocumentFile
- PUTupdateOcrResult
- PUTupdateLivenessResult
- PUTupdateFaceCompareResult
- GETownershipCheck
- GETgetCustomerOfCRP
- GETgetRiskAssessment
- POSTchangeApprovalStatus
- GETgetRiskAssessmentHistory
- GETretrieveListOfScreeningDetails
- POSTtriggerScreening
- GETretrieveLatestOfScreeningDetails
- GETgetScreeningStatus
- GETgetScreeningSummary
- GETretrieveScreeningDetails
- PUTupdateScreeningConclusion
- GETgetScreeningHits
- PUTmarkParticularHitAsAMatch
- GETgetAScreeningHit
- PUTchangeODDStatus
- POSTretryScreening
- DELdeleteCustomer
- DELdeleteCustomerOnAnotherDomain
Change Logs
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>'customer-controller
triggerScreening
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>'Documentation Index
Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
OAuth2_Client_CredentialsOAuth2_Password
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
X-Domain-ID
Path Parameters
customerId
Query Parameters
chosenEngines
Available options:
ARTEMISCAN, DJ, FACE_COMPARE, INTERNET_SEARCH, OCR, OWN_RESTRICTED_LIST, TR includeCrp
onlyUpdated
Response
OK
⌘I