This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.
This is an indicator to audit the fact that the controller has obtained consent from the subject to process their personal information and data as per the regulatory requirements pertaining to local and global privacy and data protection legislation.
This is the unique transaction reference number that can be supplied by the controller. This will be provided in response messages related to the transaction and will be required for identifying transactions for support purposes.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"DIDx Developer Documentation","colors":{"primary":"#F14C2E","light":"#F14C2E","dark":"#451B76"},"logo":{"light":"https://mintcdn.com/didx/ZB5qTooWL0CHRo97/logo/logoLight.png?fit=max\u0026auto=format\u0026n=ZB5qTooWL0CHRo97\u0026q=85\u0026s=6192ac24950cdd4638622a58b61b0b13","dark":"https://mintcdn.com/didx/ZB5qTooWL0CHRo97/logo/logoDark.png?fit=max\u0026auto=format\u0026n=ZB5qTooWL0CHRo97\u0026q=85\u0026s=8039f7b77f7fb73bc3cc179d358c1964"},"favicon":"https://mintcdn.com/didx/iSM5FS6FI2S5aUWQ/favicon.png?fit=max\u0026auto=format\u0026n=iSM5FS6FI2S5aUWQ\u0026q=85\u0026s=1421db23dfe65e39cb133ae63c10a4ce","api":{"playground":{"display":"none"}},"navbar":{"links":[{"href":"mailto:support@didx.co.za","label":"Support"}]},"footer":{"socials":{"x":"https://x.com/DIDx_Africa","github":"https://github.com/didx-xyz","linkedin":"https://linkedin.com/company/didx"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"list","href":"/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"didx","hasAudioNarration":false,"actualSubdomain":"didx","customDomains":["docs.didx.co.za"],"gitSource":{"type":"github","owner":"didx-xyz","repo":"docs","deployBranch":"master","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af5a38b0b3858d5ef25015b","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"didx:me","count":200},{"language":"default","tag":"API Reference","count":192},{"language":"default","tag":"Credentials","count":97},{"language":"default","tag":"didx:verify","count":46},{"language":"default","tag":"Integration Guides","count":41},{"language":"default","tag":"Wallet","count":39},{"language":"default","tag":"Credential Templates API","count":26},{"language":"default","tag":"Presentations","count":22},{"language":"default","tag":"Marketplace","count":20},{"language":"default","tag":"Certificates API","count":18}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".prose a.link,.mdx-content a.link{border-bottom-color:#2563eb}.dark .prose a.link,.dark .mdx-content a.link{border-bottom-color:#60a5fa}"}],"page":{"pagePath":"products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening","slug":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening","pageMetadata":{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/AMLScreening","title":"Secure Citizen Anti-Money Laundering Screening","description":"This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/AMLScreening","title":"Secure Citizen Anti-Money Laundering Screening","description":"This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Citizen"],"summary":"Secure Citizen Anti-Money Laundering Screening","description":"This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.","operationId":"AMLScreening","requestBody":"5e21419e-fde7-4b26-a5fa-1b909a9eb21f","responses":{"200":"38be250a-833a-4119-9485-d734a65a42c7","401":"ed2985bf-79f5-4e5e-b9dd-e9f8c35048b6","403":"03f66eec-1df9-46c7-b87d-95b85603ab63","500":"8735bde7-178b-4897-96da-5a522327b7fe"},"security":["8456ba42-7f8e-4211-a3bd-506b0e6280e0"],"method":"post","type":"path","servers":["130eafac-520d-4a66-94e2-3e52abcbade4"],"path":"/Citizen/AMLScreening","baseUrlOptions":["https://citizen.uat.securecitizen.cloud"],"title":"Secure Citizen Anti-Money Laundering Screening","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"required":["ConsentReceived"],"type":"object","properties":{"ConsentReceived":{"title":"Consent Received","type":"boolean","description":"Example: true\r\n\r\nThis is an indicator to audit the fact that the controller has obtained consent from the subject to process their personal information and data as per the regulatory requirements pertaining to local and global privacy and data protection legislation.","format":"bool","isRequired":true,"uniqueKey":"ConsentReceived","typeLabel":"boolean\u003cbool>"},"CRef":{"oneOf":[{"title":"Client Reference","type":"string","description":"Example: \"REF00001\"\r\n\r\nThis is the unique transaction reference number that can be supplied by the controller. This will be provided in response messages related to the transaction and will be required for identifying transactions for support purposes.","format":"string","uniqueKey":"CRef.oneOf.0","typeLabel":"string\u003cstring>"},{"title":"Client Reference","type":"null","description":"Example: \"REF00001\"\r\n\r\nThis is the unique transaction reference number that can be supplied by the controller. This will be provided in response messages related to the transaction and will be required for identifying transactions for support purposes.","format":"string","uniqueKey":"CRef.oneOf.1","typeLabel":"null"}],"uniqueKey":"CRef","typeLabel":"string\u003cstring> | null"},"ResidentType":{"oneOf":[{"title":"Resident Type","type":"string","description":"Client should indicate resident type applicable to the consumer\n\nValues: rsa_citizen/foreign_national","uniqueKey":"ResidentType.oneOf.0","typeLabel":"string"},{"title":"Resident Type","type":"null","description":"Client should indicate resident type applicable to the consumer\n\nValues: rsa_citizen/foreign_national","uniqueKey":"ResidentType.oneOf.1","typeLabel":"null"}],"uniqueKey":"ResidentType","typeLabel":"string | null"},"IdentificationNumber":{"oneOf":[{"title":"Identification Number","type":"string","description":"Client to provide the identification number that corresponds with the chosen resident type.","uniqueKey":"IdentificationNumber.oneOf.0","typeLabel":"string"},{"title":"Identification Number","type":"null","description":"Client to provide the identification number that corresponds with the chosen resident type.","uniqueKey":"IdentificationNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"IdentificationNumber","typeLabel":"string | null"},"Firstname":{"oneOf":[{"title":"First Name","type":"string","description":"Input the consumers first name.","uniqueKey":"Firstname.oneOf.0","typeLabel":"string"},{"title":"First Name","type":"null","description":"Input the consumers first name.","uniqueKey":"Firstname.oneOf.1","typeLabel":"null"}],"uniqueKey":"Firstname","typeLabel":"string | null"},"Surname":{"oneOf":[{"title":"Surname","type":"string","description":"Input the consumers surname.","uniqueKey":"Surname.oneOf.0","typeLabel":"string"},{"title":"Surname","type":"null","description":"Input the consumers surname.","uniqueKey":"Surname.oneOf.1","typeLabel":"null"}],"uniqueKey":"Surname","typeLabel":"string | null"},"BirthDate":{"oneOf":[{"title":"Birth Date","type":"string","description":"Date of birth in format of DD-MM-YYYY.","uniqueKey":"BirthDate.oneOf.0","typeLabel":"string"},{"title":"Birth Date","type":"null","description":"Date of birth in format of DD-MM-YYYY.","uniqueKey":"BirthDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"BirthDate","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ConsentReceived":true,"CRef":"\u003cstring>","ResidentType":"\u003cstring>","IdentificationNumber":"\u003cstring>","Firstname":"\u003cstring>","Surname":"\u003cstring>","BirthDate":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"38be250a-833a-4119-9485-d734a65a42c7":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"CRef":{"oneOf":[{"title":"Client Reference","type":"string","description":"This field will return the reference provided by the client to track the transaction.","format":"string","uniqueKey":"CRef.oneOf.0","typeLabel":"string\u003cstring>"},{"title":"Client Reference","type":"null","description":"This field will return the reference provided by the client to track the transaction.","format":"string","uniqueKey":"CRef.oneOf.1","typeLabel":"null"}],"uniqueKey":"CRef","typeLabel":"string\u003cstring> | null"},"Status":{"title":"Status","enum":["Success","Failure","Unknown","AuthFailure","DataDeserializationError","EmptyResults","ErrorContactSupport","FaceDetectionFailure","FaceComparisonFailure","NoStatusDefined","FaceDetectionQualityTooLow","FaceDetectionTooManyFaces","FaceDetectionNoFacesFound","FaceComparisonError","FaceComparisonNotSame","GoldenSourceImageNull","ProvidedImageNull","GoldenSourceNoFacesFound","ProvidedImageNoFacesFound","GoldenSourceHasTooManyFaces","ProvidedImageHasTooManyFaces","GoldenSourceQualityTooLow","ProvidedImageQualityTooLow","GoldenSourceGUIDIncorrect","ProvidedImageGUIDIncorrect","FaceAPIGeneralError","FaceAPIPublicUrlInputError","FaceBadInput","GoldenSourceIncorrectStringFormat","ProvidedImageIncorrectStringFormat","SAFPSNPROk","SAFPSHANISOk","SAFPSNIISOk","SAFPSNPRSlow","SAFPSHANISSlow","SAFPSNIISSlow","SAFPSFailure","SAFPSPossibleFailure","SAFPSNPRFailure","SAFPSHANISFailure","SAFPSNIISFailure","FaceTooClose","EyesClosed","FaceCloseToBorder","FaceCropped","FaceIsOccluded","FaceNotFound","TooManyFaces","FaceTooSmall","AbsoluteFaceTooSmall","RelativeFaceTooSmall","FaceAngleTooLarge","FailedToPredictLandmarks","Active","CSuccess","AsyncCSuccess","IdentificationNumberInvalid","IdentificationNumberAgeBelow18","UnableToVerifyIdentificationNumberOnDocument","UnableToVerifyIdentificationNumberAtGoldenSource","GoldenSourceUnavailable","MandatoryInformationMissing","NPRSuccess","HANISNotAvailable","InvalidIDNCheckDigitTestNotPassed","NPRNotAvailableOnlyPhotoIsReturned","IDNRIsNotCurrentlyAValidNPRIDNR","IDNRIsMarkedForDeletion"],"type":"string","description":"Status values (static strings) to be used for external connection management","format":"string","uniqueKey":"Status","typeLabel":"enum\u003cstring>"},"Message":{"oneOf":[{"title":"Message","type":"string","description":"This will return a status of the transaction s well as external tracking information.","format":"string","uniqueKey":"Message.oneOf.0","typeLabel":"string\u003cstring>"},{"title":"Message","type":"null","description":"This will return a status of the transaction s well as external tracking information.","format":"string","uniqueKey":"Message.oneOf.1","typeLabel":"null"}],"uniqueKey":"Message","typeLabel":"string\u003cstring> | null"},"result":{"title":"Result","type":"boolean","description":"This will indicate whether the validation was successful.","uniqueKey":"result","typeLabel":"boolean"},"result_code":{"type":"object","properties":{"name":{"oneOf":[{"title":"ID Name","type":"string","description":"The name extracted from the identity document provided.","uniqueKey":"result_code.name.oneOf.0","typeLabel":"string"},{"title":"ID Name","type":"null","description":"The name extracted from the identity document provided.","uniqueKey":"result_code.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"result_code.name","typeLabel":"string | null"},"id":{"title":"ID number","type":"integer","description":"The identity document number extracted from the identity document provided.","format":"int32","uniqueKey":"result_code.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"result_code","typeLabel":"object"},"response_object":{"type":"object","properties":{"matches":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"entityType":{"oneOf":[{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].entityType.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].entityType.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].entityType","typeLabel":"string | null"},"gender":{"oneOf":[{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].gender.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].gender","typeLabel":"string | null"},"names":{"oneOf":[{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].names.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].names.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].names","typeLabel":"string | null"},"dateListed":{"type":"string","format":"date-time","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].dateListed","typeLabel":"string\u003cdate-time>"},"number":{"oneOf":[{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].number.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].number","typeLabel":"string | null"},"reasonListed":{"oneOf":[{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].reasonListed.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].reasonListed.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].reasonListed","typeLabel":"string | null"},"comments":{"oneOf":[{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].comments.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].comments","typeLabel":"string | null"},"additionalInformation":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX].type","typeLabel":"string | null"},"value":{"oneOf":[{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX].value","typeLabel":"string | null"},"comments":{"oneOf":[{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX].comments.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX].comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX].comments","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"type":{"oneOf":[{"type":"string"},{"type":"null"}]},"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"comments":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].additionalInformation","typeLabel":"object[] | null"},"countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].countries.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].countries.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX].countries","typeLabel":"string[] | null"}},"additionalProperties":false,"uniqueKey":"response_object.matches.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"response_object.matches.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"entityType":{"oneOf":[{"type":"string"},{"type":"null"}]},"gender":{"oneOf":[{"type":"string"},{"type":"null"}]},"names":{"oneOf":[{"type":"string"},{"type":"null"}]},"dateListed":{"type":"string","format":"date-time"},"number":{"oneOf":[{"type":"string"},{"type":"null"}]},"reasonListed":{"oneOf":[{"type":"string"},{"type":"null"}]},"comments":{"oneOf":[{"type":"string"},{"type":"null"}]},"additionalInformation":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"type":{"oneOf":[{"type":"string"},{"type":"null"}]},"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"comments":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false}},{"type":"null","items":{"type":"object","properties":{"type":{"oneOf":[{"type":"string"},{"type":"null"}]},"value":{"oneOf":[{"type":"string"},{"type":"null"}]},"comments":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false}}]},"countries":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"null","items":{"type":"string"}}]}},"additionalProperties":false},"uniqueKey":"response_object.matches.oneOf.1","typeLabel":"null"}],"uniqueKey":"response_object.matches","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"response_object","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"CRef":"\u003cstring>","Status":"Success","Message":"\u003cstring>","result":true,"result_code":{"name":"\u003cstring>","id":123},"response_object":{"matches":[{"entityType":"\u003cstring>","gender":"\u003cstring>","names":"\u003cstring>","dateListed":"2023-11-07T05:31:56Z","number":"\u003cstring>","reasonListed":"\u003cstring>","comments":"\u003cstring>","additionalInformation":[{"type":"\u003cstring>","value":"\u003cstring>","comments":"\u003cstring>"}],"countries":["\u003cstring>"]}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"ed2985bf-79f5-4e5e-b9dd-e9f8c35048b6":{"description":"Unauthenticated","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"03f66eec-1df9-46c7-b87d-95b85603ab63":{"description":"Unauthorized access to this resource","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"8735bde7-178b-4897-96da-5a522327b7fe":{"description":"Cat-as-trophy","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"8456ba42-7f8e-4211-a3bd-506b0e6280e0":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sts.uat.securecitizen.cloud/connect/authorize","tokenUrl":"https://sts.uat.securecitizen.cloud/connect/token","scopes":{"sc-citizen":"SecureCitizen.Citizen.Api"}}},"scopes":["sc-citizen"]}}},"servers":{"130eafac-520d-4a66-94e2-3e52abcbade4":{"url":"https://citizen.uat.securecitizen.cloud"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://sts.uat.securecitizen.cloud/connect/authorize","tokenUrl":"https://sts.uat.securecitizen.cloud/connect/token","scopes":{"sc-citizen":"SecureCitizen.Citizen.Api"}}},"scopes":["sc-citizen"]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"products/didx-verify/api-reference/v1/openapi.json"},"subdomain":"didx","siteName":"DIDx Developer Documentation","title":"Secure Citizen Anti-Money Laundering Screening - DIDx Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-17T14:27:14.289Z","originalFileLocation":"products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening.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=\"description\" content=\"This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.\">\u003cmeta data-mint-head name=\"application-name\" content=\"DIDx Developer 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/didx/47pptXdR0Mq8zA0B/_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/didx/47pptXdR0Mq8zA0B/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/didx/47pptXdR0Mq8zA0B/_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/didx/47pptXdR0Mq8zA0B/_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/didx/47pptXdR0Mq8zA0B/_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/didx/47pptXdR0Mq8zA0B/_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/didx/47pptXdR0Mq8zA0B/_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/didx/47pptXdR0Mq8zA0B/_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/didx/47pptXdR0Mq8zA0B/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Secure Citizen Anti-Money Laundering Screening - DIDx Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DIDx Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://didx.mintlify.site/_mintlify/api/og/v2?division=Compliance+%26+Screening\u0026amp;title=Secure+Citizen+Anti-Money+Laundering+Screening\u0026amp;description=This+is+a+service+that+completes+an+anti-money+laundering+screening+to+enable+clients+to+ensure+that+their+consumers+are+not+in+sanctions+lists%2C+that+they+are+n\u0026amp;theme=532ad0426b7a92f401471e3b\u0026amp;signature=fafbe1403ffe9887b0d77f8548f34cf6ab6b533640743a430bbbf2592eaa9558\">\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=\"Secure Citizen Anti-Money Laundering Screening - DIDx Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://didx.mintlify.site/_mintlify/api/og/v2?division=Compliance+%26+Screening\u0026amp;title=Secure+Citizen+Anti-Money+Laundering+Screening\u0026amp;description=This+is+a+service+that+completes+an+anti-money+laundering+screening+to+enable+clients+to+ensure+that+their+consumers+are+not+in+sanctions+lists%2C+that+they+are+n\u0026amp;theme=532ad0426b7a92f401471e3b\u0026amp;signature=fafbe1403ffe9887b0d77f8548f34cf6ab6b533640743a430bbbf2592eaa9558\">\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/didx/47pptXdR0Mq8zA0B/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DIDx Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F14C2E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.didx.co.za/#organization\",\"name\":\"DIDx Developer Documentation\",\"url\":\"https://docs.didx.co.za\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/didx/ZB5qTooWL0CHRo97/logo/logoLight.png?fit=max\u0026auto=format\u0026n=ZB5qTooWL0CHRo97\u0026q=85\u0026s=6192ac24950cdd4638622a58b61b0b13\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.didx.co.za#website\",\"name\":\"DIDx Developer Documentation\",\"url\":\"https://docs.didx.co.za\",\"publisher\":{\"@id\":\"https://docs.didx.co.za/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening#webpage\",\"url\":\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening\",\"name\":\"Secure Citizen Anti-Money Laundering Screening\",\"description\":\"This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.\",\"dateModified\":\"2026-06-17T14:27:14.289Z\",\"isPartOf\":{\"@id\":\"https://docs.didx.co.za#website\"},\"breadcrumb\":{\"@id\":\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Marketplace\",\"item\":\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-lookup-rsaid-verification-call\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Secure Citizen Anti-Money Laundering Screening\",\"item\":\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening#apireference\",\"headline\":\"Secure Citizen Anti-Money Laundering Screening\",\"name\":\"Secure Citizen Anti-Money Laundering Screening\",\"description\":\"This is a service that completes an anti-money laundering screening to enable clients to ensure that their consumers are not in sanctions lists, that they are not politically exposed and that they don’t have any adverse media data on them.\",\"url\":\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening\",\"mainEntityOfPage\":{\"@id\":\"https://docs.didx.co.za/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening#webpage\"},\"dateModified\":\"2026-06-17T14:27:14.289Z\",\"publisher\":{\"@id\":\"https://docs.didx.co.za/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.didx.co.za#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DIDx Developer Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"DIDx Developer Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening.md","siteName":"DIDx Developer Documentation","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"list","href":"/changelog"}]},"products":[{"product":"didx:me","icon":"id-card","description":"Issue and manage verifiable credentials.","pages":[{"title":"didx:me","href":"/products/didx-me/getting-started/welcome"}]},{"product":"didx:verify","icon":"shield-check","description":"Real-time identity verification and compliance screening.","tabs":[{"tab":"Getting Started","icon":"play","pages":[{"title":"Getting Started","href":"/products/didx-verify/getting-started/introduction"}]},{"tab":"Integration Guides","icon":"book-open","pages":[{"title":"Integration Guides","href":"/products/didx-verify/guides/identity-verification/rsa-id"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Marketplace","pages":[{"group":"Identity Verification","expanded":false,"pages":[{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/RSAIDVerification","title":"Secure Citizen Lookup RSAID verification call","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-lookup-rsaid-verification-call"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/ValidateRSAIDDoc","title":"Secure Citizen RSA ID Validation","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-rsa-id-validation"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/ValidateRSAIDDocAndPhoto","title":"Secure Citizen RSA ID Validation (with photo match)","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-rsa-id-validation-with-photo-match"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/ValidateRSAIDDocAndPhotoWithLiveness","title":"Secure Citizen RSA ID Validation (with liveness)","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-rsa-id-validation-with-liveness"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/PassportValidation","title":"Secure Citizen Passport Validation","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-passport-validation"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/ValidatePassportAndPhoto","title":"Secure Citizen Passport Validation (with photo match)","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-passport-validation-with-photo-match"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/ValidatePassportAndPhotoWithLiveness","title":"Performs passport validation with face matching and liveness","href":"/products/didx-verify/api-reference/v1/citizen/performs-passport-validation-with-face-matching-and-liveness"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/RefugeeVerification","title":"Secure Citizen Lookup Refugee verification call","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-lookup-refugee-verification-call"}]},{"group":"Biometrics","expanded":false,"pages":[{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/FaceCompare","title":"Face Compare","href":"/products/didx-verify/api-reference/v1/citizen/face-compare"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/FaceCompareWithLiveness","title":"Face Compare with Liveness Check","href":"/products/didx-verify/api-reference/v1/citizen/face-compare-with-liveness-check"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/ValidateFingerPrint","title":"Secure Citizen Fingerprint Validation","description":"This is a service that validates fingerprint against dha","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-fingerprint-validation"}]},{"group":"Compliance \u0026 Screening","expanded":false,"pages":[{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/AMLScreening","title":"Secure Citizen Anti-Money Laundering Screening","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-anti-money-laundering-screening"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/SAFPSDetailedSearch","deprecated":true,"title":"Perform detailed search. This endpoint is deprecated and soon will be removed. Please migrate to /SAFPSDetailedObjectSearch","description":null,"href":"/products/didx-verify/api-reference/v1/citizen/perform-detailed-search"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/SAFPSDetailedObjectSearch","title":"Perform detailed object search","href":"/products/didx-verify/api-reference/v1/citizen/perform-detailed-object-search"}]},{"group":"Financial Verification","expanded":false,"pages":[{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/AccountVerificationService","title":"Secure Citizen Bank Account Verification","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-bank-account-verification"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/DriversLicenseVerificationService","title":"Secure Citizen Drivers License Verification","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-drivers-license-verification"}]},{"group":"Enterprise","expanded":false,"pages":[{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/CIPCCheckEnterprise","title":"Get CIPC Enterprise information","href":"/products/didx-verify/api-reference/v1/citizen/get-cipc-enterprise-information"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/CIPCCheckDirectors","title":"Get All CIPC Enterprise Directors","href":"/products/didx-verify/api-reference/v1/citizen/get-all-cipc-enterprise-directors"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/GetRegistrationStatus","title":"Secure Citizen Get Registration Status Service","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-get-registration-status-service"},{"openapi":"products/didx-verify/api-reference/v1/openapi.json post /Citizen/StatisticalProofOfAddress","title":"Secure Citizen Statistical Proof of Address","href":"/products/didx-verify/api-reference/v1/citizen/secure-citizen-statistical-proof-of-address"}]}]},{"group":"Journey","pages":[{"group":"Journey API","expanded":false,"pages":[{"openapi":"products/didx-verify/api-reference/v1/journey.json post /journey/generate-flow-link","title":"Enrols a subject into a configured flow and returns a reusable journey link.","href":"/products/didx-verify/api-reference/v1/journey/verify/enrols-a-subject-into-a-configured-flow-and-returns-a-reusable-journey-link"},{"openapi":"products/didx-verify/api-reference/v1/journey.json get /journey/request-flow-results/{pin}","title":"Returns the completed webhook payload for a flow.","href":"/products/didx-verify/api-reference/v1/journey/verify/returns-the-completed-webhook-payload-for-a-flow"},{"openapi":"products/didx-verify/api-reference/v1/journey.json post /journey/generate-qid-link","title":"Starts a QID verification session and returns the provider verification link.","href":"/products/didx-verify/api-reference/v1/journey/verify/starts-a-qid-verification-session-and-returns-the-provider-verification-link"},{"openapi":"products/didx-verify/api-reference/v1/journey.json get /journey/request-qid-result/{pin}","title":"Retrieves the result of a QID verification by pin.","href":"/products/didx-verify/api-reference/v1/journey/verify/retrieves-the-result-of-a-qid-verification-by-pin"}]},{"group":"CustomClient3 API","expanded":false,"pages":[{"title":"Start enrolment process","openapi":"products/didx-verify/api-reference/v1/customclient3.json post /CustomClient3/CustomClient3StartProcess","href":"/products/didx-verify/api-reference/v1/customclient3/customclient3/customclient3--start-enrollment-process"},{"title":"Request enrolment result","openapi":"products/didx-verify/api-reference/v1/customclient3.json post /CustomClient3/CustomClient3RequestResult","href":"/products/didx-verify/api-reference/v1/customclient3/customclient3/customclient3--start-enrollment-process-1"}]}]}]}]}]},"basePath":"","title":"Secure Citizen Anti-Money Laundering Screening - DIDx Developer Documentation","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CDiBsYGW.js","utils-KF9rPlmF.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C26urKTX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BdjmJAC1.js","snippetPresets-3IpDBjt3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-D4x_2vvo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BIWdc5Pa.js","shallow-LQqfiMNd.js","getApiPlaygroundDisplay-DryzlOZG.js","CodeSnippet-tcJujU4r.js","CodeSnippets-BHp0nVLL.js","Page-1CZdsdAn.js","getPastedJson-DU-1ayUv.js","icon-CZK2hPr4.js","MethodPill-DOaqmTFC.js","DuplicateIcon-B5-nUxxl.js","createIcon-CDP_U77G.js","DynamicMarkdown-GHvayGOn.js","SectionHeading-BYvpkmUD.js","axios-vUo_bRtp.js","Markdown-uxhlayGT.js","clsx-B35qUV0p.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BvrGG8gU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CAf0yVYe.js"]}