The Master Currency can be described as the currency that Athena will be using to perform screening of transactions. Athena identifies currency code using the alphabetic code in accordance to ISO 4217. For more information on ISO 4217, please refer to the link below.ISO 4217 StandardPlease also note that only one currency can be set as the Master Currency. Once the Master Currency is set, the main currency cannot be changed by any means. If a mistake was made setting the Master Currency, please send an email to clientservice@cynopsis.coTo select the currency code to be used, perform a one-time call to the following API
Authorizations
CustomAuthenticationcookieAuth
Authorization
string
header
required
JWT token obtained from AWS Cognito or custom authentication service
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Cynopsis API Documentation","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/cynopsis/i2o15-f7FqsLSgMH/logo/2024Cynopsis_logo_color.png?fit=max\u0026auto=format\u0026n=i2o15-f7FqsLSgMH\u0026q=85\u0026s=a121408a78c4211a12b5eba03b7893fe","dark":"https://mintcdn.com/cynopsis/i2o15-f7FqsLSgMH/logo/2024Cynopsis_logo_color.png?fit=max\u0026auto=format\u0026n=i2o15-f7FqsLSgMH\u0026q=85\u0026s=a121408a78c4211a12b5eba03b7893fe"},"favicon":"https://mintcdn.com/cynopsis/i2o15-f7FqsLSgMH/favicon.ico?fit=max\u0026auto=format\u0026n=i2o15-f7FqsLSgMH\u0026q=85\u0026s=ea2c20ec5b2f4f4670faff77ad33f20f","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"mailto:clientservice@cynopsis.co","label":"Support"}],"primary":{"type":"button","label":"Cynopsis Solutions","href":"https://www.cynopsis-solutions.com/"}},"footer":{"socials":{"facebook":"https://www.facebook.com/cynopsis.co","github":"https://github.com/Cynopsis","linkedin":"https://linkedin.com/company/cynopsis-solutions","instagram":"https://www.instagram.com/cynopsis.co"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cynopsis","hasAudioNarration":false,"actualSubdomain":"cynopsis","customDomains":["docs.cynopsis.co"],"gitSource":{"type":"github","owner":"cynopsis","repo":"developerportal","deployBranch":"master","contentDirectory":"mintlify-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae92a250c4f53f93336e9ea:success","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":294},{"language":"default","tag":"API Documentation","count":288},{"language":"default","tag":"Artemis","count":227},{"language":"default","tag":"Athena","count":176},{"language":"default","tag":"Workflow","count":110},{"language":"default","tag":"customer-controller","count":64},{"language":"default","tag":"Case","count":34},{"language":"default","tag":"Comprehensive Customer Creation Workflow","count":27},{"language":"default","tag":"Transaction Screening","count":19},{"language":"default","tag":"dashboard-controller","count":17}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"athena-api-reference/master_currency","slug":"/athena-api-reference/master_currency","pageMetadata":{"title":"Defining the Master Currency","openapi":"patch /api/currency/{alphabetic_code}","description":null,"href":"/athena-api-reference/master_currency"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Master Currency can be described as the currency that Athena will be using to perform screening of transactions. Athena identifies currency code using the alphabetic code in accordance to ISO 4217. For more information on ISO 4217, please refer to the link below.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`https://iso.org/iso-4217-currency-codes.html`,children:`ISO 4217 Standard`})}),`\n`,_jsxs(_components.p,{children:[`Please also note that only one currency can be set as the Master Currency. Once the Master Currency is set, the main currency `,_jsx(_components.strong,{children:`cannot be changed`}),` by any means. If a mistake was made setting the Master Currency, please send an email to `,_jsx(_components.a,{href:`mailto:clientservice@cynopsis.co`,children:`clientservice@cynopsis.co`})]}),`\n`,_jsx(_components.p,{children:`To select the currency code to be used, perform a one-time call to the following API`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Defining the Master Currency","openapi":"patch /api/currency/{alphabetic_code}","description":null,"href":"/athena-api-reference/master_currency"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"currency_partial_update","summary":"Activate/Deactivate a currency","parameters":["82ba7334-bb48-4e8c-a2a5-8d84242256a8"],"tags":["Currency"],"requestBody":"87ad87e7-49a8-4542-a8f2-29a90b77ccbb","security":["51da47cf-8974-44bb-98a3-39f7bce630d6","ccad4c2d-0d73-4dde-ab82-26bf1b446c0b","9b1fc51d-0872-4fd5-8375-060bb4e01ce6"],"responses":{"200":"e3b8238f-b54a-4d7c-b45a-af091ebff345"},"method":"patch","type":"path","servers":["fb1abd58-3eb3-402f-b763-198722c7383c"],"path":"/api/currency/{alphabetic_code}","baseUrlOptions":["http://localhost/api"],"title":"Activate/Deactivate a currency","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"82ba7334-bb48-4e8c-a2a5-8d84242256a8":{"in":"path","name":"alphabetic_code","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"activate_currency":{"type":"boolean","writeOnly":true,"uniqueKey":"activate_currency","typeLabel":"boolean"},"currency":{"type":"string","minLength":1,"maxLength":65,"uniqueKey":"currency","typeLabel":"string"},"alphabetic_code":{"type":"string","minLength":1,"maxLength":3,"uniqueKey":"alphabetic_code","typeLabel":"string"},"numeric_code":{"type":"string","maxLength":3,"uniqueKey":"numeric_code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"activate_currency":true,"currency":"\u003cstring>","alphabetic_code":"\u003cstring>","numeric_code":"\u003cstring>"}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"activate_currency":{"type":"boolean","writeOnly":true,"uniqueKey":"activate_currency","typeLabel":"boolean"},"currency":{"type":"string","minLength":1,"maxLength":65,"uniqueKey":"currency","typeLabel":"string"},"alphabetic_code":{"type":"string","minLength":1,"maxLength":3,"uniqueKey":"alphabetic_code","typeLabel":"string"},"numeric_code":{"type":"string","maxLength":3,"uniqueKey":"numeric_code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"activate_currency":true,"currency":"\u003cstring>","alphabetic_code":"\u003cstring>","numeric_code":"\u003cstring>"}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","properties":{"activate_currency":{"type":"boolean","writeOnly":true,"uniqueKey":"activate_currency","typeLabel":"boolean"},"currency":{"type":"string","minLength":1,"maxLength":65,"uniqueKey":"currency","typeLabel":"string"},"alphabetic_code":{"type":"string","minLength":1,"maxLength":3,"uniqueKey":"alphabetic_code","typeLabel":"string"},"numeric_code":{"type":"string","maxLength":3,"uniqueKey":"numeric_code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"activate_currency":true,"currency":"\u003cstring>","alphabetic_code":"\u003cstring>","numeric_code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e3b8238f-b54a-4d7c-b45a-af091ebff345":{"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","maxLength":65,"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"alphabetic_code":{"type":"string","maxLength":3,"isRequired":true,"uniqueKey":"alphabetic_code","typeLabel":"string"},"active_indicator":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"active_indicator","typeLabel":"boolean"},"numeric_code":{"type":"string","maxLength":3,"uniqueKey":"numeric_code","typeLabel":"string"}},"required":["active_indicator","alphabetic_code","currency"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"currency":"\u003cstring>","alphabetic_code":"\u003cstring>","active_indicator":true,"numeric_code":"\u003cstring>"}}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"51da47cf-8974-44bb-98a3-39f7bce630d6":{"CustomAuthentication":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from AWS Cognito or custom authentication service","scopes":[]}},"ccad4c2d-0d73-4dde-ab82-26bf1b446c0b":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"sessionid","scopes":[]}},"9b1fc51d-0872-4fd5-8375-060bb4e01ce6":{"BearerAuth":{"$ref":"3fdbe00c-3f2c-4d6b-8e07-2ef506348132","scopes":[]}}},"servers":{"fb1abd58-3eb3-402f-b763-198722c7383c":{"url":"http://localhost/api","description":"Local development server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token obtained from AWS Cognito or custom authentication service","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT token obtained from AWS Cognito or custom authentication service","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"CustomAuthentication","name":"Authorization"}],"title":"CustomAuthentication"},{"schemes":[{"scheme":{"type":"apiKey","in":"cookie","name":"sessionid","scopes":[]},"schema":{"title":"sessionid","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"cookieAuth","name":"sessionid"}],"title":"cookieAuth"}]},"originalFileLocation":"athena-api-reference/athena_openapi.json"},"subdomain":"cynopsis","siteName":"Cynopsis API Documentation","title":"Defining the Master Currency - Cynopsis API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-21T07:26:32.450Z","originalFileLocation":"athena-api-reference/master_currency.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Cynopsis API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Defining the Master Currency - Cynopsis API Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cynopsis API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cynopsis.co/athena-api-reference/master_currency\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cynopsis.mintlify.site/_mintlify/api/og/v2?division=Step+1+-+Currency\u0026amp;title=Defining+the+Master+Currency\u0026amp;theme=f01e0bc926b2297180c6653c\u0026amp;signature=525a86fb94acca55cf71a2d4eefc1f7f893fa64758836a9def8d123c5c50941b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Defining the Master Currency - Cynopsis API Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cynopsis.mintlify.site/_mintlify/api/og/v2?division=Step+1+-+Currency\u0026amp;title=Defining+the+Master+Currency\u0026amp;theme=f01e0bc926b2297180c6653c\u0026amp;signature=525a86fb94acca55cf71a2d4eefc1f7f893fa64758836a9def8d123c5c50941b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cynopsis/sKBYPnrhFbbfIRjX/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cynopsis API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cynopsis.co/athena-api-reference/master_currency\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/athena-api-reference/master_currency.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cynopsis.co/#organization\",\"name\":\"Cynopsis API Documentation\",\"url\":\"https://docs.cynopsis.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cynopsis/i2o15-f7FqsLSgMH/logo/2024Cynopsis_logo_color.png?fit=max\u0026auto=format\u0026n=i2o15-f7FqsLSgMH\u0026q=85\u0026s=a121408a78c4211a12b5eba03b7893fe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cynopsis.co#website\",\"name\":\"Cynopsis API Documentation\",\"url\":\"https://docs.cynopsis.co\",\"publisher\":{\"@id\":\"https://docs.cynopsis.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cynopsis.co/athena-api-reference/master_currency#webpage\",\"url\":\"https://docs.cynopsis.co/athena-api-reference/master_currency\",\"name\":\"Defining the Master Currency\",\"dateModified\":\"2026-04-21T07:26:32.450Z\",\"isPartOf\":{\"@id\":\"https://docs.cynopsis.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cynopsis.co/athena-api-reference/master_currency#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cynopsis.co/athena-api-reference/master_currency#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workflow\",\"item\":\"https://docs.cynopsis.co/athena-api-reference/workflow\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Defining the Master Currency\",\"item\":\"https://docs.cynopsis.co/athena-api-reference/master_currency\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cynopsis.co/athena-api-reference/master_currency#apireference\",\"headline\":\"Defining the Master Currency\",\"name\":\"Defining the Master Currency\",\"url\":\"https://docs.cynopsis.co/athena-api-reference/master_currency\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cynopsis.co/athena-api-reference/master_currency#webpage\"},\"dateModified\":\"2026-04-21T07:26:32.450Z\",\"publisher\":{\"@id\":\"https://docs.cynopsis.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cynopsis.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cynopsis API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cynopsis API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/athena-api-reference/master_currency.md","siteName":"Cynopsis API Documentation","nav":{"global":null,"tabs":[{"tab":"Ares","pages":[{"title":"Ares","href":"/ares/introduction"}]},{"tab":"Artemis","pages":[{"title":"Artemis","href":"/artemis3-api-reference/introduction"}]},{"tab":"Athena","groups":[{"group":"Athena Documentation","pages":[{"title":" Athena Introduction","href":"/athena-api-reference/introduction"},{"title":"Error Codes","href":"/athena-api-reference/error"}]},{"group":"Workflow","pages":[{"title":"General Workflow","href":"/athena-api-reference/workflow"},{"title":"Authentication","description":"Setting up Athena authentication access","href":"/athena-api-reference/authentication"},{"group":"Step 1 - Currency","pages":[{"title":"Defining the Master Currency","openapi":"patch /api/currency/{alphabetic_code}","href":"/athena-api-reference/master_currency"}]},{"group":"Step 2 - Customer","pages":[{"title":"Enroll Customer","description":"Subject(s) - Enrolling of customer profiles","openapi":"post /api/subjects","href":"/athena-api-reference/add_subject"},{"group":"Retrieve Customer(s)","pages":[{"title":"Retrieve all existing Customers","openapi":"get /api/subjects","href":"/athena-api-reference/get_subjects"},{"title":"Retrieve existing Customer","openapi":"get /api/subjects/{client_subject_id}","href":"/athena-api-reference/get_subject_by_id"}]},{"group":"Update existing Customer","pages":[{"title":"Update an existing Customers","openapi":"patch /api/subjects/{client_subject_id}","href":"/athena-api-reference/update_subject"}]},{"group":"Step 2A - Blacklist","pages":[{"title":"Blacklist","openapi":"post /api/blacklist","href":"/athena-api-reference/blacklist"},{"group":"Retrieve Blacklist","pages":[{"title":"Retrieve Blacklists","openapi":"get /api/blacklist","href":"/athena-api-reference/get_blacklist"},{"title":"Retrieve existing Blacklist","openapi":"get /api/blacklist/{id}","href":"/athena-api-reference/get_blacklist_by_id"}]},{"group":"Update Blacklist","pages":[{"title":"Update Blacklist","openapi":"patch /api/blacklist/{id}","href":"/athena-api-reference/update_blacklist"}]},{"group":"Delete Blacklist","pages":[{"title":"Delete Blacklist","openapi":"delete /api/blacklist/{id}","href":"/athena-api-reference/delete_blacklist"}]}]}]},{"group":"Step 3 - Bucket","pages":[{"title":"3. Add Bucket","openapi":"post /api/buckets","href":"/athena-api-reference/add_bucket"},{"group":"Retrieve Bucket(s)","pages":[{"title":"Retrieve all Buckets","openapi":"get /api/buckets","href":"/athena-api-reference/get_buckets"},{"title":"Retrieve existing Bucket by ID","openapi":"get /api/buckets/{id}","href":"/athena-api-reference/get_bucket_by_id"},{"title":"Retrieve existing Bucket by Name","openapi":"get /api/buckets?{name}","href":"/athena-api-reference/get_bucket_by_name"}]},{"group":"Update Bucket","pages":[{"title":"Update an existing Bucket","openapi":"patch /api/buckets/{id}","href":"/athena-api-reference/update_bucket"}]},{"group":"Delete Bucket(s)","pages":[{"title":"Delete Bucket","openapi":"delete /api/buckets/{id}","href":"/athena-api-reference/delete_bucket"}]}]},{"group":"Step 4 - Rule","pages":[{"title":"Rule","openapi":"patch /api/buckets/{id}","href":"/athena-api-reference/add_rule"},{"group":"Configure Rule Settings","pages":[{"title":"Rule Settings","openapi":"patch /api/buckets/{id}","href":"/athena-api-reference/rule_settings"}]},{"group":"Configure Rule Alert","pages":[{"title":"Rule Alert Settings","openapi":"patch /api/rulealert/{id}","href":"/athena-api-reference/rule_alert_setting"}]},{"group":"Step 4A - Rule Information","pages":[{"title":"Rule Information","openapi":"patch /api/rulealert/{id}","href":"/athena-api-reference/rule_information"}]}]},{"group":"Step 5 - Transaction","pages":[{"title":"Transaction","openapi":"post /api/transactions","href":"/athena-api-reference/add_transaction"},{"group":"Retrive Transaction(s)","pages":[{"title":"Retrieve Transactions","openapi":"get /api/transactions","href":"/athena-api-reference/get_transactions"},{"title":"Retrieve existing transaction","openapi":"get /api/transactions/{id}","href":"/athena-api-reference/get_transaction_by_id"}]},{"group":"Step 5A - Bucket Content","pages":[{"title":"Bucket Content","openapi":"post /api/bucketcontent","href":"/athena-api-reference/add_bucketcontent"}]}]},{"group":"Step 6 - Case","pages":[{"title":"Case","href":"/athena-api-reference/case"},{"group":"Retrieve Case(s)","pages":[{"title":"Retrieve Case(s)","openapi":"get /api/cases","href":"/athena-api-reference/get_case"},{"title":"Retrieve existing Case","openapi":"get /api/cases/{id}","href":"/athena-api-reference/get_case_by_id"},{"title":"Retrieve existing Transactions by Case id","openapi":"get /api/cases/{id}/transactions","href":"/athena-api-reference/get_case_by_id_transactions"}]},{"group":"Case Alert Priority","pages":[{"title":"Configure Case Alert Priority","openapi":"patch /api/cases/{id}/alert","href":"/athena-api-reference/case_alert"}]},{"group":"Case Maker","pages":[{"title":"Assign Case Maker","openapi":"patch /api/cases/{id}/assign_maker","href":"/athena-api-reference/case_maker"}]},{"group":"Case Checker","pages":[{"title":"Assign Case Checker","openapi":"patch /api/cases/{id}/assign_checker","href":"/athena-api-reference/case_checker"}]},{"group":"Case Approval","pages":[{"title":"Add Approval for a Case","openapi":"patch /api/cases/{id}/approval","href":"/athena-api-reference/case_approval"}]},{"group":"Case Finding(s)","pages":[{"title":"Add Case Finding(s)","openapi":"patch /api/cases/{id}/findings","href":"/athena-api-reference/case_finding"},{"title":"Delete Case Finding(s)","openapi":"delete /api/cases/{id}/delete_findings","href":"/athena-api-reference/delete_case_finding"}]},{"group":"Reopen a case","pages":[{"title":"Reopen a Case","openapi":"patch /api/cases/{id}/reopen","href":"/athena-api-reference/case_reopen"}]},{"group":"Case Document","pages":[{"title":"Add Case Document(s)","openapi":"patch /api/cases/{id}/document","href":"/athena-api-reference/add_case_document"},{"title":"Delete Case Document","openapi":"delete /api/cases/{id}/delete_document","href":"/athena-api-reference/delete_case_document"}]},{"group":"Case Status","pages":[{"title":"Case Status List","openapi":"get /api/cases/case_status","href":"/athena-api-reference/get_case_status"}]},{"group":"Retrieve Case CSV","pages":[{"title":"Export CSV File for Cases","openapi":"get /api/cases/export_csv","href":"/athena-api-reference/get_case_csv"}]},{"group":"Bulk Assign","pages":[{"title":"Bulk Assign","openapi":"patch /api/cases/bulk_assign","href":"/athena-api-reference/case_bulk_assign"}]}]},{"group":"Transaction Screening","pages":[{"title":"Transaction Screening Workflow","href":"/athena-api-reference/workflow_transaction_screening"},{"group":"Step 7 - Review Hits","pages":[{"title":"Review Hits","href":"/athena-api-reference/ts_review_hits"},{"title":"Get Screening Review","openapi":"get /api/preapprovedtransactions/{id}/screening-review","href":"/athena-api-reference/ts_get_screening_review"},{"title":"Mark Hits","openapi":"post /api/namescreenhits/mark-as","href":"/athena-api-reference/ts_mark_hits"},{"title":"Cascade Mark Hits","openapi":"post /api/namescreenhits/mark-as-cascade","href":"/athena-api-reference/ts_mark_hits_cascade"}]},{"group":"Step 8 - Approve/Reject","pages":[{"title":"Approve or Reject Transaction","openapi":"patch /api/preapprovedtransactions/{id}/approve-reject","href":"/athena-api-reference/ts_approve_reject"}]},{"group":"Step 9 - Get Pre-Approved Transaction","pages":[{"title":"Retrieve Pre-Approved Transactions","openapi":"get /api/preapprovedtransactions","href":"/athena-api-reference/ts_get_preapproved_transactions"},{"title":"Retrieve Pre-Approved Transaction by ID","openapi":"get /api/preapprovedtransactions/{id}","href":"/athena-api-reference/ts_get_preapproved_by_id"},{"title":"Retrieve Active Pre-Approved Transactions","openapi":"get /api/preapprovedtransactions/active","href":"/athena-api-reference/ts_get_preapproved_active"},{"title":"Retrieve Inactive Pre-Approved Transactions","openapi":"get /api/preapprovedtransactions/inactive","href":"/athena-api-reference/ts_get_preapproved_inactive"}]}]}]},{"group":"API Documentation","pages":[{"group":"API Reference","pages":[{"group":"Ageing","pages":[{"openapi":"get /api/ageing","title":"List case ageing distribution","href":"/athena-api-reference/ageing/list-case-ageing-distribution"},{"openapi":"get /api/ageing/{id}","title":"Retrieve case ageing data for a specific user","href":"/athena-api-reference/ageing/retrieve-case-ageing-data-for-a-specific-user"}]},{"group":"App Config","pages":[{"openapi":"get /api/appconfig/{key}","title":"Get App Config","href":"/athena-api-reference/app-config/get-app-config"},{"openapi":"get /api/appconfig/analytics","title":"Get Metabase analytics URL","href":"/athena-api-reference/app-config/get-metabase-analytics-url"},{"title":"Get Artemis Countries","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/appconfig/artemis_countries","href":"/athena-api-reference/app-config/get-artemis-countries"},{"title":"Get Artemis General Settings","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/appconfig/artemis_general_settings","href":"/athena-api-reference/app-config/get-artemis-general-settings"},{"title":"Get Artemis Source of Funds","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/appconfig/artemis_source_of_funds","href":"/athena-api-reference/app-config/get-artemis-source-of-funds"},{"title":"Get Artemis SSIC","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/appconfig/artemis_ssic","href":"/athena-api-reference/app-config/get-artemis-ssic"},{"title":"Get Artemis SSIC International","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/appconfig/artemis_ssic_international","href":"/athena-api-reference/app-config/get-artemis-ssic-international"},{"title":"Get Artemis SSOC","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/appconfig/artemis_ssoc","href":"/athena-api-reference/app-config/get-artemis-ssoc"},{"title":"Get Artemis SSOC International","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/appconfig/artemis_ssoc_international","href":"/athena-api-reference/app-config/get-artemis-ssoc-international"}]},{"group":"User","pages":[{"openapi":"get /api/assignees","title":"List users ordered by email","href":"/athena-api-reference/user/list-users-ordered-by-email"},{"openapi":"get /api/assignees/{id}","title":"Retrieve a single user by id","href":"/athena-api-reference/user/retrieve-a-single-user-by-id"},{"openapi":"post /api/login","title":"Login","href":"/athena-api-reference/user/login"},{"openapi":"post /api/logout","title":"Logout","href":"/athena-api-reference/user/logout"},{"openapi":"get /api/users","title":"List users","href":"/athena-api-reference/user/list-users"},{"openapi":"post /api/users","title":"Create user","href":"/athena-api-reference/user/create-user"},{"openapi":"get /api/users/{id}","title":"Retrieve user","href":"/athena-api-reference/user/retrieve-user"},{"openapi":"delete /api/users/{id}","title":"Delete user","href":"/athena-api-reference/user/delete-user"},{"openapi":"patch /api/users/{id}","title":"Update user","href":"/athena-api-reference/user/update-user"}]},{"group":"Blacklist","pages":[{"openapi":"get /api/blacklist","title":"List all Blacklist records","href":"/athena-api-reference/blacklist/list-all-blacklist-records"},{"openapi":"post /api/blacklist","title":"Create a Blacklist record","href":"/athena-api-reference/blacklist/create-a-blacklist-record"},{"openapi":"get /api/blacklist/{id}","title":"Retrieve a Blacklist record","href":"/athena-api-reference/blacklist/retrieve-a-blacklist-record"},{"openapi":"delete /api/blacklist/{id}","title":"Deactivate a Blacklist record","href":"/athena-api-reference/blacklist/deactivate-a-blacklist-record"},{"openapi":"patch /api/blacklist/{id}","title":"Update a Blacklist record","href":"/athena-api-reference/blacklist/update-a-blacklist-record"}]},{"group":"Bucket Content","pages":[{"openapi":"get /api/bucketcontent","title":"List all transaction in buckets","href":"/athena-api-reference/bucket-content/list-all-transaction-in-buckets"},{"openapi":"post /api/bucketcontent","title":"Insert a transaction into a bucket","href":"/athena-api-reference/bucket-content/insert-a-transaction-into-a-bucket"}]},{"group":"Buckets","pages":[{"openapi":"get /api/buckets","title":"List all buckets","href":"/athena-api-reference/buckets/list-all-buckets"},{"openapi":"post /api/buckets","title":"Create a bucket","href":"/athena-api-reference/buckets/create-a-bucket"},{"openapi":"get /api/buckets/{id}","title":"Retrieve a specific bucket","href":"/athena-api-reference/buckets/retrieve-a-specific-bucket"},{"openapi":"delete /api/buckets/{id}","title":"Delete a bucket","href":"/athena-api-reference/buckets/delete-a-bucket"},{"openapi":"patch /api/buckets/{id}","title":"Update a bucket","href":"/athena-api-reference/buckets/update-a-bucket"},{"openapi":"get /api/buckets/export_csv","title":"Export transactions to CSV for a bucket","href":"/athena-api-reference/buckets/export-transactions-to-csv-for-a-bucket"}]},{"group":"Case","pages":[{"openapi":"get /api/cases","title":"List all cases","href":"/athena-api-reference/case/list-all-cases"},{"openapi":"get /api/cases/{id}","title":"Retrieve a specific case","href":"/athena-api-reference/case/retrieve-a-specific-case"},{"openapi":"delete /api/cases/{id}","title":"Delete a specific case","href":"/athena-api-reference/case/delete-a-specific-case"},{"openapi":"patch /api/cases/{id}","title":"Update a specific case","href":"/athena-api-reference/case/update-a-specific-case"},{"openapi":"patch /api/cases/{id}/alert","title":"Update alert risk rating for a case","href":"/athena-api-reference/case/update-alert-risk-rating-for-a-case"},{"openapi":"patch /api/cases/{id}/approval","title":"Approve a case","href":"/athena-api-reference/case/approve-a-case"},{"openapi":"patch /api/cases/{id}/assign_checker","title":"Assign a case to a checker","href":"/athena-api-reference/case/assign-a-case-to-a-checker"},{"openapi":"patch /api/cases/{id}/assign_maker","title":"Assign a case to a maker","href":"/athena-api-reference/case/assign-a-case-to-a-maker"},{"openapi":"delete /api/cases/{id}/delete_document","title":"Delete document from a case","href":"/athena-api-reference/case/delete-document-from-a-case"},{"openapi":"delete /api/cases/{id}/delete_findings","title":"Delete findings from a case","href":"/athena-api-reference/case/delete-findings-from-a-case"},{"openapi":"patch /api/cases/{id}/document","title":"Add document to a case","href":"/athena-api-reference/case/add-document-to-a-case"},{"openapi":"patch /api/cases/{id}/findings","title":"Add findings to a case","href":"/athena-api-reference/case/add-findings-to-a-case"},{"title":"Generate case report","openapi":"get /api/cases/{id}/generate_case_report","href":"/athena-api-reference/case/generate-case-report"},{"openapi":"patch /api/cases/{id}/reopen","title":"Reopen a case","href":"/athena-api-reference/case/reopen-a-case"},{"openapi":"patch /api/cases/{id}/report_code","title":"Add report code to a case","href":"/athena-api-reference/case/add-report-code-to-a-case"},{"openapi":"patch /api/cases/{id}/report_indicator","title":"Add report indicator to a case","href":"/athena-api-reference/case/add-report-indicator-to-a-case"},{"title":"List transactions for a specific case","openapi":"get /api/cases/{id}/transactions","href":"/athena-api-reference/case/list-transactions-for-a-specific-case"},{"openapi":"get /api/cases/active","title":"Get active cases","href":"/athena-api-reference/case/get-active-cases"},{"openapi":"get /api/cases/active_cases","title":"Get active cases statistics","href":"/athena-api-reference/case/get-active-cases-statistics"},{"openapi":"get /api/cases/assignee","title":"Get cases by assignee","href":"/athena-api-reference/case/get-cases-by-assignee"},{"openapi":"get /api/cases/bucket","title":"Get cases by bucket","href":"/athena-api-reference/case/get-cases-by-bucket"},{"title":"Bulk approve multiple cases","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json post /api/cases/bulk_approval","href":"/athena-api-reference/case/bulk-approve-multiple-cases"},{"openapi":"patch /api/cases/bulk_assign","title":"Bulk assign cases","href":"/athena-api-reference/case/bulk-assign-cases"},{"title":"Bulk upload documents to multiple cases","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json post /api/cases/bulk_documents","href":"/athena-api-reference/case/bulk-upload-documents-to-multiple-cases"},{"title":"Bulk add findings to multiple cases","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json post /api/cases/bulk_findings","href":"/athena-api-reference/case/bulk-add-findings-to-multiple-cases"},{"openapi":"get /api/cases/case_status","title":"Get case status options","href":"/athena-api-reference/case/get-case-status-options"},{"openapi":"get /api/cases/closed_cases","title":"Get closed cases","href":"/athena-api-reference/case/get-closed-cases"},{"openapi":"get /api/cases/export_csv","title":"Export cases to CSV","href":"/athena-api-reference/case/export-cases-to-csv"},{"openapi":"get /api/cases/not_active","title":"Get inactive cases","href":"/athena-api-reference/case/get-inactive-cases"},{"openapi":"get /api/cases/priority","title":"Get cases by priority","href":"/athena-api-reference/case/get-cases-by-priority"},{"openapi":"get /api/cases/rule","title":"Get cases by rule","href":"/athena-api-reference/case/get-cases-by-rule"},{"openapi":"get /api/cases/status","title":"Get cases by status","href":"/athena-api-reference/case/get-cases-by-status"},{"openapi":"get /api/cases/timeline","title":"Get cases timeline","href":"/athena-api-reference/case/get-cases-timeline"},{"openapi":"get /api/cases/violations","title":"Get violations statistics","href":"/athena-api-reference/case/get-violations-statistics"}]},{"group":"cases","pages":[{"title":"Post apicases","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json post /api/cases","href":"/athena-api-reference/cases/post-apicases"}]},{"group":"Currency","pages":[{"openapi":"get /api/currency","title":"Retrieve a list of currencies","href":"/athena-api-reference/currency/retrieve-a-list-of-currencies"},{"openapi":"get /api/currency/{alphabetic_code}","title":"Retrieve a specific currency","href":"/athena-api-reference/currency/retrieve-a-specific-currency"},{"title":"Activate/Deactivate a currency","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json patch /api/currency/{alphabetic_code}","href":"/athena-api-reference/currency/activatedeactivate-a-currency"}]},{"group":"Group","pages":[{"openapi":"get /api/groups","title":"List groups","href":"/athena-api-reference/group/list-groups"},{"openapi":"post /api/groups","title":"Create group","href":"/athena-api-reference/group/create-group"},{"openapi":"get /api/groups/{id}","title":"Retrieve group","href":"/athena-api-reference/group/retrieve-group"},{"openapi":"delete /api/groups/{id}","title":"Delete group","href":"/athena-api-reference/group/delete-group"},{"openapi":"patch /api/groups/{id}","title":"Update group","href":"/athena-api-reference/group/update-group"}]},{"group":"Permission","pages":[{"openapi":"get /api/permissions","title":"List all permissions","href":"/athena-api-reference/permission/list-all-permissions"},{"openapi":"get /api/permissions/{id}","title":"Retrieve a single permission by id","href":"/athena-api-reference/permission/retrieve-a-single-permission-by-id"}]},{"group":"Risk Assessment","pages":[{"openapi":"get /api/risk_assessment","title":"Retrieve a list of risk assessments","href":"/athena-api-reference/risk-assessment/retrieve-a-list-of-risk-assessments"},{"openapi":"get /api/risk_assessment/{id}","title":"Retrieve a specific risk assessment","href":"/athena-api-reference/risk-assessment/retrieve-a-specific-risk-assessment"}]},{"group":"RuleAlert","pages":[{"openapi":"get /api/rulealert","title":"List all RuleAlert records","href":"/athena-api-reference/rulealert/list-all-rulealert-records"},{"openapi":"get /api/rulealert/{id}","title":"Retrieve a RuleAlert record","href":"/athena-api-reference/rulealert/retrieve-a-rulealert-record"},{"openapi":"patch /api/rulealert/{id}","title":"Update a RuleAlert record","href":"/athena-api-reference/rulealert/update-a-rulealert-record"}]},{"group":"Rule Detail","pages":[{"openapi":"get /api/ruleinformation","title":"List all rule information","href":"/athena-api-reference/rule-detail/list-all-rule-information"},{"openapi":"get /api/ruleinformation/{id}","title":"Retrieve a rule information","href":"/athena-api-reference/rule-detail/retrieve-a-rule-information"},{"openapi":"patch /api/ruleinformation/{id}","title":"Update a rule information record","href":"/athena-api-reference/rule-detail/update-a-rule-information-record"}]},{"group":"Profile Info","pages":[{"openapi":"get /api/shared/profile-info","title":"Get profile information","href":"/athena-api-reference/profile-info/get-profile-information"}]},{"group":"Subject Info","pages":[{"openapi":"get /api/subjectinfo/{id}","title":"Retrieve subject information by client_subject_id","href":"/athena-api-reference/subject-info/retrieve-subject-information-by-client_subject_id"}]},{"group":"Subjects","pages":[{"openapi":"get /api/subjects","title":"List all subjects","href":"/athena-api-reference/subjects/list-all-subjects"},{"openapi":"post /api/subjects","title":"Create a subject","href":"/athena-api-reference/subjects/create-a-subject"},{"openapi":"get /api/subjects/{client_subject_id}","title":"Retrieve a specific subject","href":"/athena-api-reference/subjects/retrieve-a-specific-subject"},{"openapi":"patch /api/subjects/{client_subject_id}","title":"Update a subject","href":"/athena-api-reference/subjects/update-a-subject"},{"openapi":"get /api/subjects/{client_subject_id}/generate-subject-report","title":null,"href":"/athena-api-reference/subjects/generate-subject-report"},{"openapi":"get /api/subjects/export_csv","title":"Export subjects to CSV","href":"/athena-api-reference/subjects/export-subjects-to-csv"},{"openapi":"get /api/subjects/risk_assessment_report","title":"Get risk assessment report","href":"/athena-api-reference/subjects/get-risk-assessment-report"},{"openapi":"post /api/subjects/upload","title":"Upload subjects","href":"/athena-api-reference/subjects/upload-subjects"}]},{"group":"Transactions","pages":[{"openapi":"get /api/transactions","title":"List all transactions","href":"/athena-api-reference/transactions/list-all-transactions"},{"openapi":"post /api/transactions","title":"Create a transaction","href":"/athena-api-reference/transactions/create-a-transaction"},{"openapi":"get /api/transactions/{id}","title":"Retrieve a specific transaction","href":"/athena-api-reference/transactions/retrieve-a-specific-transaction"},{"openapi":"get /api/transactions/countries","title":"Get Transactions by Country","href":"/athena-api-reference/transactions/get-transactions-by-country"},{"openapi":"get /api/transactions/summary","title":"Get Summary Stats","href":"/athena-api-reference/transactions/get-summary-stats"},{"openapi":"get /api/transactions/timeline","title":"Get Transactions timeline","href":"/athena-api-reference/transactions/get-transactions-timeline"},{"openapi":"post /api/transactions/upload","title":"Upload transactions","href":"/athena-api-reference/transactions/upload-transactions"}]},{"group":"Whitelist","pages":[{"openapi":"get /api/whitelist","title":"List all Whitelist records","href":"/athena-api-reference/whitelist/list-all-whitelist-records"},{"openapi":"post /api/whitelist","title":"Create a Whitelist record","href":"/athena-api-reference/whitelist/create-a-whitelist-record"},{"openapi":"get /api/whitelist/{id}","title":"Retrieve a Whitelist record","href":"/athena-api-reference/whitelist/retrieve-a-whitelist-record"},{"openapi":"delete /api/whitelist/{id}/delete","title":"Delete a Whitelist record","href":"/athena-api-reference/whitelist/delete-a-whitelist-record"},{"openapi":"patch /api/whitelist/{id}","title":"Update a Whitelist record","href":"/athena-api-reference/whitelist/update-a-whitelist-record"},{"title":"Delete a Whitelist record","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json delete /api/whitelist/{id}/delete","href":"/athena-api-reference/whitelist/delete-a-whitelist-record-1"}]},{"group":"Health Check","pages":[{"openapi":"get /health/","title":"Simple health check","href":"/athena-api-reference/health-check/simple-health-check"}]},{"group":"Authentication","pages":[{"openapi":"get /health/test-auth-request","title":"Simple authentication check","href":"/athena-api-reference/authentication/simple-authentication-check"}]},{"group":"Transaction Screening","pages":[{"title":"List all QuickScan transactions","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/preapprovedtransactions","href":"/athena-api-reference/transaction-screening/list-all-quickscan-transactions"},{"title":"Retrieve a QuickScan transaction","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/preapprovedtransactions/{id}","href":"/athena-api-reference/transaction-screening/retrieve-a-quickscan-transaction"},{"title":"List active QuickScan transactions","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/preapprovedtransactions/active","href":"/athena-api-reference/transaction-screening/list-active-quickscan-transactions"},{"title":"List inactive QuickScan transactions","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/preapprovedtransactions/inactive","href":"/athena-api-reference/transaction-screening/list-inactive-quickscan-transactions"},{"title":"Get screening review for a QuickScan transaction","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json get /api/preapprovedtransactions/{id}/screening-review","href":"/athena-api-reference/transaction-screening/get-screening-review-for-a-quickscan-transaction"},{"title":"Rescreen a QuickScan transaction","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json post /api/preapprovedtransactions/{id}/rescreen","href":"/athena-api-reference/transaction-screening/rescreen-a-quickscan-transaction"},{"title":"Bulk rescreen QuickScan transactions","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json post /api/preapprovedtransactions/rescreen-bulk","href":"/athena-api-reference/transaction-screening/bulk-rescreen-quickscan-transactions"},{"title":"Assign a QuickScan transaction","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json patch /api/preapprovedtransactions/{id}/assign","href":"/athena-api-reference/transaction-screening/assign-a-quickscan-transaction"},{"title":"Approve or reject a QuickScan transaction","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json patch /api/preapprovedtransactions/{id}/approve-reject","href":"/athena-api-reference/transaction-screening/approve-or-reject-a-quickscan-transaction"}]},{"group":"Name Screen Hits","pages":[{"title":"Cascade mark name screen hits","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json post /api/namescreenhits/mark-as-cascade","href":"/athena-api-reference/name-screen-hits/cascade-mark-name-screen-hits"},{"title":"Mark name screen hits","deprecated":null,"version":null,"openapi":"/athena-api-reference/athena_openapi.json post /api/namescreenhits/mark-as","href":"/athena-api-reference/name-screen-hits/mark-name-screen-hits"}]}]}]}]}]},"basePath":"","title":"Defining the Master Currency - Cynopsis API Documentation","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}