# Cynopsis API Documentation

## Docs

- [Introduction](https://docs.cynopsis.co/ares/introduction.md): This documentation is for the Ares to Artemis 3.0 integration workflow and also to give a concise description of the modules involved. The left panel shows a list of major workflows. Inside each workflow tab, there will be a sublist shown on the right for more details for each step. The general work…
- [Authentication](https://docs.cynopsis.co/ares/authentication.md): If you have your own application developed for your users, it is likely that you would already have your own authentication system in place. Having users to register an account on your application, then again on Ares for the KYC on-boarding can be an awkward process for the users. The aim of the Int…
- [Download SDK](https://docs.cynopsis.co/ares/liveness-sdk/download.md): Introduction to the Liveness SDK — available for Web, Android, and iOS applications. Download and integrate the SDK into your platform of choice.
- [Get Started](https://docs.cynopsis.co/ares/liveness-sdk/get-started.md): Learn how to get started integrating the Liveness SDK into your app with step-by-step instructions for Web Browser, Android, and iOS platforms.
- [Server integration](https://docs.cynopsis.co/ares/liveness-sdk/server-integration.md)
- [Get started](https://docs.cynopsis.co/ares/ocr/get-started.md)
- [Document verification code](https://docs.cynopsis.co/ares/ocr/document-verification-code.md)
- [Get started](https://docs.cynopsis.co/ares/face-compare/get-started.md)
- [Get Access Token](https://docs.cynopsis.co/ares/get-access-token.md): Get JWT access token from Cynopsis CRM (Demo or Production) using the OAuth2 client_credentials flow. Only the following server URLs are used for this endpoint:   - Demo: https://crm-demo.cynopsis.co   - Production: https://crm.cynopsis.co
- [Perform OCR and IDV](https://docs.cynopsis.co/ares/perform-ocr-and-idv.md): Perform OCR (Optical Character Recognition) and document verification. Requires a Bearer token and domain ID. Use the following URLs depending on your environment:   - Demo: https://d1.cynopsis.co   - Production: https://util.cynopsis.co
- [Perform Face Compare](https://docs.cynopsis.co/ares/perform-face-compare.md): Perform face comparison between two images. Requires Bearer token and domain ID. Use the following URLs depending on your environment:   - Demo: https://d1.cynopsis.co   - Production: https://util.cynopsis.co
- [Liveness - Get Session Token](https://docs.cynopsis.co/ares/liveness--get-session-token.md): Get a session token for liveness check. Requires Bearer token and domain ID. Use the following URLs depending on your environment:   - Demo: https://d1.cynopsis.co   - Production: https://util.cynopsis.co
- [Liveness - Get Session ID](https://docs.cynopsis.co/ares/liveness--get-session-id.md): Get a liveness session ID. Requires Bearer token and domain ID. Use the following URLs depending on your environment:   - Demo: https://d1.cynopsis.co   - Production: https://util.cynopsis.co
- [Liveness - Get Result](https://docs.cynopsis.co/ares/liveness--get-result.md): Get the result of a liveness check using the session ID. Requires Bearer token and domain ID. Use the following URLs depending on your environment:   - Demo: https://d1.cynopsis.co   - Production: https://util.cynopsis.co
- [ Artemis Introduction](https://docs.cynopsis.co/artemis3-api-reference/introduction.md): ARTEMIS is Multiple award-winning KYC case management platform built to handle the full spectrum of AML/KYC/CTF requirements – from onboarding, beneficial ownership discovery, PEPs, sanctions and adverse media screening, continuous risk monitoring, through to case management, audit and reporting. Ar…
- [Error Codes](https://docs.cynopsis.co/artemis3-api-reference/error.md)
- [Authentication](https://docs.cynopsis.co/artemis3-api-reference/authentication.md): Setting up Artemis authentication access
- [Simple Customer Creation Workflow](https://docs.cynopsis.co/artemis3-api-reference/workflow.md)
- [Comprehensive Customer Creation Workflow](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/overview.md): End-to-end guide to create a customer, attach CRPs/documents, and run screening.
- [Create a Primary Customer](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/1-create-primary.md)
- [Create an Individual Primary Customer](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/1a-create-individual-primary.md)
- [Create a Corporate Primary Customer](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/1b-create-corporate-primary.md)
- [Create a CRP](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/2-create-crp.md)
- [Create CRP with Existing Profile](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/2c-create-crp-with-existing-profile.md)
- [Create an Individual CRP](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/2a-create-individual-crp.md)
- [Create a Corporate CRP](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/2b-create-corporate-crp.md)
- [Step 3 — Get Customer or CRP](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/3-get-customer-or-crp.md)
- [Step 3a — Get All Primary Customers](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/3a-get-all-primary-customers.md)
- [Step 3b — Get a Single Primary Customer](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/3b-get-single-primary-customer.md)
- [Step 3c — Get CRPs of a Customer](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/3c-get-crps-of-a-customer.md)
- [Step 4 — Document Management](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/4-append-document-to-customer.md)
- [4a - Append Document to Customer](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/4a-append-document-to-customer.md)
- [4b — Get Documents from Customer](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/4b-get-documents-from-customer.md)
- [Step 5 — Screening](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/5-screening.md)
- [Step 5a — Screen Customer and CRPs](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/5a-screen-customer-and-crps.md)
- [Step 5b — Get Summary of Latest Screening](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/5b-summary-latest-screening.md)
- [Step 5c — Get Status and Validity of Latest Screening](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/5c-status-validity.md)
- [Step 5d — Get Hit Details from Latest Screening](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/5d-get-hits-from-customer-screening.md)
- [Step 5e — Conclude Screening Results](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/5e-conclude-hits.md)
- [Step 5f — Update Screening Conclusion](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/5f-update-screening-conclusion.md)
- [Step 6 — Risk Assessment](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/6-risk-report.md)
- [Step 6a — Get Most Recent Detailed Risk Report of Customer](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/6a-get-latest-risk-report.md)
- [Step 6b — Set Risk Rating and Approval Status of a Customer's Risk Assessment](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/6b-update-risk-rating-approval-status.md)
- [Step 6c — Get All Previous Audit Trail for Risk Assessment](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/6c-get-audittrail-for-risk.md)
- [Using Batch Upload to Onboard Customers](https://docs.cynopsis.co/artemis3-api-reference/customer-comprehensive/batch-upload-customers.md)
- [Get All Customer List](https://docs.cynopsis.co/artemis3-api-reference/customer-related-apis/get-all-customers.md)
- [Search Profile for CRP Creation](https://docs.cynopsis.co/artemis3-api-reference/customer-related-apis/search-profile-for-crp.md)
- [Delete a Primary Customer](https://docs.cynopsis.co/artemis3-api-reference/customer-related-apis/delete-primary-customer.md)
- [Delete a Customer Related Party (CRP)](https://docs.cynopsis.co/artemis3-api-reference/customer-related-apis/delete-crp.md)
- [Own Restricted List](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-apis/own-restricted-list.md)
- [Post New Restricted List](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-apis/post-new-own-restricted-list.md)
- [Post Name into Restricted List](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-apis/post-name-into-restricted-list.md)
- [Get All Restricted List](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-apis/get-all-restricted-list.md)
- [Get Restricted Name Entries](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-apis/get-all-restricted-name.md)
- [Quick Scan](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-apis/quick-scan.md)
- [Get Quick Scan List](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-apis/get-quick-scan-list.md)
- [Trigger Quick Scan Screening](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-apis/post-quick-scan-screen.md)
- [Get Quick Scan Screening](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-apis/get-quick-scan-screening.md)
- [Get Quick Scan Screening Hits](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-apis/get-quick-scan-screening-hits.md)
- [A. PUT OCR result into Artemis](https://docs.cynopsis.co/artemis3-api-reference/update-ocr-liveness-fac-result-api/put-ocr-result.md)
- [B. PUT Liveness result into Artemis](https://docs.cynopsis.co/artemis3-api-reference/update-ocr-liveness-fac-result-api/put-liveness-result.md)
- [C. PUT Face Compare result into Artemis](https://docs.cynopsis.co/artemis3-api-reference/update-ocr-liveness-fac-result-api/put-fac-result.md)
- [Artemis Customer Callback Specification](https://docs.cynopsis.co/artemis3-api-reference/customer-callback/callback-specification.md): HTTP callback that Artemis sends to your endpoint when a customer record is created or when its status changes.
- [Get Country List](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-countries-list.md)
- [Get Industry List](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-industry-list.md)
- [Get Occupation List](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-occupation-list.md)
- [Get Identity Document Types](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-identity-document-types.md)
- [Get Source Of Funds](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-source-of-funds.md)
- [Get Source Of Wealth](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-source-of-wealth.md)
- [Get Entity Types](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-entity-types.md)
- [Get Ownership Layers](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-ownership-layers.md)
- [Get Product Service Complexities](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-product-service-complexities.md)
- [Get Onboarding Modes](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-onboarding-modes.md)
- [Get Payment Modes](https://docs.cynopsis.co/artemis3-api-reference/static-list-retrieval-apis/get-payment-modes.md)
- [getOnGoingDueDiligentAggregationSummary](https://docs.cynopsis.co/artemis3-api-reference/on-going-due-diligent-controller/getongoingduediligentaggregationsummary.md)
- [getAllConfigs](https://docs.cynopsis.co/artemis3-api-reference/app-config-controller/getallconfigs.md)
- [getConfigsByKeys](https://docs.cynopsis.co/artemis3-api-reference/app-config-controller/getconfigsbykeys.md)
- [getCreditInfo](https://docs.cynopsis.co/artemis3-api-reference/app-config-controller/getcreditinfo.md)
- [getConfigByKey](https://docs.cynopsis.co/artemis3-api-reference/app-config-controller/getconfigbykey.md)
- [checkAssignedSource](https://docs.cynopsis.co/artemis3-api-reference/asia-verify-controller/checkassignedsource.md)
- [getAsiaVerifyAuthToken](https://docs.cynopsis.co/artemis3-api-reference/asia-verify-controller/getasiaverifyauthtoken.md)
- [requestEntityProfileReport](https://docs.cynopsis.co/artemis3-api-reference/asia-verify-controller/requestentityprofilereport.md)
- [getRequestedProfile](https://docs.cynopsis.co/artemis3-api-reference/asia-verify-controller/getrequestedprofile.md)
- [importAsiaVerifyProfileReportToDb](https://docs.cynopsis.co/artemis3-api-reference/asia-verify-controller/importasiaverifyprofilereporttodb.md)
- [searchForEntityWithBasicSearch](https://docs.cynopsis.co/artemis3-api-reference/asia-verify-controller/searchforentitywithbasicsearch.md)
- [getAllPermissions](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/getallpermissions.md)
- [getAllRoles](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/getallroles.md)
- [createRole](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/createrole.md)
- [getAllRolesNoPagination](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/getallrolesnopagination.md)
- [getRoleById](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/getrolebyid.md)
- [updateRole](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/updaterole.md)
- [deleteRole](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/deleterole.md)
- [getAllUsersPermissionAndRoles](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/getalluserspermissionandroles.md)
- [getASingleUsersPermissionAndRoles](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/getasingleuserspermissionandroles.md)
- [addUserPermission](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/adduserpermission.md)
- [addUserPermissionBatch](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/adduserpermissionbatch.md)
- [removeUserPermission](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/removeuserpermission.md)
- [addUserRole](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/adduserrole.md)
- [removeUserRole](https://docs.cynopsis.co/artemis3-api-reference/authentication-manager-controller/removeuserrole.md)
- [changePassword](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/changepassword.md)
- [getFirstTimeMfaCodeInfo](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/getfirsttimemfacodeinfo.md)
- [firstTimeActivatePassword](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/firsttimeactivatepassword.md)
- [forgetPassword](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/forgetpassword.md)
- [getForgetPasswordInfo](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/getforgetpasswordinfo.md)
- [activateForgetPasswordProcess](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/activateforgetpasswordprocess.md)
- [login](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/login.md)
- [loginWithMfa](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/loginwithmfa.md)
- [redeemRefreshToken](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/redeemrefreshtoken.md)
- [getAccessToken](https://docs.cynopsis.co/artemis3-api-reference/authentication-controller/getaccesstoken.md)
- [addNewComments](https://docs.cynopsis.co/artemis3-api-reference/comment-controller/addnewcomments.md)
- [getAllComment](https://docs.cynopsis.co/artemis3-api-reference/comment-controller/getallcomment.md)
- [updateComment](https://docs.cynopsis.co/artemis3-api-reference/comment-controller/updatecomment.md)
- [deleteComment](https://docs.cynopsis.co/artemis3-api-reference/comment-controller/deletecomment.md)
- [getAllCustomers](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getallcustomers.md)
- [createNewCustomer](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/createnewcustomer.md)
- [Delete a Customer Related Party (CRP)](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/delete-a-customer-related-party-crp.md)
- [batchUpload](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/batchupload.md)
- [batchUpload](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/batchupload-1.md)
- [getBatchUploadTemplate](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getbatchuploadtemplate.md)
- [downloadBatchUploadFile](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/downloadbatchuploadfile.md)
- [checkIfProfileUsedByOthers](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/checkifprofileusedbyothers.md)
- [createNewCustomerWithCrp](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/createnewcustomerwithcrp.md)
- [downloadCustomerCSV](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/downloadcustomercsv.md)
- [getProfileListByName](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getprofilelistbyname.md)
- [getScreeningHitPDFReport](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getscreeninghitpdfreport.md)
- [getCustomerDetails](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getcustomerdetails.md)
- [updateCustomerProfile](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/updatecustomerprofile.md)
- [generateCustomerAcceptanceForm](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/generatecustomeracceptanceform.md)
- [getCustomerAssigneesByCustomerId](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getcustomerassigneesbycustomerid.md)
- [createNewAssignee](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/createnewassignee.md)
- [getCustomerAssigneesByCustomerIdOnAnotherDomain](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getcustomerassigneesbycustomeridonanotherdomain.md)
- [createNewAssigneeOnAnotherDomain](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/createnewassigneeonanotherdomain.md)
- [getCustomerAssignee](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getcustomerassignee.md)
- [updateCustomerAssignee](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/updatecustomerassignee.md)
- [deleteAssignee](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/deleteassignee.md)
- [getCustomerCloning](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getcustomercloning.md)
- [cloneCustomer](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/clonecustomer.md)
- [getCRP](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getcrp.md)
- [createNewCRP](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/createnewcrp.md)
- [getRolesFromCrp](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getrolesfromcrp.md)
- [addRoleToCrp](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/addroletocrp.md)
- [updateCrpRole](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/updatecrprole.md)
- [deleteCRPRole](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/deletecrprole.md)
- [getCRPDetails](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getcrpdetails.md)
- [updateCRP](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/updatecrp.md)
- [deleteCrp](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/deletecrp.md)
- [getCustomerShareSameProfile](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getcustomersharesameprofile.md)
- [generateCustomerReport](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/generatecustomerreport.md)
- [getAllDocumentsForCustomer](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getalldocumentsforcustomer.md)
- [addDocument](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/adddocument.md)
- [getDocumentFromCustomer](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getdocumentfromcustomer.md)
- [updateDocument](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/updatedocument.md)
- [deleteDocument](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/deletedocument.md)
- [getFileFromCustomer](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getfilefromcustomer.md)
- [deleteDocumentFile](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/deletedocumentfile.md)
- [updateOcrResult](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/updateocrresult.md)
- [updateLivenessResult](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/updatelivenessresult.md)
- [updateFaceCompareResult](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/updatefacecompareresult.md)
- [ownershipCheck](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/ownershipcheck.md)
- [getCustomerOfCRP](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getcustomerofcrp.md)
- [getRiskAssessment](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getriskassessment.md)
- [changeApprovalStatus](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/changeapprovalstatus.md)
- [getRiskAssessmentHistory](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getriskassessmenthistory.md)
- [retrieveListOfScreeningDetails](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/retrievelistofscreeningdetails.md)
- [triggerScreening](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/triggerscreening.md)
- [retrieveLatestOfScreeningDetails](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/retrievelatestofscreeningdetails.md)
- [getScreeningStatus](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getscreeningstatus.md)
- [getScreeningSummary](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getscreeningsummary.md)
- [retrieveScreeningDetails](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/retrievescreeningdetails.md)
- [updateScreeningConclusion](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/updatescreeningconclusion.md)
- [getScreeningHits](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getscreeninghits.md)
- [markParticularHitAsAMatch](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/markparticularhitasamatch.md)
- [getAScreeningHit](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/getascreeninghit.md)
- [changeODDStatus](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/changeoddstatus.md)
- [retryScreening](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/retryscreening.md)
- [deleteCustomer](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/deletecustomer.md)
- [deleteCustomerOnAnotherDomain](https://docs.cynopsis.co/artemis3-api-reference/customer-controller/deletecustomeronanotherdomain.md)
- [getExpiringDocumentCustomerForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getexpiringdocumentcustomerfordashboard.md)
- [getManagerOddForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getmanageroddfordashboard.md)
- [getManagerPRForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getmanagerprfordashboard.md)
- [getRiskRatingManagerStats](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getriskratingmanagerstats.md)
- [getStatusManagerStats](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getstatusmanagerstats.md)
- [getCustomerForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getcustomerfordashboard.md)
- [getManagerTaskStats](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getmanagertaskstats.md)
- [getTaskDistributionRequestHeader](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/gettaskdistributionrequestheader.md)
- [getPendingCustomerForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getpendingcustomerfordashboard.md)
- [getTasksByUser](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/gettasksbyuser.md)
- [getManagerExpiringDocumentCustomerForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getmanagerexpiringdocumentcustomerfordashboard.md)
- [getOddForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getoddfordashboard.md)
- [getPendingMyTaskCustomerForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getpendingmytaskcustomerfordashboard.md)
- [getPRForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getprfordashboard.md)
- [getStatusStats](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getstatusstats.md)
- [getCustomerForDashboard](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/getcustomerfordashboard-1.md)
- [getTaskStats](https://docs.cynopsis.co/artemis3-api-reference/dashboard-controller/gettaskstats.md)
- [getDomainList](https://docs.cynopsis.co/artemis3-api-reference/domain-controller/getdomainlist.md)
- [error](https://docs.cynopsis.co/artemis3-api-reference/basic-error-controller/error.md)
- [error](https://docs.cynopsis.co/artemis3-api-reference/basic-error-controller/error-1.md)
- [error](https://docs.cynopsis.co/artemis3-api-reference/basic-error-controller/error-2.md)
- [error](https://docs.cynopsis.co/artemis3-api-reference/basic-error-controller/error-3.md)
- [Error 4](https://docs.cynopsis.co/artemis3-api-reference/basic-error-controller/error-4.md)
- [Error 5](https://docs.cynopsis.co/artemis3-api-reference/basic-error-controller/error-5.md)
- [error](https://docs.cynopsis.co/artemis3-api-reference/basic-error-controller/error-6.md)
- [getExpiredDocumentWithCursorPaginate](https://docs.cynopsis.co/artemis3-api-reference/expiring-document-controller/getexpireddocumentwithcursorpaginate.md)
- [checkHandShakeBalance](https://docs.cynopsis.co/artemis3-api-reference/hand-shake-controller/checkhandshakebalance.md)
- [checkAssignedSource](https://docs.cynopsis.co/artemis3-api-reference/hand-shake-controller/checkassignedsource.md)
- [loginToHandShake](https://docs.cynopsis.co/artemis3-api-reference/hand-shake-controller/logintohandshake.md)
- [requestEntityProfileReport](https://docs.cynopsis.co/artemis3-api-reference/hand-shake-controller/requestentityprofilereport.md)
- [getRequestedProfile](https://docs.cynopsis.co/artemis3-api-reference/hand-shake-controller/getrequestedprofile.md)
- [importHandShakeProfileReportToDb](https://docs.cynopsis.co/artemis3-api-reference/hand-shake-controller/importhandshakeprofilereporttodb.md)
- [importHandShakeProfileReportToDb](https://docs.cynopsis.co/artemis3-api-reference/hand-shake-controller/importhandshakeprofilereporttodb-1.md)
- [searchForEntityWithBasicSearch](https://docs.cynopsis.co/artemis3-api-reference/hand-shake-controller/searchforentitywithbasicsearch.md)
- [getFileFromCustomer](https://docs.cynopsis.co/artemis3-api-reference/media-controller/getfilefromcustomer.md)
- [getLists](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/getlists.md)
- [createList](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/createlist.md)
- [getListDetails](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/getlistdetails.md)
- [updateList](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/updatelist.md)
- [deleteList](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/deletelist.md)
- [activateList](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/activatelist.md)
- [getRestrictedNames](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/getrestrictednames.md)
- [addRestrictedName](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/addrestrictedname.md)
- [getRestrictedNameDetail](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/getrestrictednamedetail.md)
- [updateRestrictedName](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/updaterestrictedname.md)
- [deleteRestrictedName](https://docs.cynopsis.co/artemis3-api-reference/own-restricted-list-controller/deleterestrictedname.md)
- [getPRWithCursorPagination](https://docs.cynopsis.co/artemis3-api-reference/periodic-review-controller/getprwithcursorpagination.md)
- [getQuickScan](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-controller/getquickscan.md)
- [triggerQuickScan](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-controller/triggerquickscan.md)
- [triggerBatchQuickScan](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-controller/triggerbatchquickscan.md)
- [getQuickScan](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-controller/getquickscan-1.md)
- [getQuickScanHit](https://docs.cynopsis.co/artemis3-api-reference/quick-scan-controller/getquickscanhit.md)
- [getAllUsers](https://docs.cynopsis.co/artemis3-api-reference/user-controller/getallusers.md)
- [createUser](https://docs.cynopsis.co/artemis3-api-reference/user-controller/createuser.md)
- [enableUserMfa](https://docs.cynopsis.co/artemis3-api-reference/user-controller/enableusermfa.md)
- [getCurrentUser](https://docs.cynopsis.co/artemis3-api-reference/user-controller/getcurrentuser.md)
- [getUserMfa](https://docs.cynopsis.co/artemis3-api-reference/user-controller/getusermfa.md)
- [getCurrentUserPermission](https://docs.cynopsis.co/artemis3-api-reference/user-controller/getcurrentuserpermission.md)
- [getPermittedUserFromDomainId](https://docs.cynopsis.co/artemis3-api-reference/user-controller/getpermitteduserfromdomainid.md)
- [getPermittedUserFromAnotherDomainId](https://docs.cynopsis.co/artemis3-api-reference/user-controller/getpermitteduserfromanotherdomainid.md)
- [getAllUsersByRole](https://docs.cynopsis.co/artemis3-api-reference/user-controller/getallusersbyrole.md)
- [getAllUsersByRoleNoPagination](https://docs.cynopsis.co/artemis3-api-reference/user-controller/getallusersbyrolenopagination.md)
- [getUserInfo](https://docs.cynopsis.co/artemis3-api-reference/user-controller/getuserinfo.md)
- [Version 1.60.0](https://docs.cynopsis.co/changelog.md)
- [ Athena Introduction](https://docs.cynopsis.co/athena-api-reference/introduction.md): ATHENA is an advanced real-time transaction monitoring solution designed to detect and prevent money laundering, fraud, and terrorism financing. Powered by proprietary AML rules, ATHENA analyzes transactions in real time, providing clear, intuitive visual insights to streamline compliance processes.
- [Error Codes](https://docs.cynopsis.co/athena-api-reference/error.md)
- [General Workflow](https://docs.cynopsis.co/athena-api-reference/workflow.md)
- [Authentication](https://docs.cynopsis.co/athena-api-reference/authentication.md): Setting up Athena authentication access
- [Defining the Master Currency](https://docs.cynopsis.co/athena-api-reference/master_currency.md)
- [Enroll Customer](https://docs.cynopsis.co/athena-api-reference/add_subject.md): Subject(s) - Enrolling of customer profiles
- [Retrieve all existing Customers](https://docs.cynopsis.co/athena-api-reference/get_subjects.md)
- [Retrieve existing Customer](https://docs.cynopsis.co/athena-api-reference/get_subject_by_id.md): Retrieve a specific subject by its client subject ID.
- [Update an existing Customers](https://docs.cynopsis.co/athena-api-reference/update_subject.md)
- [Blacklist](https://docs.cynopsis.co/athena-api-reference/blacklist.md): A blacklist record is created with the name of the subject and the reference_id, We check for a whitelist record with the blacklist name before adding to blacklist
- [Retrieve Blacklists](https://docs.cynopsis.co/athena-api-reference/get_blacklist.md)
- [Retrieve existing Blacklist](https://docs.cynopsis.co/athena-api-reference/get_blacklist_by_id.md)
- [Update Blacklist](https://docs.cynopsis.co/athena-api-reference/update_blacklist.md): Updating existing Blacklist Record
- [Delete Blacklist](https://docs.cynopsis.co/athena-api-reference/delete_blacklist.md): Deleting a blacklist record
- [3. Add Bucket](https://docs.cynopsis.co/athena-api-reference/add_bucket.md): Bucket(s) - Segmentation to suit different customer or transaction profiles
- [Retrieve all Buckets](https://docs.cynopsis.co/athena-api-reference/get_buckets.md): Retrieving existing Bucket(s)
- [Retrieve existing Bucket by ID](https://docs.cynopsis.co/athena-api-reference/get_bucket_by_id.md): Retrieve a specific bucket by its id
- [Retrieve existing Bucket by Name](https://docs.cynopsis.co/athena-api-reference/get_bucket_by_name.md): Retrieve a specific bucket by its name
- [Update an existing Bucket](https://docs.cynopsis.co/athena-api-reference/update_bucket.md): Update a bucket by its ID.
- [Delete Bucket](https://docs.cynopsis.co/athena-api-reference/delete_bucket.md): Delete a bucket by its ID, The bucket will be deactivated.
- [Rule](https://docs.cynopsis.co/athena-api-reference/add_rule.md): Update a bucket by its ID.
- [Rule Settings](https://docs.cynopsis.co/athena-api-reference/rule_settings.md): Update a bucket by its ID.
- [Rule Alert Settings](https://docs.cynopsis.co/athena-api-reference/rule_alert_setting.md)
- [Rule Information](https://docs.cynopsis.co/athena-api-reference/rule_information.md)
- [Transaction](https://docs.cynopsis.co/athena-api-reference/add_transaction.md): Once the above steps have been completed, you may proceed to upload your transactions into Athena for screening. Please note that once transactions are uploaded into Athena, screening will be done **immediately**.
- [Retrieve Transactions](https://docs.cynopsis.co/athena-api-reference/get_transactions.md): Retrieving existing Transaction(s)
- [Retrieve existing transaction](https://docs.cynopsis.co/athena-api-reference/get_transaction_by_id.md): Users can retrieve a specific transaction by specifying the **client_transaction_id** on the following API.
- [Bucket Content](https://docs.cynopsis.co/athena-api-reference/add_bucketcontent.md): Populate existing transaction into other buckets on an ad-hoc basis.
- [Case](https://docs.cynopsis.co/athena-api-reference/case.md)
- [Retrieve Case(s)](https://docs.cynopsis.co/athena-api-reference/get_case.md): Retrieving existing Case(s) using Query
- [Retrieve existing Case](https://docs.cynopsis.co/athena-api-reference/get_case_by_id.md)
- [Retrieve existing Transactions by Case id](https://docs.cynopsis.co/athena-api-reference/get_case_by_id_transactions.md): Retrieve transactions associated with a specific case, including both direct case transactions and relevant transactions based on rule parameters.
- [Configure Case Alert Priority](https://docs.cynopsis.co/athena-api-reference/case_alert.md): Update the alert risk rating for a specific case.
- [Assign Case Maker](https://docs.cynopsis.co/athena-api-reference/case_maker.md): Assign a case to a maker.
- [Assign Case Checker](https://docs.cynopsis.co/athena-api-reference/case_checker.md): Assign a case to a checker.
- [Add Approval for a Case](https://docs.cynopsis.co/athena-api-reference/case_approval.md): Approve a case.
- [Add Case Finding(s)](https://docs.cynopsis.co/athena-api-reference/case_finding.md): Add new findings to a case to give other users more context on a particular case.
- [Delete Case Finding(s)](https://docs.cynopsis.co/athena-api-reference/delete_case_finding.md): Delete existing Case Findings in a Case
- [Reopen a Case](https://docs.cynopsis.co/athena-api-reference/case_reopen.md): Reopen a case.
- [Add Case Document(s)](https://docs.cynopsis.co/athena-api-reference/add_case_document.md): Add Document into a Case
- [Delete Case Document](https://docs.cynopsis.co/athena-api-reference/delete_case_document.md): Delete existing Case Document in a Case
- [Case Status List](https://docs.cynopsis.co/athena-api-reference/get_case_status.md): Retrieve Case Status List
- [Export CSV File for Cases](https://docs.cynopsis.co/athena-api-reference/get_case_csv.md): Sends an email with the csv file attached.
- [Bulk Assign](https://docs.cynopsis.co/athena-api-reference/case_bulk_assign.md): Assign multiple cases to a specific assignee.
- [Transaction Screening Workflow](https://docs.cynopsis.co/athena-api-reference/workflow_transaction_screening.md)
- [Review Hits](https://docs.cynopsis.co/athena-api-reference/ts_review_hits.md)
- [Get Screening Review](https://docs.cynopsis.co/athena-api-reference/ts_get_screening_review.md): Retrieve detailed screening review information for a pre-approved transaction.
- [Mark Hits](https://docs.cynopsis.co/athena-api-reference/ts_mark_hits.md): Selectively assess specific screening hits by their IDs.
- [Cascade Mark Hits](https://docs.cynopsis.co/athena-api-reference/ts_mark_hits_cascade.md): Cascade assessment to all hits matching a specific subject, external ID, and engine.
- [Approve or Reject Transaction](https://docs.cynopsis.co/athena-api-reference/ts_approve_reject.md): Approve or reject a pre-approved transaction after reviewing its screening hits.
- [Retrieve Pre-Approved Transactions](https://docs.cynopsis.co/athena-api-reference/ts_get_preapproved_transactions.md): Retrieve all pre-approved transactions.
- [Retrieve Pre-Approved Transaction by ID](https://docs.cynopsis.co/athena-api-reference/ts_get_preapproved_by_id.md): Retrieve a specific pre-approved transaction by its ID.
- [Retrieve Active Pre-Approved Transactions](https://docs.cynopsis.co/athena-api-reference/ts_get_preapproved_active.md): Retrieve pre-approved transactions that are currently active.
- [Retrieve Inactive Pre-Approved Transactions](https://docs.cynopsis.co/athena-api-reference/ts_get_preapproved_inactive.md): Retrieve pre-approved transactions that are inactive.
- [List case ageing distribution](https://docs.cynopsis.co//athena-api-reference/ageing/list-case-ageing-distribution.md): Retrieve case ageing distribution across all cases.
- [Retrieve case ageing data for a specific user](https://docs.cynopsis.co//athena-api-reference/ageing/retrieve-case-ageing-data-for-a-specific-user.md): Fetch ageing distribution of cases assigned to a specific user.
- [Get App Config](https://docs.cynopsis.co//athena-api-reference/app-config/get-app-config.md): This endpoint returns the value of the app config key.
- [Get Metabase analytics URL](https://docs.cynopsis.co//athena-api-reference/app-config/get-metabase-analytics-url.md): This endpoint returns the Metabase analytics URL for the dashboard ID configured in the database. The URL is valid for 1 hour.
- [List users ordered by email](https://docs.cynopsis.co//athena-api-reference/user/list-users-ordered-by-email.md)
- [Retrieve a single user by id](https://docs.cynopsis.co//athena-api-reference/user/retrieve-a-single-user-by-id.md)
- [Login](https://docs.cynopsis.co//athena-api-reference/user/login.md): Login with email, We use an authentication mechanism that is based on AWS Cognito, So we do not store the password in our database, to validate the user, we will check if the email exists in our database in addition to that the user should be active
- [Logout](https://docs.cynopsis.co//athena-api-reference/user/logout.md): Logout a user by revoking the token from AWS Cognito
- [List users](https://docs.cynopsis.co//athena-api-reference/user/list-users.md)
- [Create user](https://docs.cynopsis.co//athena-api-reference/user/create-user.md)
- [Retrieve user](https://docs.cynopsis.co//athena-api-reference/user/retrieve-user.md)
- [Delete user](https://docs.cynopsis.co//athena-api-reference/user/delete-user.md): Logical Deletion a user, When a user is deleted, the user will be marked as inactive, and the user will not be able to log in anymore, all of the user's permissions will be removed, a possible email will be sent to the admin to notify that a user has been deleted
- [Update user](https://docs.cynopsis.co//athena-api-reference/user/update-user.md): Update user information including name, email, groups, and permissions.
- [List all Blacklist records](https://docs.cynopsis.co//athena-api-reference/blacklist/list-all-blacklist-records.md)
- [Create a Blacklist record](https://docs.cynopsis.co//athena-api-reference/blacklist/create-a-blacklist-record.md): A blacklist record is created with the name of the subject and the reference_id, We check for a whitelist record with the blacklist name before adding to blacklist
- [Retrieve a Blacklist record](https://docs.cynopsis.co//athena-api-reference/blacklist/retrieve-a-blacklist-record.md)
- [Deactivate a Blacklist record](https://docs.cynopsis.co//athena-api-reference/blacklist/deactivate-a-blacklist-record.md)
- [Update a Blacklist record](https://docs.cynopsis.co//athena-api-reference/blacklist/update-a-blacklist-record.md)
- [List all transaction in buckets](https://docs.cynopsis.co//athena-api-reference/bucket-content/list-all-transaction-in-buckets.md): Retrieve a list of all transaction buckets with optional filtering.
- [Insert a transaction into a bucket](https://docs.cynopsis.co//athena-api-reference/bucket-content/insert-a-transaction-into-a-bucket.md): Insert a transaction into specified buckets by client transaction ID.
- [List all buckets](https://docs.cynopsis.co//athena-api-reference/buckets/list-all-buckets.md)
- [Create a bucket](https://docs.cynopsis.co//athena-api-reference/buckets/create-a-bucket.md): Create a new bucket.
- [Retrieve a specific bucket](https://docs.cynopsis.co//athena-api-reference/buckets/retrieve-a-specific-bucket.md): Retrieve a specific bucket by its ID.
- [Delete a bucket](https://docs.cynopsis.co//athena-api-reference/buckets/delete-a-bucket.md): Delete a bucket by its ID, The bucket will be deactivated.
- [Update a bucket](https://docs.cynopsis.co//athena-api-reference/buckets/update-a-bucket.md): Update a bucket by its ID.
- [Export transactions to CSV for a bucket](https://docs.cynopsis.co//athena-api-reference/buckets/export-transactions-to-csv-for-a-bucket.md): Export transactions to a CSV file for a specific bucket with optional date range filtering, An email will be sent to you, including the CSV file.
- [List all cases](https://docs.cynopsis.co//athena-api-reference/case/list-all-cases.md): Retrieve a list of all cases with optional filtering and ordering.
- [Retrieve a specific case](https://docs.cynopsis.co//athena-api-reference/case/retrieve-a-specific-case.md)
- [Delete a specific case](https://docs.cynopsis.co//athena-api-reference/case/delete-a-specific-case.md): Delete a specific case by its ID. A soft delete is performed.
- [Update a specific case](https://docs.cynopsis.co//athena-api-reference/case/update-a-specific-case.md)
- [Update alert risk rating for a case](https://docs.cynopsis.co//athena-api-reference/case/update-alert-risk-rating-for-a-case.md): Update the alert risk rating for a specific case.
- [Approve a case](https://docs.cynopsis.co//athena-api-reference/case/approve-a-case.md): Approve a case.
- [Assign a case to a checker](https://docs.cynopsis.co//athena-api-reference/case/assign-a-case-to-a-checker.md): Assign a case to a checker.
- [Assign a case to a maker](https://docs.cynopsis.co//athena-api-reference/case/assign-a-case-to-a-maker.md): Assign a case to a maker.
- [Delete document from a case](https://docs.cynopsis.co//athena-api-reference/case/delete-document-from-a-case.md): Delete a document from a specific case by its ID.
- [Delete findings from a case](https://docs.cynopsis.co//athena-api-reference/case/delete-findings-from-a-case.md): Delete findings from a specific case by its ID.
- [Add document to a case](https://docs.cynopsis.co//athena-api-reference/case/add-document-to-a-case.md): Add a document to a specific case by its ID.
- [Add findings to a case](https://docs.cynopsis.co//athena-api-reference/case/add-findings-to-a-case.md): Add findings to a specific case by its ID.
- [Generate case report](https://docs.cynopsis.co//athena-api-reference/case/generate-case-report.md): Generate a case report for a specific case by its ID. The report will be sent to the user's email.
- [Reopen a case](https://docs.cynopsis.co//athena-api-reference/case/reopen-a-case.md): Reopen a case.
- [Add report code to a case](https://docs.cynopsis.co//athena-api-reference/case/add-report-code-to-a-case.md): Add a report code to a specific case by its ID.
- [Add report indicator to a case](https://docs.cynopsis.co//athena-api-reference/case/add-report-indicator-to-a-case.md): Add a report indicator to a specific case by its ID.
- [List transactions for a specific case](https://docs.cynopsis.co//athena-api-reference/case/list-transactions-for-a-specific-case.md): Retrieve transactions associated with a specific case, including both direct case transactions and relevant transactions based on rule parameters.
- [Get active cases](https://docs.cynopsis.co//athena-api-reference/case/get-active-cases.md): Retrieve a list of active cases, A case is considered active if its status is not TRUE_HIT nor FALSE_HIT.
- [Get active cases statistics](https://docs.cynopsis.co//athena-api-reference/case/get-active-cases-statistics.md)
- [Get cases by assignee](https://docs.cynopsis.co//athena-api-reference/case/get-cases-by-assignee.md): Retrieve statistics for cases grouped by assignee.
- [Get cases by bucket](https://docs.cynopsis.co//athena-api-reference/case/get-cases-by-bucket.md): Retrieve statistics for cases grouped by bucket.
- [Bulk assign cases](https://docs.cynopsis.co//athena-api-reference/case/bulk-assign-cases.md): Assign multiple cases to a specific assignee.
- [Get case status options](https://docs.cynopsis.co//athena-api-reference/case/get-case-status-options.md): Retrieve a list of all case status options, including their key and value.
- [Get closed cases](https://docs.cynopsis.co//athena-api-reference/case/get-closed-cases.md): Retrieve statistics for closed cases, A case is considered closed if it is in either TRUE_HIT or FALSE_HIT status.
- [Export cases to CSV](https://docs.cynopsis.co//athena-api-reference/case/export-cases-to-csv.md): Export cases to a CSV file, A CSV file will be generated and sent to the user's email.
- [Get inactive cases](https://docs.cynopsis.co//athena-api-reference/case/get-inactive-cases.md): Retrieve a list of inactive cases.
- [Get cases by priority](https://docs.cynopsis.co//athena-api-reference/case/get-cases-by-priority.md): Retrieve statistics for cases grouped by priority.
- [Get cases by rule](https://docs.cynopsis.co//athena-api-reference/case/get-cases-by-rule.md): Retrieve statistics for cases grouped by rule.
- [Get cases by status](https://docs.cynopsis.co//athena-api-reference/case/get-cases-by-status.md): Retrieve statistics for cases grouped by status.
- [Get cases timeline](https://docs.cynopsis.co//athena-api-reference/case/get-cases-timeline.md): Retrieve a timeline of cases.
- [Get violations statistics](https://docs.cynopsis.co//athena-api-reference/case/get-violations-statistics.md)
- [Retrieve a list of currencies](https://docs.cynopsis.co//athena-api-reference/currency/retrieve-a-list-of-currencies.md)
- [Retrieve a specific currency](https://docs.cynopsis.co//athena-api-reference/currency/retrieve-a-specific-currency.md)
- [List groups](https://docs.cynopsis.co//athena-api-reference/group/list-groups.md)
- [Create group](https://docs.cynopsis.co//athena-api-reference/group/create-group.md)
- [Retrieve group](https://docs.cynopsis.co//athena-api-reference/group/retrieve-group.md)
- [Delete group](https://docs.cynopsis.co//athena-api-reference/group/delete-group.md)
- [Update group](https://docs.cynopsis.co//athena-api-reference/group/update-group.md)
- [List all permissions](https://docs.cynopsis.co//athena-api-reference/permission/list-all-permissions.md)
- [Retrieve a single permission by id](https://docs.cynopsis.co//athena-api-reference/permission/retrieve-a-single-permission-by-id.md)
- [Retrieve a list of risk assessments](https://docs.cynopsis.co//athena-api-reference/risk-assessment/retrieve-a-list-of-risk-assessments.md)
- [Retrieve a specific risk assessment](https://docs.cynopsis.co//athena-api-reference/risk-assessment/retrieve-a-specific-risk-assessment.md)
- [List all RuleAlert records](https://docs.cynopsis.co//athena-api-reference/rulealert/list-all-rulealert-records.md)
- [Retrieve a RuleAlert record](https://docs.cynopsis.co//athena-api-reference/rulealert/retrieve-a-rulealert-record.md)
- [Update a RuleAlert record](https://docs.cynopsis.co//athena-api-reference/rulealert/update-a-rulealert-record.md)
- [List all rule information](https://docs.cynopsis.co//athena-api-reference/rule-detail/list-all-rule-information.md)
- [Retrieve a rule information](https://docs.cynopsis.co//athena-api-reference/rule-detail/retrieve-a-rule-information.md)
- [Update a rule information record](https://docs.cynopsis.co//athena-api-reference/rule-detail/update-a-rule-information-record.md)
- [Get profile information](https://docs.cynopsis.co//athena-api-reference/profile-info/get-profile-information.md)
- [Retrieve subject information by client_subject_id](https://docs.cynopsis.co//athena-api-reference/subject-info/retrieve-subject-information-by-client_subject_id.md)
- [List all subjects](https://docs.cynopsis.co//athena-api-reference/subjects/list-all-subjects.md)
- [Create a subject](https://docs.cynopsis.co//athena-api-reference/subjects/create-a-subject.md)
- [Retrieve a specific subject](https://docs.cynopsis.co//athena-api-reference/subjects/retrieve-a-specific-subject.md): Retrieve a specific subject by its client subject ID.
- [Update a subject](https://docs.cynopsis.co//athena-api-reference/subjects/update-a-subject.md)
- [Generate subject report](https://docs.cynopsis.co//athena-api-reference/subjects/generate-subject-report.md): Generate a report for a specific subject and send it via email.
- [Export subjects to CSV](https://docs.cynopsis.co//athena-api-reference/subjects/export-subjects-to-csv.md): Export subjects to a CSV file.
- [Get risk assessment report](https://docs.cynopsis.co//athena-api-reference/subjects/get-risk-assessment-report.md): Retrieve a risk assessment report for all subjects.
- [Upload subjects](https://docs.cynopsis.co//athena-api-reference/subjects/upload-subjects.md): Upload a CSV file to create or update subjects, An email will be sent to you, including upload status.
- [List all transactions](https://docs.cynopsis.co//athena-api-reference/transactions/list-all-transactions.md)
- [Create a transaction](https://docs.cynopsis.co//athena-api-reference/transactions/create-a-transaction.md)
- [Retrieve a specific transaction](https://docs.cynopsis.co//athena-api-reference/transactions/retrieve-a-specific-transaction.md): Override the method to optimise query used, while using only necessary Django/DRF's implementation of [get_object_or_404()]
- [Get Transactions by Country](https://docs.cynopsis.co//athena-api-reference/transactions/get-transactions-by-country.md): Retrieve a list of transactions by country.
- [Get Summary Stats](https://docs.cynopsis.co//athena-api-reference/transactions/get-summary-stats.md): Retrieve a summary of transaction statistics.
- [Get Transactions timeline](https://docs.cynopsis.co//athena-api-reference/transactions/get-transactions-timeline.md): Retrieve a timeline of transactions.
- [Upload transactions](https://docs.cynopsis.co//athena-api-reference/transactions/upload-transactions.md): Upload a CSV file to create or update transactions, An email will be sent to you, including the upload status.
- [List all Whitelist records](https://docs.cynopsis.co//athena-api-reference/whitelist/list-all-whitelist-records.md)
- [Create a Whitelist record](https://docs.cynopsis.co//athena-api-reference/whitelist/create-a-whitelist-record.md): Create a new whitelist record with rules, bucket, and subject.
- [Retrieve a Whitelist record](https://docs.cynopsis.co//athena-api-reference/whitelist/retrieve-a-whitelist-record.md)
- [Delete a Whitelist record](https://docs.cynopsis.co//athena-api-reference/whitelist/delete-a-whitelist-record.md): Allows users to delete a whitelist row using either `pk` (URL) or a combination of `subject` and `bucket` in the request body.
- [Update a Whitelist record](https://docs.cynopsis.co//athena-api-reference/whitelist/update-a-whitelist-record.md)
- [Simple health check](https://docs.cynopsis.co//athena-api-reference/health-check/simple-health-check.md)
- [Simple authentication check](https://docs.cynopsis.co//athena-api-reference/authentication/simple-authentication-check.md)

## OpenAPI Specs

- [athena_openapi](https://docs.cynopsis.co/athena-api-reference/athena_openapi.json)
- [artemis3_openapi](https://docs.cynopsis.co/openapi/artemis3_openapi.yaml)
- [ares_openapi](https://docs.cynopsis.co/openapi/ares_openapi.yaml)