{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}
{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}
{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}
{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}
{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}
Flag
Set Entity Ongoing AML Monitoring Status.
Mark the entity as being monitored or not with the ‘?set=’ query parameter as ‘true’ or ‘false’.
Setting this parameter to ‘true’ will disable ongoing monitoring.
Setting this parameter to ‘false’ will enable ongoing monitoring.
If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.
Note: If using a CustomerChildID, you will also need a separate api_key for each child.
Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data.
A Customer can see the documents/entities and checks of all their Children.
Open string that can be used to define the "channel" the request comes in from.
It can potentially be used in routing and risk calculations upon request.
Default values that can be used are:
api
portal
smartui
Any alphanumeric string is supported though. Anything over 64 characters will be truncated.
The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.
Contains the results of a given document entity create/update or GET request.
Unique identifier for every request. Can be used for tracking down answers with technical support.
Uses the ULID format (a time-based, sortable UUID)
Note: this will be different for every request.
Example:
"01BFJA617JMJXEW6G7TDDXNSHX"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://www.mintlify.com/docs.json","name":"frankieone","colors":{"primary":"#1A6CFF","light":"#1A6CFF","dark":"#1A6CFF"},"logo":{"light":"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/light.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=21923909c20fa1b38b317371ccac6e33","dark":"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/dark.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=196c598869b49c924efc8e44399fda09","href":"https://docs.frankieone.com"},"favicon":"https://mintcdn.com/frankieone-f5583b1b/cNmgsKD2V0ccWp6T/favicon.png?fit=max\u0026auto=format\u0026n=cNmgsKD2V0ccWp6T\u0026q=85\u0026s=82de5d057bc772d870f18df413b453f9","appearance":{"default":"system","strict":true},"background":{"color":{"light":"#f4f5fc","dark":"#10152e"}},"navbar":{"links":[{"href":"https://status.frankieone.com/","label":"Support"}],"primary":{"type":"button","label":"Book a Demo","href":"https://frankieone.com/book-a-demo"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/frankieone"}},"seo":{"metatags":{"canonical":"https://docs.frankieone.com","og:url":"https://docs.frankieone.com"}},"fonts":{"heading":{"family":"DM Sans","weight":800,"source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2","format":"woff2"},"body":{"family":"DM Sans","source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2","format":"woff2"}},"integrations":{"ga4":{"measurementId":"G-TQB66YCL53"}},"errors":{"404":{"redirect":true,"title":"Sorry, we couldn't find the page you're looking for.","description":"Please try searching for a different term, use the navigation bar, or return to the homepage."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Service Status","icon":"signal","href":"https://status.frankieone.com"},{"anchor":"Blog","icon":"newspaper","href":"https://frankieone.com/frankieone-blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"frankieone-f5583b1b","hasAudioNarration":false,"actualSubdomain":"frankieone-f5583b1b","customDomains":["docs.frankieone.com"],"gitSource":{"type":"github","owner":"frankieone","repo":"config-api-documentation-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae03c8db99df1c7e7005e9c","collectionId":"7f88f383-ee0f-4d63-9d72-52af05554760","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae03c8db99df1c7e7005e9c"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae14a8e30e15bc50808db7b","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API","count":236},{"language":"default","tag":"Portal","count":188},{"language":"default","tag":"OneSDK","count":137},{"language":"default","tag":"KYC","count":131},{"language":"default","tag":"KYB","count":68},{"language":"default","tag":"KYC API Endpoints","count":50},{"language":"default","tag":"KYC V2 API","count":45},{"language":"default","tag":"About OneSDK","count":40},{"language":"default","tag":"Guide to the API","count":38},{"language":"default","tag":"Introduction","count":35}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"help@frankieone.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":":root{color-scheme:light dark}[data-theme=dark]{color-scheme:dark}[data-theme=light]{color-scheme:light}span[data-as=p]:not(:where([data-page=\"/\"])){color:light-dark(#000,#fff)!important}p,tr,ul{color:light-dark(#000,#fff)!important}code{color:#1a6cff!important}"}],"page":{"pagePath":"docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring","slug":"/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring","pageMetadata":{"title":"Set Entity Ongoing AML Monitoring Status.","openapi":"POST /entity/{entityId}/flag/monitor","description":"Mark the entity as being monitored or not with the '?set=' query parameter as 'true' or 'false'.\nSetting this parameter to 'true' will disable ongoing monitoring.\nSetting this parameter to 'false' will enable ongoing monitoring.\n","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring"},"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: \"Mark the entity as being monitored or not with the ‘?set=’ query parameter as ‘true’ or ‘false’.\\nSetting this parameter to ‘true’ will disable ongoing monitoring.\\nSetting this parameter to ‘false’ will enable ongoing monitoring.\"\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":{"title":"Set Entity Ongoing AML Monitoring Status.","openapi":"POST /entity/{entityId}/flag/monitor","description":"Mark the entity as being monitored or not with the '?set=' query parameter as 'true' or 'false'.\nSetting this parameter to 'true' will disable ongoing monitoring.\nSetting this parameter to 'false' will enable ongoing monitoring.\n","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Mark the entity as being monitored or not with the '?set=' query parameter as 'true' or 'false'.\nSetting this parameter to 'true' will disable ongoing monitoring.\nSetting this parameter to 'false' will enable ongoing monitoring.\n","tags":["Flag"],"summary":"Set Entity Ongoing AML Monitoring Status.","operationId":"EntityMonitoring","parameters":["56c16932-3d93-42e0-9827-2ee2a670e86d","f77dc08e-8d1a-4d90-a813-0a817ff2561e","6215846f-cd29-4f0d-8ac9-d86851ead7d5","e39f9bf2-d916-48d1-a4c6-7b87c2668602","2e03ef2f-825f-4c8c-984a-0d0544ffd03a"],"responses":{"200":"c799bec5-974d-4fa8-84be-202bc0c44df6","400":"d266864c-f2b8-4f3e-9a9a-bb3d46842f08","401":"283f3a1b-8a2a-4bf8-b593-f75d058df6e7","404":"385a338b-8d52-426d-b3df-0ec324721ef6","429":"04f3f576-e701-4bdd-84a7-b5db60c4b225","500":"04902ae0-8cdc-453e-9e6c-77b5369ebefe"},"method":"post","type":"path","servers":["f99f7d52-aee6-4307-b2ff-d95bafe383b8"],"security":["ab662a77-eed9-4cc3-809e-fc809d0f7a47"],"path":"/entity/{entityId}/flag/monitor","baseUrlOptions":["https://api.uat.frankie.one/compliance/v1.2"],"title":"Set Entity Ongoing AML Monitoring Status.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"56c16932-3d93-42e0-9827-2ee2a670e86d":{"description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.\n","name":"X-Frankie-CustomerID","in":"header","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.\n","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"f77dc08e-8d1a-4d90-a813-0a817ff2561e":{"description":"If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.\n\nNote: If using a CustomerChildID, you will also need a separate api_key for each child.\n\nAny documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data.\n\nA Customer can see the documents/entities and checks of all their Children.\n","name":"X-Frankie-CustomerChildID","in":"header","schema":{"type":"string","format":"uuid","description":"If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.\n\nNote: If using a CustomerChildID, you will also need a separate api_key for each child.\n\nAny documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data.\n\nA Customer can see the documents/entities and checks of all their Children.\n","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"6215846f-cd29-4f0d-8ac9-d86851ead7d5":{"description":"Open string that can be used to define the \"channel\" the request comes in from.\nIt can potentially be used in routing and risk calculations upon request.\nDefault values that can be used are:\n - api\n - portal\n - smartui\n\nAny alphanumeric string is supported though. Anything over 64 characters will be truncated.\n","name":"X-Frankie-Channel","in":"header","schema":{"type":"string","description":"Open string that can be used to define the \"channel\" the request comes in from.\nIt can potentially be used in routing and risk calculations upon request.\nDefault values that can be used are:\n - api\n - portal\n - smartui\n\nAny alphanumeric string is supported though. Anything over 64 characters will be truncated.\n","uniqueKey":"","typeLabel":"string"}},"e39f9bf2-d916-48d1-a4c6-7b87c2668602":{"description":"The entityId returned previously from an earlier call to /check or /entity","name":"entityId","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The entityId returned previously from an earlier call to /check or /entity","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"2e03ef2f-825f-4c8c-984a-0d0544ffd03a":{"description":"Set the value of an entity flag.\n","name":"set","in":"query","required":true,"schema":{"type":"boolean","isRequired":true,"description":"Set the value of an entity flag.\n","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"c799bec5-974d-4fa8-84be-202bc0c44df6":{"description":"The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.","content":{"application/json":{"schema":{"description":"Contains the results of a given document entity create/update or GET request.","type":"object","required":["requestId","entity"],"properties":{"entity":{"description":"Describes all of the data being used to verify an entity.\n","type":"object","properties":{"addresses":{"description":"Collection of address objects.","type":"array","items":{"type":"object","required":["country"],"properties":{"country":{"description":"The ISO-3166-1 country. You must use the alpha3 country code (e.g. AUS, USA, IDR, KOR, etc) We'll convert as needed. \n\nSee: https://en.wikipedia.org/wiki/ISO_3166-1\n","type":"string","example":"AUS","isRequired":true,"uniqueKey":"entity.addresses.items.[INDEX].country","typeLabel":"string"},"addressId":{"description":"As addresses are added to an entity, they're assigned an id to assist with tracking. \n\nIf you're adjusting an address, you will need to include the addressId so as to be able to reference it correctly in the list.\n","type":"string","format":"uuid","example":"86932629-bdb4-158f-e670-741e89ff78ba","uniqueKey":"entity.addresses.items.[INDEX].addressId","typeLabel":"string\u003cuuid>"},"addressType":{"description":"Used to indicate what sort address this is, such as residential, business, postal, etc.\n\nRESIDENTIAL1-4 can be used to indicate the reverse chronological order of addresses. \nRESIDENTIAL or RESIDENTIAL1 is the current address\nRESIDENTIAL2 is the previous address, and so on.\n\nFor Individual postal/mailing addresses, use POSTAL.\nFor Businesses, use OFFICIAL_CORRESPONDANCE\n","type":"string","enum":["OTHER","RESIDENTIAL","RESIDENTIAL1","RESIDENTIAL2","RESIDENTIAL3","RESIDENTIAL4","BUSINESS","POSTAL","REGISTERED_OFFICE","PLACE_OF_BUSINESS","OFFICIAL_CORRESPONDANCE","PLACE_OF_BIRTH"],"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumAddressType"},"example":"REGISTERED_OFFICE","uniqueKey":"entity.addresses.items.[INDEX].addressType","typeLabel":"enum\u003cstring>"},"buildingName":{"description":"The name of the building, apartment block, condo, etc","type":"string","example":"Highland Tower","uniqueKey":"entity.addresses.items.[INDEX].buildingName","typeLabel":"string"},"careOf":{"description":"Individual or business name at this address if not the same as the name of the entity to which this address belongs.\n","type":"string","uniqueKey":"entity.addresses.items.[INDEX].careOf","typeLabel":"string"},"endDate":{"description":"The date this address was no longer used (if available). Used mostly with business addresses.\n","type":"string","format":"date","example":"0001-01-01","uniqueKey":"entity.addresses.items.[INDEX].endDate","typeLabel":"string\u003cdate>"},"extraData":{"description":"Set of key-value pairs that provide arbitrary additional type-specific data. This data will typically not be visible in the Frankie Portal.\nIf updating an existing address, then existing values with the same name will be overwritten. New values will be added.\n\nSee here for more information about possible values you can use:\n https://docs.frankieone.com/docs/key-value-pairs\n","type":"array","items":{"description":"Individual key-value pair","type":"object","properties":{"kvpKey":{"description":"Name of the data","type":"string","example":"ACN","uniqueKey":"entity.addresses.items.[INDEX].extraData.items.[INDEX].kvpKey","typeLabel":"string"},"kvpType":{"description":"Used to describe the contents of the KVP data. \n\nThe general.* and raw.* types are pretty much what they say on the tin. \n\nAll raw.* fields will be base64 encoded so as to not interfere with JSON structuring. These are useful for returning/storing large quantities of data that doesn't necessarily require processing now, or may be useful to a calling client.\n\nThe id.* and pii.* are used to indicate that this is data that can be used to create new document objects, or entities. They should also be treated with the utmost care and attention when it comes to securing them too.\n\nid.external can be used to capture an object's ID on an external service, and can potentially be searchable in the index \nNote - This is different from a result.id.\n\ndefunct is used to mark an existing KVP deleted when the value must be retained, for example for audit purposes.\n\nresult.* are used to capture response codes and transaction IDs from external services\n\nerror.* types can be used when processing a document that returns an error, but doesn't necessarily require a full blown error response.\n","type":"string","enum":["defunct","general.string","general.integer","general.float","general.bool","general.date","general.datetime","raw.json.base64","raw.xml.base64","raw.base64","error.code","error.message","result.code","result.id","id.external","id.number.primary","id.number.additional","id.msisdn","id.email","id.device","pii.name.full","pii.name.familyname","pii.name.givenname","pii.name.middlename","pii.gender","pii.address.longform","pii.address.shortform","pii.address.street1","pii.address.street2","pii.address.postalcode","pii.address.town","pii.address.suburb","pii.address.region","pii.address.state","pii.address.country","pii.dob","transient.string"],"example":"id.external","x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumKVPType"},"uniqueKey":"entity.addresses.items.[INDEX].extraData.items.[INDEX].kvpType","typeLabel":"enum\u003cstring>"},"kvpValue":{"description":"Value of the data","type":"string","example":"406655338","uniqueKey":"entity.addresses.items.[INDEX].extraData.items.[INDEX].kvpValue","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"KeyValuePairObject"},"uniqueKey":"entity.addresses.items.[INDEX].extraData.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.addresses.items.[INDEX].extraData","typeLabel":"object[]"},"longForm":{"description":"In some cases, the address will need to be supplied in \"long form\", such as when it is determined from a document scan, or is un-parsable in some way.\nThe service will attempt to convert it to it's constituent parts where possible.\n\nWARNING: Use of longForm is not guaranteed to produce perfect results, due to the variety of potential formats. You've been warned. \nFailure to break down or disambiguate the address will result in an error.\n","type":"string","example":"42a Test Eagle Road, Testville, TST 123-TST, Testalia","uniqueKey":"entity.addresses.items.[INDEX].longForm","typeLabel":"string"},"postalCode":{"description":"The post code of the address.","type":"string","example":"3000","uniqueKey":"entity.addresses.items.[INDEX].postalCode","typeLabel":"string"},"region":{"description":"The county, province, cantonment","type":"string","example":"MELBOURNE","uniqueKey":"entity.addresses.items.[INDEX].region","typeLabel":"string"},"startDate":{"description":"The date this address first because active. Used mostly with business addresses.\n","type":"string","format":"date","example":"2023-03-10","uniqueKey":"entity.addresses.items.[INDEX].startDate","typeLabel":"string\u003cdate>"},"state":{"description":"The state. Use local abbreviations, such as VIC(toria) or TX (Texas)","type":"string","example":"VIC","uniqueKey":"entity.addresses.items.[INDEX].state","typeLabel":"string"},"streetName":{"description":"The name of the street\n\nThis field can in fact be a bit flexible, potentially containing the streetNumber and streetType as well. Most services in use can work it out.\n\nIf this field has been auto-populated by Google (see writeup here:\n\nhttps://docs.frankieone.com/docs/working-with-addresses\nthen the bulk of the address will be in this field.\n\nIf you can avoid it though, please try and keep things separate.\n","type":"string","example":"9 ROYCE AVENUE","uniqueKey":"entity.addresses.items.[INDEX].streetName","typeLabel":"string"},"streetNumber":{"description":"The number on the street. Generally a number, but can also be alphanumeric (e.g. 3A)\n","type":"string","example":"FLAT 27","uniqueKey":"entity.addresses.items.[INDEX].streetNumber","typeLabel":"string"},"streetType":{"description":"The street \"type\" - e.g. Road, St, Ave, Circuit, etc","type":"string","example":"Road","uniqueKey":"entity.addresses.items.[INDEX].streetType","typeLabel":"string"},"suburb":{"description":"The suburb in the town/city. Only use this if you require a suburb AND a town/city, otherwise, just use the \"town\" parameter.","type":"string","example":"Testburb","uniqueKey":"entity.addresses.items.[INDEX].suburb","typeLabel":"string"},"town":{"description":"The town/village/suburb/city","type":"string","example":"MELBOURNE","uniqueKey":"entity.addresses.items.[INDEX].town","typeLabel":"string"},"unitNumber":{"description":"Unit/Apartment/Flat/Suite/etc number","type":"string","example":"FLAT 27","uniqueKey":"entity.addresses.items.[INDEX].unitNumber","typeLabel":"string"},"unstructuredLongForm":{"type":"string","uniqueKey":"entity.addresses.items.[INDEX].unstructuredLongForm","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"AddressObject"},"uniqueKey":"entity.addresses.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.addresses","typeLabel":"object[]"},"dateOfBirth":{"type":"object","properties":{"country":{"description":"ISO-3166-1 code for the country of birth. You must use the alpha3 country code (e.g. AUS, USA, IDR, KOR, etc) We'll convert as needed.\n\nSee https://en.wikipedia.org/wiki/ISO_3166-1\n","type":"string","example":"AUS","uniqueKey":"entity.dateOfBirth.country","typeLabel":"string"},"dateOfBirth":{"description":"Date of Birth in YYYY-MM-DD format","type":"string","format":"date","example":"1978-11-12","uniqueKey":"entity.dateOfBirth.dateOfBirth","typeLabel":"string\u003cdate>"},"locality":{"description":"Place of birth other than country If locality is given, then country must also be provided.\n","type":"string","example":"Brisbane","uniqueKey":"entity.dateOfBirth.locality","typeLabel":"string"},"unstructuredDateOfBirth":{"type":"string","uniqueKey":"entity.dateOfBirth.unstructuredDateOfBirth","typeLabel":"string"},"yearOfBirth":{"description":"Year of birth or \"unknown\". This will be autoextracted if dateOfBirth is supplied.","type":"string","example":"1978","uniqueKey":"entity.dateOfBirth.yearOfBirth","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"DOBObject"},"uniqueKey":"entity.dateOfBirth","typeLabel":"object"},"entityId":{"description":"When an entity is first created, it is assigned an ID. When updating an entity, make sure you set the entityId\nOne exception to this is when an entity is created from a document object. It is expected that this object would be passed into a /check or /entity call to set it.\n","type":"string","format":"uuid","example":"84a9a860-68ae-4d7d-9a53-54a1116d5051","uniqueKey":"entity.entityId","typeLabel":"string\u003cuuid>"},"entityProfile":{"description":"If the entity is using the new profiles feature, then their profile name will be found here.\n\nNote: If setting a profile, you must ensure that the profile matches a known configuration.\n\nSee here for valid values:\n https://docs.frankieone.com/docs/test-entity-verification\n","type":"string","x-omitempty":true,"uniqueKey":"entity.entityProfile","typeLabel":"string"},"entityType":{"description":"Indicates the type of an entity.\n- \"INDIVIDUAL\": An individual.\n- \"TRUST\": A trust.\n- \"ORGANISATION\": An organisation.\n","type":"string","enum":["INDIVIDUAL","TRUST","ORGANISATION"],"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumEntityType"},"example":"ORGANISATION","uniqueKey":"entity.entityType","typeLabel":"enum\u003cstring>"},"extraData":{"description":"Set of key-value pairs that provide arbitrary additional type-specific data. You can use these fields to store external IDs, or other non-identity related items if you need to.\nIf updating an existing entity, then existing values with the same name will be overwritten. New values will be added.\n\nSee here for more information about possible values you can use:\n https://docs.frankieone.com/docs/key-value-pairs\n","type":"array","items":{"description":"Individual key-value pair","type":"object","properties":{"kvpKey":{"description":"Name of the data","type":"string","example":"ACN","uniqueKey":"entity.extraData.items.[INDEX].kvpKey","typeLabel":"string"},"kvpType":{"description":"Used to describe the contents of the KVP data. \n\nThe general.* and raw.* types are pretty much what they say on the tin. \n\nAll raw.* fields will be base64 encoded so as to not interfere with JSON structuring. These are useful for returning/storing large quantities of data that doesn't necessarily require processing now, or may be useful to a calling client.\n\nThe id.* and pii.* are used to indicate that this is data that can be used to create new document objects, or entities. They should also be treated with the utmost care and attention when it comes to securing them too.\n\nid.external can be used to capture an object's ID on an external service, and can potentially be searchable in the index \nNote - This is different from a result.id.\n\ndefunct is used to mark an existing KVP deleted when the value must be retained, for example for audit purposes.\n\nresult.* are used to capture response codes and transaction IDs from external services\n\nerror.* types can be used when processing a document that returns an error, but doesn't necessarily require a full blown error response.\n","type":"string","enum":["defunct","general.string","general.integer","general.float","general.bool","general.date","general.datetime","raw.json.base64","raw.xml.base64","raw.base64","error.code","error.message","result.code","result.id","id.external","id.number.primary","id.number.additional","id.msisdn","id.email","id.device","pii.name.full","pii.name.familyname","pii.name.givenname","pii.name.middlename","pii.gender","pii.address.longform","pii.address.shortform","pii.address.street1","pii.address.street2","pii.address.postalcode","pii.address.town","pii.address.suburb","pii.address.region","pii.address.state","pii.address.country","pii.dob","transient.string"],"example":"id.external","x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumKVPType"},"uniqueKey":"entity.extraData.items.[INDEX].kvpType","typeLabel":"enum\u003cstring>"},"kvpValue":{"description":"Value of the data","type":"string","example":"406655338","uniqueKey":"entity.extraData.items.[INDEX].kvpValue","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"KeyValuePairObject"},"uniqueKey":"entity.extraData.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.extraData","typeLabel":"object[]"},"flags":{"description":"Used to set additional information flags with regards to this entity and for ongoing processing.\n\nFlags might include having the entity (not) participate in regular pep/sanctions screening\nOthers will follow over time.\n","type":"array","items":{"description":"Similar to a KVP, the flag has a key (the flag you're indicating) and an integer value.\n\nValues are tied to the specific flag (see table below). Generally they're true (1)/false(0) indicators.\n\n | flag | values | Description |\n | ------- | -------- | -------- |\n | ongoing_pep | 0, 1, 2 | 0 = no, 1 = pep/sanctions, 2 = 1+media |\n | | | |\n","type":"object","properties":{"flag":{"description":"Name of the flag","type":"string","uniqueKey":"entity.flags.items.[INDEX].flag","typeLabel":"string"},"value":{"description":"flag value.","type":"integer","x-omitempty":false,"uniqueKey":"entity.flags.items.[INDEX].value","typeLabel":"integer"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EntityFlagObject"},"uniqueKey":"entity.flags.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.flags","typeLabel":"object[]"},"gender":{"description":"Used to indicate of the entity in question is:\n- \"M\"ale \n- \"F\"emale\n- \"U\"nspecified\n- \"O\"ther (for want of a better option)\n","type":"string","enum":["U","F","M","O"],"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumGender"},"example":"F","uniqueKey":"entity.gender","typeLabel":"enum\u003cstring>"},"identityDocs":{"description":"Collection of identity documents (photos, scans, selfies, etc)","type":"array","items":{"type":"object","required":["idType","country"],"properties":{"country":{"description":"The ISO-3166-alpha3 country code of the issuing national. Once set, this cannot be changed.\n\nSee https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes for more\n","type":"string","example":"AUS","isRequired":true,"uniqueKey":"entity.identityDocs.items.[INDEX].country","typeLabel":"string"},"idType":{"description":"Valid ID types\n - \"OTHER\": Generic document type. Unspecified.\n - \"DRIVERS_LICENCE\": Driver's licence.\n - \"PASSPORT\": Passport\n - \"VISA\": Visa document (not Visa payment card)\n - \"IMMIGRATION\": Immigration card\n - \"NATIONAL_ID\": Any national ID card\n - \"TAX_ID\": Any national tax identifier\n - \"NATIONAL_HEALTH_ID\": Any national health program ID card (e.g. Medicare, NHS)\n - \"CONCESSION\": State issued concession card\n - \"HEALTH_CONCESSION\": State issued health specific concession card\n - \"SENIORS_HEALTH_CONCESSION\": State issued health specific concession card for seniors\n - \"PENSION\": State issued pension ID\n - \"MILITARY_ID\": Military ID\n - \"BIRTH_CERT\": Birth certificate\n - \"CITIZENSHIP\": Citizenship certificate\n - \"MARRIAGE_CERT\": Marriage certificate\n - \"DEATH_CERT\": Death certificate\n - \"NAME_CHANGE\": Name chage confirmation\n - \"UTILITY_BILL\": Regulated utility bill, such as electricity, gas, etc\n - \"BANK_STATEMENT\": Bank/card statement\n - \"BANK_ACCOUNT\": Bank account\n - \"INTENT_PROOF\": A proof of intent. Generally a photo/video, or a scanned letter\n - \"ATTESTATION\": A document of attestation (e.g. Statutory Declaration). NOTE: these cannot be used as a supporting document\n - \"SELF_IMAGE\": A \"selfie\" used for comparisions\n - \"EMAIL_ADDRESS\": An email address\n - \"MSISDN\": A mobile phone number\n - \"DEVICE\": A device ID\n - \"VEHICLE_REGISTRATION\": Vehicle registration number\n - \"PROOF_OF_ADDRESS\": Can be any type of document that provides a proof of address\n - \"HOUSE_REGISTRATION\": House registration document\n - \"YELLOW_HOUSE_REGISTRATION\": Yellow House Registration Thor Ror 13\n - \"WORK_PERMIT\": Work permit\n - \"EMPLOYMENT_CERTIFICATE\": Certificate of employment\n - \"NOTARY_PUBLIC_ID\": Notary Public Identification\n - \"AVIATION_SECURITY_ID\": Aviation Security Identification\n - \"MARITIME_SECURITY_ID\": Maritime Security Identification\nBusiness related documentation\n - \"EXTERNAL_ADMIN\": Details of appointed administrator.\n - \"CHARGES\": Details of any charges that have been laid against a company or director\n - \"PRE_ASIC\": Any documents that are Pre-ASIC\n - \"ANNUAL_RETURN\": Details of a company's annual return\n - \"REPORT\": Frankie generated report.\n - \"TRUST_DEED\": Corporate trust deed\n - \"PARTNERSHIP_AGREEMENT\": Partnership agreement documents\n - \"ADMIN_CHANGE\": Change of Administrator\n - \"COMPANY_REPORT\": ASIC filed company reports\nSpecial document types\n - \"CHECK_RESULTS\": A special document type for specifying results of checks completed other than through Frankie.\n","type":"string","enum":["OTHER","DRIVERS_LICENCE","PASSPORT","VISA","IMMIGRATION","NATIONAL_ID","TAX_ID","NATIONAL_HEALTH_ID","CONCESSION","HEALTH_CONCESSION","SENIORS_HEALTH_CONCESSION","PENSION","MILITARY_ID","BIRTH_CERT","CITIZENSHIP","MARRIAGE_CERT","DEATH_CERT","NAME_CHANGE","MOBILE_PHONE","UTILITY_BILL","BANK_STATEMENT","BANK_ACCOUNT","INTENT_PROOF","ATTESTATION","SELF_IMAGE","EMAIL_ADDRESS","MSISDN","DEVICE","VEHICLE_REGISTRATION","PROOF_OF_ADDRESS","HOUSE_REGISTRATION","YELLOW_HOUSE_REGISTRATION","WORK_PERMIT","EMPLOYMENT_CERTIFICATE","NOTARY_PUBLIC_ID","AVIATION_SECURITY_ID","MARITIME_SECURITY_ID","EXTERNAL_ADMIN","CHARGES","PRE_ASIC","ANNUAL_RETURN","REPORT","TRUST_DEED","PARTNERSHIP_AGREEMENT","ADMIN_CHANGE","COMPANY_REPORT","CHECK_RESULTS"],"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumIdType"},"example":"DRIVERS_LICENCE","isRequired":true,"uniqueKey":"entity.identityDocs.items.[INDEX].idType","typeLabel":"enum\u003cstring>"},"createdFromScan":{"description":"This document's data was initially created from scanned and processed images. The value cannot be set manually and any attempt to do so will just be ignored.\n","type":"boolean","readOnly":true,"example":true,"uniqueKey":"entity.identityDocs.items.[INDEX].createdFromScan","typeLabel":"boolean"},"docScan":{"description":"Collection of one or more objects that describe scan(s) that need to be put through OCR or facial recognition. These should all be from the one ID document, such as front/back, or page 1, 2, 3, etc. You can upload multiple scans in a single call, or in multiple calls. \n\n Note: if you do upload over multiple calls, make sure you include the documentId (see above), and indicate that this is happening with a \"more_data\" checkAction\n","type":"array","items":{"description":"the document to be attached and optionally scanned (if supported)","type":"object","properties":{"ScanDelete":{"description":"Used as a way of indicating to the service that the original scanned document is not to be kept after it has been processed. We will retain any metadata and the results of processing (where required by regulation or the customer), but the original file uploaded will eventually be remnoved once processing is complete. \n\nIf ScanDelete is set to true, any call with /full at the end will still not return the file contents, regardless of whether the file has been deleted yet (the deletion process is a background task that can take a few minutes to occur)\n","type":"boolean","uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].ScanDelete","typeLabel":"boolean"},"scanCreated":{"description":"The date and time the scan was created. Not the date of the scanned document, which should be in the idIssued attribute of the document that owns this scan.\n","type":"string","format":"date-time","example":"2020-06-02","uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].scanCreated","typeLabel":"string\u003cdate-time>"},"scanData":{"description":"Base64 encoded string of a photo or scan of an ID document to be verified. If supplied and of a supported type, the Frankie service will attempt to use OCR tech to extract the data from the scanned doc/image.\n\nIn a result message, this field will be left blank, unless the \"full\" action is requested.\n","type":"string","format":"byte","example":"VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==","uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].scanData","typeLabel":"string\u003cbyte>"},"scanDataRetrievalState":{"description":"The reason why the scanData in a response is missing.\n- \"NORMAL\": The scanData was retrieved and is included. If it is empty then it was never provided or was provided empty.\n- \"EXCLUDED\": The retrieval request was not for 'full' data, or the object has 'ScanDelete' set so the scanData is not included\n- \"FAILED\": The scanData could not be retrieved from the secure document store.\n\nThe enumScanDataRetrievalState will not usually be set in a request. If a ScannedDocumentObject in a response has a 'FAILED' retrieval state then that object should not be sent back in a future possible update. It should either be omitted or the original data should be resent if it is available from another source. However it is safe to send the object in an update with the state received in a response. Any state other than 'NORMAL' (or '') will cause the blank scanData to be ignored, but other fields in the object will be updated if needed.\n","type":"string","enum":["NORMAL","EXCLUDED","FAILED"],"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumScanDataRetrievalState"},"example":"NORMAL","uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].scanDataRetrievalState","typeLabel":"enum\u003cstring>"},"scanDocId":{"description":"When an document scan is created/uploaded, it is assigned a scanDocId. You'll see this in a successful response or successfully accepted response. This can then be referenced in subsequent calls if you're uploading more/updated data.\n","type":"string","format":"uuid","example":"84a9a860-68ae-4d7d-9a53-54a1116d5051","uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].scanDocId","typeLabel":"string\u003cuuid>"},"scanFilename":{"description":"If you're uploading a file where it's important to keep the original filename, then you can provide that here. Otherwise the Frankie service will assign an arbitrary name based on the scanDocIdand an extension based on the MIME type\n","type":"string","example":"Important Document - ID1234567.pdf","uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].scanFilename","typeLabel":"string"},"scanMIME":{"description":"The standard MIME type of the file being uploaded. We'll double-check to be certain, but this can help speed things up","type":"string","enum":["image/jpeg","image/avif","image/png","image/gif","image/webp","image/tiff","image/bmp","image/heic","image/heif","application/zip","application/x-zip","application/x-zip-compressed","application/x-tar","application/x-rar-compressed","application/x-gzip","application/gzip","application/x-bzip2","application/x-7z-compressed","application/pdf","application/rtf","application/postscript","application/json","audio/mpeg","audio/m4a","audio/x-wav","audio/amr","text/plain","text/rtf","application/msword","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.ms-excel","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.ms-outlook","application/vnd.ms-powerpoint","application/vnd.oasis.opendocument.text","application/vnd.openxmlformats-officedocument.presentationml.presentation","video/avi","video/x-m4a","video/mp4","video/webm","video/quicktime","video/msvideo","video/x-msvideo","video/x-ms-wmv","video/mpeg"],"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumMIMEType"},"example":"image/png","uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].scanMIME","typeLabel":"enum\u003cstring>"},"scanPageNum":{"description":"If uploading multiple pages - it's handy to keep a track of these. There is no enforcement of these numbers at all. You can have 10 page 1's and a page 29 if you wish.\n","type":"integer","minimum":0,"example":1,"uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].scanPageNum","typeLabel":"integer"},"scanSide":{"description":"Describes if a scan is of the \"F\"ront or \"B\"ack of an ID. If not supplied, Front is always assumed.","type":"string","enum":["F","B"],"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumScanSide"},"example":"F","uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].scanSide","typeLabel":"enum\u003cstring>"},"scanType":{"description":"Valid ID document scan general types.\n- \"PHOTO\": Any photo\n- \"VIDEO\": Any video\n- \"AUDIO\": Any audio\n- \"PDF\": PDF or PS (may contain text, images or both)\n- \"DOC\": Word doc, RTF, etc\n- \"ZIP\": Any compressed file(s)\n","type":"string","enum":["PHOTO","VIDEO","AUDIO","PDF","DOC","ZIP"],"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumScanType"},"example":"PDF","uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX].scanType","typeLabel":"enum\u003cstring>"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ScannedDocumentObject"},"uniqueKey":"entity.identityDocs.items.[INDEX].docScan.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.identityDocs.items.[INDEX].docScan","typeLabel":"object[]"},"documentId":{"description":"When an ID document is created/uploaded, it is assigned a documentId. You'll see this in a successful response or successfully accepted response. This can then be referenced in subsequent calls if you're uploading more/updated data.\n","type":"string","format":"uuid","example":"84a9a860-68ae-4d7d-9a53-54a1116d5051","uniqueKey":"entity.identityDocs.items.[INDEX].documentId","typeLabel":"string\u003cuuid>"},"documentStatus":{"description":"Current status of a document.\n- \"INITIALISING\": the state whilst you're uploading and updating\n- \"SCAN_IN_PROGRESS\": the state whilst it's being scanned. \n- \"DOC_SCANNED\": the document has been scanned and data extracted as best as possible. It's still possible to update the details and add more scans if you wish.\n- \"DOC_CHECKED\": the document has been used as part of a check that has been finalised in some way. You can no longer update this document and any attempt will generate an error.\n","type":"string","enum":["INITIALISING","SCAN_IN_PROGRESS","DOC_SCANNED","DOC_CHECKED"],"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumDocumentStatus"},"example":"DOC_SCANNED","uniqueKey":"entity.identityDocs.items.[INDEX].documentStatus","typeLabel":"enum\u003cstring>"},"extraData":{"description":"Set of key-value pairs that provide ID type-specific data. If updating an existing document, then existing values with the same name will be overwritten. New values will be added.\n\nIf this document is scanned through OCR or similar processes, then extracted data will be found here (Some may be used to populate other fields like idNumber and idExpiry as well)\n","type":"array","items":{"description":"Individual key-value pair","type":"object","properties":{"kvpKey":{"description":"Name of the data","type":"string","example":"ACN","uniqueKey":"entity.identityDocs.items.[INDEX].extraData.items.[INDEX].kvpKey","typeLabel":"string"},"kvpType":{"description":"Used to describe the contents of the KVP data. \n\nThe general.* and raw.* types are pretty much what they say on the tin. \n\nAll raw.* fields will be base64 encoded so as to not interfere with JSON structuring. These are useful for returning/storing large quantities of data that doesn't necessarily require processing now, or may be useful to a calling client.\n\nThe id.* and pii.* are used to indicate that this is data that can be used to create new document objects, or entities. They should also be treated with the utmost care and attention when it comes to securing them too.\n\nid.external can be used to capture an object's ID on an external service, and can potentially be searchable in the index \nNote - This is different from a result.id.\n\ndefunct is used to mark an existing KVP deleted when the value must be retained, for example for audit purposes.\n\nresult.* are used to capture response codes and transaction IDs from external services\n\nerror.* types can be used when processing a document that returns an error, but doesn't necessarily require a full blown error response.\n","type":"string","enum":["defunct","general.string","general.integer","general.float","general.bool","general.date","general.datetime","raw.json.base64","raw.xml.base64","raw.base64","error.code","error.message","result.code","result.id","id.external","id.number.primary","id.number.additional","id.msisdn","id.email","id.device","pii.name.full","pii.name.familyname","pii.name.givenname","pii.name.middlename","pii.gender","pii.address.longform","pii.address.shortform","pii.address.street1","pii.address.street2","pii.address.postalcode","pii.address.town","pii.address.suburb","pii.address.region","pii.address.state","pii.address.country","pii.dob","transient.string"],"example":"id.external","x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EnumKVPType"},"uniqueKey":"entity.identityDocs.items.[INDEX].extraData.items.[INDEX].kvpType","typeLabel":"enum\u003cstring>"},"kvpValue":{"description":"Value of the data","type":"string","example":"406655338","uniqueKey":"entity.identityDocs.items.[INDEX].extraData.items.[INDEX].kvpValue","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"KeyValuePairObject"},"uniqueKey":"entity.identityDocs.items.[INDEX].extraData.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.identityDocs.items.[INDEX].extraData","typeLabel":"object[]"},"idExpiry":{"description":"The expiry date of the document (if known) in YYYY-MM-DD format.","type":"string","format":"date","example":"2020-02-01","uniqueKey":"entity.identityDocs.items.[INDEX].idExpiry","typeLabel":"string\u003cdate>"},"idIssued":{"description":"The issued date of the document (if known) in YYYY-MM-DD format.","type":"string","format":"date","example":"1972-11-04","uniqueKey":"entity.identityDocs.items.[INDEX].idIssued","typeLabel":"string\u003cdate>"},"idNumber":{"description":"The ID number of the document (if known).","type":"string","example":"123456789","uniqueKey":"entity.identityDocs.items.[INDEX].idNumber","typeLabel":"string"},"idSubType":{"description":"The sub-type of identity document. Very document specific.","type":"string","uniqueKey":"entity.identityDocs.items.[INDEX].idSubType","typeLabel":"string"},"manuallyModified":{"description":"If this document was originally populated from scanned data, then manually adjusted (e.g. if the scan's results weren't 100% correct or data was missing), then this will be set to true. The value cannot be set manually and any attempt to do so will just be ignored.\n","type":"boolean","readOnly":true,"example":"false","uniqueKey":"entity.identityDocs.items.[INDEX].manuallyModified","typeLabel":"boolean"},"region":{"description":"Regional variant of the ID (e.g. VIC drivers licence)\n\nYou should always use the local abbreviation for this.\nE.g.\n - VIC for The Australian state of Victoria\n - MA for the US state of Massachusetts\n - etc\n","type":"string","example":"VIC","uniqueKey":"entity.identityDocs.items.[INDEX].region","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"IdentityDocumentObject"},"uniqueKey":"entity.identityDocs.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.identityDocs","typeLabel":"object[]"},"name":{"type":"object","required":["familyName"],"properties":{"familyName":{"description":"Family name / Surname of the individual.","type":"string","example":"Smith","isRequired":true,"uniqueKey":"entity.name.familyName","typeLabel":"string"},"displayName":{"description":"In some cases, the name will need to be supplied in \"long form\", such as when it is determined from a document scan, or is un-parsable in some way.\nThe service will attempt to convert it to it's constituent parts where possible.\n","type":"string","example":"Jane Cecily Smith","uniqueKey":"entity.name.displayName","typeLabel":"string"},"givenName":{"description":"First / Given name","type":"string","example":"Jane","uniqueKey":"entity.name.givenName","typeLabel":"string"},"honourific":{"description":"Mr/Ms/Dr/Dame/Dato/etc.","type":"string","example":"Duchess","uniqueKey":"entity.name.honourific","typeLabel":"string"},"middleName":{"description":"Middle name(s) / Initials","type":"string","example":"Cecily","uniqueKey":"entity.name.middleName","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"PersonalNameObject"},"uniqueKey":"entity.name","typeLabel":"object"},"organisationData":{"description":"Organisation details for entities. Returned from an ASIC report.\n","type":"object","properties":{"adverseCreditDataPresent":{"type":"boolean","uniqueKey":"entity.organisationData.adverseCreditDataPresent","typeLabel":"boolean"},"aliases":{"type":"array","items":{"type":"string","uniqueKey":"entity.organisationData.aliases.items.[INDEX]","typeLabel":"string"},"x-omitempty":true,"uniqueKey":"entity.organisationData.aliases","typeLabel":"string[]"},"class":{"description":"A common pairing of a short code and a long description.","type":"object","properties":{"code":{"type":"string","uniqueKey":"entity.organisationData.class.code","typeLabel":"string"},"description":{"type":"string","uniqueKey":"entity.organisationData.class.description","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"CodeDescription"},"uniqueKey":"entity.organisationData.class","typeLabel":"object"},"contactDetails":{"type":"object","properties":{"email":{"type":"string","uniqueKey":"entity.organisationData.contactDetails.email","typeLabel":"string"},"faxNumber":{"type":"string","uniqueKey":"entity.organisationData.contactDetails.faxNumber","typeLabel":"string"},"telephoneNumber":{"type":"string","uniqueKey":"entity.organisationData.contactDetails.telephoneNumber","typeLabel":"string"},"websiteURL":{"type":"string","uniqueKey":"entity.organisationData.contactDetails.websiteURL","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"OrganisationDataObjectContactDetails"},"uniqueKey":"entity.organisationData.contactDetails","typeLabel":"object"},"disclosingEntityIndicator":{"type":"boolean","uniqueKey":"entity.organisationData.disclosingEntityIndicator","typeLabel":"boolean"},"extractedDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"entity.organisationData.extractedDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"entity.organisationData.extractedDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"entity.organisationData.extractedDate","typeLabel":"string\u003cdate> | null"},"includesNonBeneficiallyHeld":{"type":"boolean","uniqueKey":"entity.organisationData.includesNonBeneficiallyHeld","typeLabel":"boolean"},"industryCodes":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"entity.organisationData.industryCodes.items.[INDEX].code","typeLabel":"string"},"description":{"type":"string","uniqueKey":"entity.organisationData.industryCodes.items.[INDEX].description","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"IndustryCodesObject"},"uniqueKey":"entity.organisationData.industryCodes.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.organisationData.industryCodes","typeLabel":"object[]"},"industryDeclarations":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","uniqueKey":"entity.organisationData.industryDeclarations.items.[INDEX].description","typeLabel":"string"},"language":{"type":"string","uniqueKey":"entity.organisationData.industryDeclarations.items.[INDEX].language","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"IndustryDeclarationsObject"},"uniqueKey":"entity.organisationData.industryDeclarations.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.organisationData.industryDeclarations","typeLabel":"object[]"},"kycCustomerType":{"type":"string","uniqueKey":"entity.organisationData.kycCustomerType","typeLabel":"string"},"lastCheckDate":{"type":"string","format":"date","uniqueKey":"entity.organisationData.lastCheckDate","typeLabel":"string\u003cdate>"},"legalFormDetails":{"type":"object","properties":{"basis":{"type":"string","uniqueKey":"entity.organisationData.legalFormDetails.basis","typeLabel":"string"},"capital":{"type":"string","uniqueKey":"entity.organisationData.legalFormDetails.capital","typeLabel":"string"},"comments":{"type":"string","uniqueKey":"entity.organisationData.legalFormDetails.comments","typeLabel":"string"},"control":{"type":"string","uniqueKey":"entity.organisationData.legalFormDetails.control","typeLabel":"string"},"incorp":{"type":"string","uniqueKey":"entity.organisationData.legalFormDetails.incorp","typeLabel":"string"},"partner":{"type":"string","uniqueKey":"entity.organisationData.legalFormDetails.partner","typeLabel":"string"},"responsibility":{"type":"string","uniqueKey":"entity.organisationData.legalFormDetails.responsibility","typeLabel":"string"},"stocks":{"type":"string","uniqueKey":"entity.organisationData.legalFormDetails.stocks","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"OrganisationDataObjectLegalFormDetails"},"uniqueKey":"entity.organisationData.legalFormDetails","typeLabel":"object"},"normalisedLegalStatus":{"type":"string","uniqueKey":"entity.organisationData.normalisedLegalStatus","typeLabel":"string"},"ownershipResolved":{"type":"boolean","uniqueKey":"entity.organisationData.ownershipResolved","typeLabel":"boolean"},"registeredName":{"type":"string","uniqueKey":"entity.organisationData.registeredName","typeLabel":"string"},"registration":{"type":"object","properties":{"countryIso":{"type":"string","uniqueKey":"entity.organisationData.registration.countryIso","typeLabel":"string"},"date":{"type":"string","format":"date","uniqueKey":"entity.organisationData.registration.date","typeLabel":"string\u003cdate>"},"number":{"type":"string","uniqueKey":"entity.organisationData.registration.number","typeLabel":"string"},"previousNumber":{"type":"string","uniqueKey":"entity.organisationData.registration.previousNumber","typeLabel":"string"},"registryCode":{"type":"string","uniqueKey":"entity.organisationData.registration.registryCode","typeLabel":"string"},"registryDescription":{"type":"string","uniqueKey":"entity.organisationData.registration.registryDescription","typeLabel":"string"},"state":{"type":"string","uniqueKey":"entity.organisationData.registration.state","typeLabel":"string"},"unstructuredDate":{"type":"string","uniqueKey":"entity.organisationData.registration.unstructuredDate","typeLabel":"string"},"unstructuredFoundationDate":{"type":"string","uniqueKey":"entity.organisationData.registration.unstructuredFoundationDate","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"OrganisationDataObjectRegistration"},"uniqueKey":"entity.organisationData.registration","typeLabel":"object"},"registries":{"type":"object","properties":{"abr":{"type":"object","properties":{"abn":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.abn","typeLabel":"string"},"acn":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.acn","typeLabel":"string"},"addresses":{"type":"array","items":{"type":"object","properties":{"effectiveFrom":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.addresses.items.[INDEX].effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.addresses.items.[INDEX].effectiveTo","typeLabel":"string\u003cdate-time>"},"postcode":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.addresses.items.[INDEX].postcode","typeLabel":"string"},"stateCode":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.addresses.items.[INDEX].stateCode","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"MainBusinessPhysicalAddress"},"uniqueKey":"entity.organisationData.registries.abr.addresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entity.organisationData.registries.abr.addresses","typeLabel":"object[]"},"businessNames":{"type":"array","items":{"type":"object","properties":{"effectiveFrom":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.businessNames.items.[INDEX].effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.businessNames.items.[INDEX].effectiveTo","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.businessNames.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.businessNames.items.[INDEX].type","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"BusinessName"},"uniqueKey":"entity.organisationData.registries.abr.businessNames.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entity.organisationData.registries.abr.businessNames","typeLabel":"object[]"},"charityEndorsements":{"type":"array","items":{"type":"object","properties":{"effectiveFrom":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.charityEndorsements.items.[INDEX].effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.charityEndorsements.items.[INDEX].effectiveTo","typeLabel":"string\u003cdate-time>"},"type":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.charityEndorsements.items.[INDEX].type","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"CharityEndorsement"},"uniqueKey":"entity.organisationData.registries.abr.charityEndorsements.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entity.organisationData.registries.abr.charityEndorsements","typeLabel":"object[]"},"charityTypes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.charityTypes.items.[INDEX].description","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.charityTypes.items.[INDEX].effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.charityTypes.items.[INDEX].effectiveTo","typeLabel":"string\u003cdate-time>"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"CharityType"},"uniqueKey":"entity.organisationData.registries.abr.charityTypes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entity.organisationData.registries.abr.charityTypes","typeLabel":"object[]"},"description":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.description","typeLabel":"string"},"dgrEndorsements":{"type":"array","items":{"type":"object","properties":{"endorsedFrom":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.dgrEndorsements.items.[INDEX].endorsedFrom","typeLabel":"string\u003cdate-time>"},"endorsedTo":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.dgrEndorsements.items.[INDEX].endorsedTo","typeLabel":"string\u003cdate-time>"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"DgrEndorsement"},"uniqueKey":"entity.organisationData.registries.abr.dgrEndorsements.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entity.organisationData.registries.abr.dgrEndorsements","typeLabel":"object[]"},"gst":{"type":"array","items":{"type":"object","properties":{"effectiveFrom":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.gst.items.[INDEX].effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.gst.items.[INDEX].effectiveTo","typeLabel":"string\u003cdate-time>"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"GoodsAndServicesTax"},"uniqueKey":"entity.organisationData.registries.abr.gst.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entity.organisationData.registries.abr.gst","typeLabel":"object[]"},"historicalChanges":{"type":"array","items":{"type":"object","properties":{"businessName":{"type":"array","items":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].businessName.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].businessName","typeLabel":"string[]"},"date":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].date","typeLabel":"string\u003cdate-time>"},"entityStatus":{"type":"array","items":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].entityStatus.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].entityStatus","typeLabel":"string[]"},"goodsAndServicesTax":{"type":"array","items":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].goodsAndServicesTax.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].goodsAndServicesTax","typeLabel":"string[]"},"mainBusinessPhysicalAddress":{"type":"array","items":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].mainBusinessPhysicalAddress.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].mainBusinessPhysicalAddress","typeLabel":"string[]"},"mainName":{"type":"array","items":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].mainName.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].mainName","typeLabel":"string[]"},"mainTradingName":{"type":"array","items":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].mainTradingName.items.[INDEX]","typeLabel":"string"},"uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX].mainTradingName","typeLabel":"string[]"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"HistoricalChange"},"uniqueKey":"entity.organisationData.registries.abr.historicalChanges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entity.organisationData.registries.abr.historicalChanges","typeLabel":"object[]"},"lastUpdated":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.lastUpdated","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.name","typeLabel":"string"},"registeredDate":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.registeredDate","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.status","typeLabel":"string"},"statusEffectiveFrom":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.statusEffectiveFrom","typeLabel":"string"},"type":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.type","typeLabel":"string"},"typeCode":{"type":"string","uniqueKey":"entity.organisationData.registries.abr.typeCode","typeLabel":"string"},"updatedDate":{"type":"string","format":"date-time","uniqueKey":"entity.organisationData.registries.abr.updatedDate","typeLabel":"string\u003cdate-time>"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"Abr"},"uniqueKey":"entity.organisationData.registries.abr","typeLabel":"object"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"Registries"},"uniqueKey":"entity.organisationData.registries","typeLabel":"object"},"reviewDate":{"oneOf":[{"type":"string","format":"date","uniqueKey":"entity.organisationData.reviewDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"entity.organisationData.reviewDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"entity.organisationData.reviewDate","typeLabel":"string\u003cdate> | null"},"shareStructure":{"type":"array","items":{"description":"Describes a collection of shares of a particular type and their attributes,\nOne or more ShareStructures make up a company's shares that are then parcelled out as shareholdings.\n","type":"object","properties":{"amountDue":{"type":"number","uniqueKey":"entity.organisationData.shareStructure.items.[INDEX].amountDue","typeLabel":"number"},"amountPaid":{"type":"number","uniqueKey":"entity.organisationData.shareStructure.items.[INDEX].amountPaid","typeLabel":"number"},"classCode":{"type":"string","uniqueKey":"entity.organisationData.shareStructure.items.[INDEX].classCode","typeLabel":"string"},"classTitle":{"type":"string","uniqueKey":"entity.organisationData.shareStructure.items.[INDEX].classTitle","typeLabel":"string"},"docNumber":{"type":"string","uniqueKey":"entity.organisationData.shareStructure.items.[INDEX].docNumber","typeLabel":"string"},"docNumberQualifier":{"type":"string","uniqueKey":"entity.organisationData.shareStructure.items.[INDEX].docNumberQualifier","typeLabel":"string"},"sharesIssued":{"type":"integer","uniqueKey":"entity.organisationData.shareStructure.items.[INDEX].sharesIssued","typeLabel":"integer"},"status":{"type":"string","uniqueKey":"entity.organisationData.shareStructure.items.[INDEX].status","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ShareStructureObject"},"uniqueKey":"entity.organisationData.shareStructure.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"entity.organisationData.shareStructure","typeLabel":"object[]"},"startDate":{"type":"string","format":"date","uniqueKey":"entity.organisationData.startDate","typeLabel":"string\u003cdate>"},"status":{"description":"A common pairing of a short code and a long description.","type":"object","properties":{"code":{"type":"string","uniqueKey":"entity.organisationData.status.code","typeLabel":"string"},"description":{"type":"string","uniqueKey":"entity.organisationData.status.description","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"CodeDescription"},"uniqueKey":"entity.organisationData.status","typeLabel":"object"},"subType":{"description":"A common pairing of a short code and a long description.","type":"object","properties":{"code":{"type":"string","uniqueKey":"entity.organisationData.subType.code","typeLabel":"string"},"description":{"type":"string","uniqueKey":"entity.organisationData.subType.description","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"CodeDescription"},"uniqueKey":"entity.organisationData.subType","typeLabel":"object"},"subclass":{"description":"A common pairing of a short code and a long description.","type":"object","properties":{"code":{"type":"string","uniqueKey":"entity.organisationData.subclass.code","typeLabel":"string"},"description":{"type":"string","uniqueKey":"entity.organisationData.subclass.description","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"CodeDescription"},"uniqueKey":"entity.organisationData.subclass","typeLabel":"object"},"type":{"description":"A common pairing of a short code and a long description.","type":"object","properties":{"code":{"type":"string","uniqueKey":"entity.organisationData.type.code","typeLabel":"string"},"description":{"type":"string","uniqueKey":"entity.organisationData.type.description","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"CodeDescription"},"uniqueKey":"entity.organisationData.type","typeLabel":"object"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"OrganisationDataObject"},"uniqueKey":"entity.organisationData","typeLabel":"object"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EntityObject"},"isRequired":true,"uniqueKey":"entity","typeLabel":"object"},"requestId":{"description":"Unique identifier for every request. Can be used for tracking down answers with technical support. \n\nUses the ULID format (a time-based, sortable UUID)\n\nNote: this will be different for every request.\n","type":"string","format":"ulid","x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"RequestIDObject"},"example":"01BFJA617JMJXEW6G7TDDXNSHX","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003culid>"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"EntityResultObject"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"entity":{"addresses":[{"country":"AUS","addressId":"86932629-bdb4-158f-e670-741e89ff78ba","addressType":"REGISTERED_OFFICE","buildingName":"Highland Tower","careOf":"\u003cstring>","endDate":"0001-01-01","extraData":[{"kvpKey":"ACN","kvpType":"id.external","kvpValue":"406655338"}],"longForm":"42a Test Eagle Road, Testville, TST 123-TST, Testalia","postalCode":"3000","region":"MELBOURNE","startDate":"2023-03-10","state":"VIC","streetName":"9 ROYCE AVENUE","streetNumber":"FLAT 27","streetType":"Road","suburb":"Testburb","town":"MELBOURNE","unitNumber":"FLAT 27","unstructuredLongForm":"\u003cstring>"}],"dateOfBirth":{"country":"AUS","dateOfBirth":"1978-11-12","locality":"Brisbane","unstructuredDateOfBirth":"\u003cstring>","yearOfBirth":"1978"},"entityId":"84a9a860-68ae-4d7d-9a53-54a1116d5051","entityProfile":"\u003cstring>","entityType":"ORGANISATION","extraData":[{"kvpKey":"ACN","kvpType":"id.external","kvpValue":"406655338"}],"flags":[{"flag":"\u003cstring>","value":123}],"gender":"F","identityDocs":[{"country":"AUS","idType":"DRIVERS_LICENCE","createdFromScan":true,"docScan":[{"ScanDelete":true,"scanCreated":"2020-06-02","scanData":"VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==","scanDataRetrievalState":"NORMAL","scanDocId":"84a9a860-68ae-4d7d-9a53-54a1116d5051","scanFilename":"Important Document - ID1234567.pdf","scanMIME":"image/png","scanPageNum":1,"scanSide":"F","scanType":"PDF"}],"documentId":"84a9a860-68ae-4d7d-9a53-54a1116d5051","documentStatus":"DOC_SCANNED","extraData":[{"kvpKey":"ACN","kvpType":"id.external","kvpValue":"406655338"}],"idExpiry":"2020-02-01","idIssued":"1972-11-04","idNumber":"123456789","idSubType":"\u003cstring>","manuallyModified":"false","region":"VIC"}],"name":{"familyName":"Smith","displayName":"Jane Cecily Smith","givenName":"Jane","honourific":"Duchess","middleName":"Cecily"},"organisationData":{"adverseCreditDataPresent":true,"aliases":["\u003cstring>"],"class":{"code":"\u003cstring>","description":"\u003cstring>"},"contactDetails":{"email":"\u003cstring>","faxNumber":"\u003cstring>","telephoneNumber":"\u003cstring>","websiteURL":"\u003cstring>"},"disclosingEntityIndicator":true,"extractedDate":"2023-12-25","includesNonBeneficiallyHeld":true,"industryCodes":[{"code":"\u003cstring>","description":"\u003cstring>"}],"industryDeclarations":[{"description":"\u003cstring>","language":"\u003cstring>"}],"kycCustomerType":"\u003cstring>","lastCheckDate":"2023-12-25","legalFormDetails":{"basis":"\u003cstring>","capital":"\u003cstring>","comments":"\u003cstring>","control":"\u003cstring>","incorp":"\u003cstring>","partner":"\u003cstring>","responsibility":"\u003cstring>","stocks":"\u003cstring>"},"normalisedLegalStatus":"\u003cstring>","ownershipResolved":true,"registeredName":"\u003cstring>","registration":{"countryIso":"\u003cstring>","date":"2023-12-25","number":"\u003cstring>","previousNumber":"\u003cstring>","registryCode":"\u003cstring>","registryDescription":"\u003cstring>","state":"\u003cstring>","unstructuredDate":"\u003cstring>","unstructuredFoundationDate":"\u003cstring>"},"registries":{"abr":{"abn":"\u003cstring>","acn":"\u003cstring>","addresses":[{"effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","postcode":"\u003cstring>","stateCode":"\u003cstring>"}],"businessNames":[{"effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","name":"\u003cstring>","type":"\u003cstring>"}],"charityEndorsements":[{"effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","type":"\u003cstring>"}],"charityTypes":[{"description":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z"}],"description":"\u003cstring>","dgrEndorsements":[{"endorsedFrom":"2023-11-07T05:31:56Z","endorsedTo":"2023-11-07T05:31:56Z"}],"gst":[{"effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z"}],"historicalChanges":[{"businessName":["\u003cstring>"],"date":"2023-11-07T05:31:56Z","entityStatus":["\u003cstring>"],"goodsAndServicesTax":["\u003cstring>"],"mainBusinessPhysicalAddress":["\u003cstring>"],"mainName":["\u003cstring>"],"mainTradingName":["\u003cstring>"]}],"lastUpdated":"2023-11-07T05:31:56Z","name":"\u003cstring>","registeredDate":"2023-11-07T05:31:56Z","status":"\u003cstring>","statusEffectiveFrom":"\u003cstring>","type":"\u003cstring>","typeCode":"\u003cstring>","updatedDate":"2023-11-07T05:31:56Z"}},"reviewDate":"2023-12-25","shareStructure":[{"amountDue":123,"amountPaid":123,"classCode":"\u003cstring>","classTitle":"\u003cstring>","docNumber":"\u003cstring>","docNumberQualifier":"\u003cstring>","sharesIssued":123,"status":"\u003cstring>"}],"startDate":"2023-12-25","status":{"code":"\u003cstring>","description":"\u003cstring>"},"subType":{"code":"\u003cstring>","description":"\u003cstring>"},"subclass":{"code":"\u003cstring>","description":"\u003cstring>"},"type":{"code":"\u003cstring>","description":"\u003cstring>"}}},"requestId":"01BFJA617JMJXEW6G7TDDXNSHX"}}},"exampleType":"generated"}},"exampleType":"generated"},"d266864c-f2b8-4f3e-9a9a-bb3d46842f08":{"description":"Bad request. One or more request fields is either missing or incorrect. Details are in the error response.","content":{"application/json":{"schema":{"type":"object","required":["requestId","errorCode","errorMsg"],"properties":{"errorCode":{"description":"Frankie error code","type":"string","example":"CORE-5990","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"description":"Will describe the error","type":"string","example":"Everything went kaflooey. Stay clam.","isRequired":true,"uniqueKey":"errorMsg","typeLabel":"string"},"requestId":{"description":"Unique identifier for every request. Can be used for tracking down answers with technical support. \n\nUses the ULID format (a time-based, sortable UUID)\n\nNote: this will be different for every request.\n","type":"string","format":"ulid","x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"RequestIDObject"},"example":"01BFJA617JMJXEW6G7TDDXNSHX","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003culid>"},"commit":{"description":"Server version indication","type":"string","example":"2af478ed","uniqueKey":"commit","typeLabel":"string"},"httpStatusCode":{"description":"Deprecated:\nHTTP status code. Same as that which is passed back in the header.\n","type":"integer","example":501,"uniqueKey":"httpStatusCode","typeLabel":"integer"},"issues":{"type":"array","items":{"type":"object","required":["issueLocation"],"properties":{"issueLocation":{"description":"Will describe the field or data location of the issue","type":"string","example":"dateOfBirth","isRequired":true,"uniqueKey":"issues.items.[INDEX].issueLocation","typeLabel":"string"},"issue":{"description":"Description of the problem","type":"string","example":"Invalid format. Must be YYYY-MM-DD","uniqueKey":"issues.items.[INDEX].issue","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObjectIssues"},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"issues","typeLabel":"object[]"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObject"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"CORE-5990","errorMsg":"Everything went kaflooey. Stay clam.","requestId":"01BFJA617JMJXEW6G7TDDXNSHX","commit":"2af478ed","httpStatusCode":501,"issues":[{"issueLocation":"dateOfBirth","issue":"Invalid format. Must be YYYY-MM-DD"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"283f3a1b-8a2a-4bf8-b593-f75d058df6e7":{"description":"The request has failed an authorisation check. This can happen for a variety of reasons, such as an invalid or expired API key, or invalid Customer/CustomerChildIDs. \n* NOTE: This does not include attempts to read/write data you don't have access to - that's a 404 error (as we don't want to leak information through guessing)\n","content":{"application/json":{"schema":{"type":"object","required":["requestId","errorCode","errorMsg"],"properties":{"errorCode":{"description":"Frankie error code","type":"string","example":"CORE-5990","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"description":"Will describe the error","type":"string","example":"Everything went kaflooey. Stay clam.","isRequired":true,"uniqueKey":"errorMsg","typeLabel":"string"},"requestId":{"description":"Unique identifier for every request. Can be used for tracking down answers with technical support. \n\nUses the ULID format (a time-based, sortable UUID)\n\nNote: this will be different for every request.\n","type":"string","format":"ulid","x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"RequestIDObject"},"example":"01BFJA617JMJXEW6G7TDDXNSHX","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003culid>"},"commit":{"description":"Server version indication","type":"string","example":"2af478ed","uniqueKey":"commit","typeLabel":"string"},"httpStatusCode":{"description":"Deprecated:\nHTTP status code. Same as that which is passed back in the header.\n","type":"integer","example":501,"uniqueKey":"httpStatusCode","typeLabel":"integer"},"issues":{"type":"array","items":{"type":"object","required":["issueLocation"],"properties":{"issueLocation":{"description":"Will describe the field or data location of the issue","type":"string","example":"dateOfBirth","isRequired":true,"uniqueKey":"issues.items.[INDEX].issueLocation","typeLabel":"string"},"issue":{"description":"Description of the problem","type":"string","example":"Invalid format. Must be YYYY-MM-DD","uniqueKey":"issues.items.[INDEX].issue","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObjectIssues"},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"issues","typeLabel":"object[]"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObject"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"CORE-5990","errorMsg":"Everything went kaflooey. Stay clam.","requestId":"01BFJA617JMJXEW6G7TDDXNSHX","commit":"2af478ed","httpStatusCode":501,"issues":[{"issueLocation":"dateOfBirth","issue":"Invalid format. Must be YYYY-MM-DD"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"385a338b-8d52-426d-b3df-0ec324721ef6":{"description":"Cannot return response. In the case of a query, or reference to a specific entity/check/etc, it means that the requested item was not found, or you don't have access to it. Please check your query before trying again.","content":{"application/json":{"schema":{"type":"object","required":["requestId","errorCode","errorMsg"],"properties":{"errorCode":{"description":"Frankie error code","type":"string","example":"CORE-5990","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"description":"Will describe the error","type":"string","example":"Everything went kaflooey. Stay clam.","isRequired":true,"uniqueKey":"errorMsg","typeLabel":"string"},"requestId":{"description":"Unique identifier for every request. Can be used for tracking down answers with technical support. \n\nUses the ULID format (a time-based, sortable UUID)\n\nNote: this will be different for every request.\n","type":"string","format":"ulid","x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"RequestIDObject"},"example":"01BFJA617JMJXEW6G7TDDXNSHX","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003culid>"},"commit":{"description":"Server version indication","type":"string","example":"2af478ed","uniqueKey":"commit","typeLabel":"string"},"httpStatusCode":{"description":"Deprecated:\nHTTP status code. Same as that which is passed back in the header.\n","type":"integer","example":501,"uniqueKey":"httpStatusCode","typeLabel":"integer"},"issues":{"type":"array","items":{"type":"object","required":["issueLocation"],"properties":{"issueLocation":{"description":"Will describe the field or data location of the issue","type":"string","example":"dateOfBirth","isRequired":true,"uniqueKey":"issues.items.[INDEX].issueLocation","typeLabel":"string"},"issue":{"description":"Description of the problem","type":"string","example":"Invalid format. Must be YYYY-MM-DD","uniqueKey":"issues.items.[INDEX].issue","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObjectIssues"},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"issues","typeLabel":"object[]"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObject"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"CORE-5990","errorMsg":"Everything went kaflooey. Stay clam.","requestId":"01BFJA617JMJXEW6G7TDDXNSHX","commit":"2af478ed","httpStatusCode":501,"issues":[{"issueLocation":"dateOfBirth","issue":"Invalid format. Must be YYYY-MM-DD"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"04f3f576-e701-4bdd-84a7-b5db60c4b225":{"description":"The API client is making too many concurrent requests, and some are being throttled. Throttled requests can be retried after a short delay.","content":{"application/json":{"schema":{"type":"object","required":["requestId","errorCode","errorMsg"],"properties":{"errorCode":{"description":"Frankie error code","type":"string","example":"CORE-5990","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"description":"Will describe the error","type":"string","example":"Everything went kaflooey. Stay clam.","isRequired":true,"uniqueKey":"errorMsg","typeLabel":"string"},"requestId":{"description":"Unique identifier for every request. Can be used for tracking down answers with technical support. \n\nUses the ULID format (a time-based, sortable UUID)\n\nNote: this will be different for every request.\n","type":"string","format":"ulid","x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"RequestIDObject"},"example":"01BFJA617JMJXEW6G7TDDXNSHX","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003culid>"},"commit":{"description":"Server version indication","type":"string","example":"2af478ed","uniqueKey":"commit","typeLabel":"string"},"httpStatusCode":{"description":"Deprecated:\nHTTP status code. Same as that which is passed back in the header.\n","type":"integer","example":501,"uniqueKey":"httpStatusCode","typeLabel":"integer"},"issues":{"type":"array","items":{"type":"object","required":["issueLocation"],"properties":{"issueLocation":{"description":"Will describe the field or data location of the issue","type":"string","example":"dateOfBirth","isRequired":true,"uniqueKey":"issues.items.[INDEX].issueLocation","typeLabel":"string"},"issue":{"description":"Description of the problem","type":"string","example":"Invalid format. Must be YYYY-MM-DD","uniqueKey":"issues.items.[INDEX].issue","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObjectIssues"},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"issues","typeLabel":"object[]"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObject"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"CORE-5990","errorMsg":"Everything went kaflooey. Stay clam.","requestId":"01BFJA617JMJXEW6G7TDDXNSHX","commit":"2af478ed","httpStatusCode":501,"issues":[{"issueLocation":"dateOfBirth","issue":"Invalid format. Must be YYYY-MM-DD"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"04902ae0-8cdc-453e-9e6c-77b5369ebefe":{"description":"Unexpected error. Something went wrong during the checking process.","content":{"application/json":{"schema":{"type":"object","required":["requestId","errorCode","errorMsg"],"properties":{"errorCode":{"description":"Frankie error code","type":"string","example":"CORE-5990","isRequired":true,"uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"description":"Will describe the error","type":"string","example":"Everything went kaflooey. Stay clam.","isRequired":true,"uniqueKey":"errorMsg","typeLabel":"string"},"requestId":{"description":"Unique identifier for every request. Can be used for tracking down answers with technical support. \n\nUses the ULID format (a time-based, sortable UUID)\n\nNote: this will be different for every request.\n","type":"string","format":"ulid","x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"RequestIDObject"},"example":"01BFJA617JMJXEW6G7TDDXNSHX","isRequired":true,"uniqueKey":"requestId","typeLabel":"string\u003culid>"},"commit":{"description":"Server version indication","type":"string","example":"2af478ed","uniqueKey":"commit","typeLabel":"string"},"httpStatusCode":{"description":"Deprecated:\nHTTP status code. Same as that which is passed back in the header.\n","type":"integer","example":501,"uniqueKey":"httpStatusCode","typeLabel":"integer"},"issues":{"type":"array","items":{"type":"object","required":["issueLocation"],"properties":{"issueLocation":{"description":"Will describe the field or data location of the issue","type":"string","example":"dateOfBirth","isRequired":true,"uniqueKey":"issues.items.[INDEX].issueLocation","typeLabel":"string"},"issue":{"description":"Description of the problem","type":"string","example":"Invalid format. Must be YYYY-MM-DD","uniqueKey":"issues.items.[INDEX].issue","typeLabel":"string"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObjectIssues"},"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"x-omitempty":true,"uniqueKey":"issues","typeLabel":"object[]"}},"x-go-type":{"import":{"alias":"models_common","package":"bitbucket.org/ff_common/models/common"},"type":"ErrorObject"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"CORE-5990","errorMsg":"Everything went kaflooey. Stay clam.","requestId":"01BFJA617JMJXEW6G7TDDXNSHX","commit":"2af478ed","httpStatusCode":501,"issues":[{"issueLocation":"dateOfBirth","issue":"Invalid format. Must be YYYY-MM-DD"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ab662a77-eed9-4cc3-809e-fc809d0f7a47":{"api_key":{"description":"API key issued by Frankie Financial. This will rotate regularly.","type":"apiKey","name":"api_key","in":"header","scopes":[]}}},"servers":{"f99f7d52-aee6-4307-b2ff-d95bafe383b8":{"url":"https://api.uat.frankie.one/compliance/v1.2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"API key issued by Frankie Financial. This will rotate regularly.","type":"apiKey","name":"api_key","in":"header","scopes":[]},"schema":{"title":"api_key","type":"string","description":"API key issued by Frankie Financial. This will rotate regularly.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"api_key"}],"title":"api_key"}]},"originalFileLocation":"specs/Frankie-FinancialAPI.json"},"subdomain":"frankieone-f5583b1b","siteName":"frankieone","title":"Set Entity Ongoing AML Monitoring Status. - frankieone","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/introduction/overview","matchLevel":4},"v1":{"href":"/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T06:14:50.805Z","originalFileLocation":"docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"system\";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=\"Mark the entity as being monitored or not with the \u0026#x27;?set=\u0026#x27; query parameter as \u0026#x27;true\u0026#x27; or \u0026#x27;false\u0026#x27;. Setting this parameter to \u0026#x27;true\u0026#x27; will disable ongoing monitoring. Setting this parameter to \u0026#x27;false\u0026#x27; will enable ongoing monitoring.\">\u003cmeta data-mint-head name=\"application-name\" content=\"frankieone\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Set Entity Ongoing AML Monitoring Status. - frankieone\">\u003cmeta data-mint-head property=\"og:description\" content=\"Mark the entity as being monitored or not with the \u0026#x27;?set=\u0026#x27; query parameter as \u0026#x27;true\u0026#x27; or \u0026#x27;false\u0026#x27;. Setting this parameter to \u0026#x27;true\u0026#x27; will disable ongoing monitoring. Setting this parameter to \u0026#x27;false\u0026#x27; will enable ongoing monitoring.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"frankieone\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://frankieone-f5583b1b.mintlify.app/_mintlify/api/og/v2?division=Flag\u0026amp;title=Set+Entity+Ongoing+AML+Monitoring+Status.\u0026amp;description=Mark+the+entity+as+being+monitored+or+not+with+the+%27%3Fset%3D%27+query+parameter+as+%27true%27+or+%27false%27.%0ASetting+this+parameter+to+%27true%27+will+disable+ongoing+monitorin\u0026amp;theme=c47e43939fad196e0932957d\u0026amp;signature=6c2ea21c1ac08feb1fd08709f184ae2a0f8655cc1f5aedf8d0a3f372590fbceb\">\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=\"Set Entity Ongoing AML Monitoring Status. - frankieone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Mark the entity as being monitored or not with the \u0026#x27;?set=\u0026#x27; query parameter as \u0026#x27;true\u0026#x27; or \u0026#x27;false\u0026#x27;. Setting this parameter to \u0026#x27;true\u0026#x27; will disable ongoing monitoring. Setting this parameter to \u0026#x27;false\u0026#x27; will enable ongoing monitoring.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://frankieone-f5583b1b.mintlify.app/_mintlify/api/og/v2?division=Flag\u0026amp;title=Set+Entity+Ongoing+AML+Monitoring+Status.\u0026amp;description=Mark+the+entity+as+being+monitored+or+not+with+the+%27%3Fset%3D%27+query+parameter+as+%27true%27+or+%27false%27.%0ASetting+this+parameter+to+%27true%27+will+disable+ongoing+monitorin\u0026amp;theme=c47e43939fad196e0932957d\u0026amp;signature=6c2ea21c1ac08feb1fd08709f184ae2a0f8655cc1f5aedf8d0a3f372590fbceb\">\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/frankieone-f5583b1b/_v96DLwTWBa7bG-i/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"frankieone\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A6CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.frankieone.com/#organization\",\"name\":\"frankieone\",\"url\":\"https://docs.frankieone.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/light.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=21923909c20fa1b38b317371ccac6e33\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.frankieone.com#website\",\"name\":\"frankieone\",\"url\":\"https://docs.frankieone.com\",\"publisher\":{\"@id\":\"https://docs.frankieone.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring#webpage\",\"url\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring\",\"name\":\"Set Entity Ongoing AML Monitoring Status.\",\"description\":\"Mark the entity as being monitored or not with the '?set=' query parameter as 'true' or 'false'. Setting this parameter to 'true' will disable ongoing monitoring. Setting this parameter to 'false' will enable ongoing monitoring.\",\"dateModified\":\"2026-01-27T06:14:50.805Z\",\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"KYC API Endpoints\",\"item\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/status/status-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Flag\",\"item\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/blacklist-entity\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Set Entity Ongoing AML Monitoring Status.\",\"item\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring#apireference\",\"headline\":\"Set Entity Ongoing AML Monitoring Status.\",\"name\":\"Set Entity Ongoing AML Monitoring Status.\",\"description\":\"Mark the entity as being monitored or not with the '?set=' query parameter as 'true' or 'false'. Setting this parameter to 'true' will disable ongoing monitoring. Setting this parameter to 'false' will enable ongoing monitoring.\",\"url\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring\",\"mainEntityOfPage\":{\"@id\":\"https://docs.frankieone.com/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring#webpage\"},\"dateModified\":\"2026-01-27T06:14:50.805Z\",\"publisher\":{\"@id\":\"https://docs.frankieone.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"frankieone\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"frankieone","nav":{"global":{"anchors":[{"anchor":"Service Status","icon":"signal","href":"https://status.frankieone.com"},{"anchor":"Blog","icon":"newspaper","href":"https://frankieone.com/frankieone-blog"}]},"versions":[{"version":"v2","pages":[{"title":"v2","href":"/v2/introduction/overview"}]},{"version":"v1","tabs":[{"tab":"Introduction","icon":"book","pages":[{"title":"Introduction","href":"/docs/v1/introduction/getting-started/welcome-to-frankie"}]},{"tab":"OneSDK","icon":"display-code","pages":[{"title":"OneSDK","href":"/docs/v1/onesdk/oneSDK/about-onesdk"}]},{"tab":"KYC","icon":"user-group","pages":[{"title":"KYC","href":"/docs/v1/kyc/kyc-info/overview"}]},{"tab":"KYB","icon":"briefcase","pages":[{"title":"KYB","href":"/docs/v1/kyb/overview"}]},{"tab":"Portal","icon":"credit-card","pages":[{"title":"Portal","href":"/docs/v1/portal/getting-started/overview"}]},{"tab":"Fraud","icon":"shield-halved","pages":[{"title":"Fraud","href":"/docs/v1/fraud-activity-monitoring/fraud-overview"}]},{"tab":"API","icon":"terminal","groups":[{"group":"Guide to the API","pages":[{"title":"Introduction to the API","sidebarTitle":"Introduction","icon":"book","href":"/docs/v1/api/guide-to-the-api/introduction-to-the-api"},{"group":"Getting Started","icon":"rocket","pages":[{"title":"Authentication","sidebarTitle":"","icon":"key","href":"/docs/v1/api/guide-to-the-api/getting-started/reference/authentication"},{"title":"Errors","sidebarTitle":"","icon":"triangle-exclamation","href":"/docs/v1/api/guide-to-the-api/getting-started/reference/errors"},{"title":"Asynchronous Calls (Background Processes)","sidebarTitle":"","icon":"clock","href":"/docs/v1/api/guide-to-the-api/getting-started/asynchronous-calls-backgrounding-processes"},{"title":"Entity Profiles Available","sidebarTitle":"Available Entity Profiles","icon":"id-card","href":"/docs/v1/api/guide-to-the-api/getting-started/entity-profiles-available-to-test-with"},{"title":"Entity extraData Key Value Pairs","sidebarTitle":"Customer Reference Numbers \u0026 Entity KVPs","icon":"hashtag","href":"/docs/v1/api/guide-to-the-api/getting-started/entity-extradata-key-value-pairs"},{"title":"Reseller Checks with Experian AU","sidebarTitle":"Reseller Checks (Experian AU)","icon":"building-columns","href":"/docs/v1/api/guide-to-the-api/getting-started/experian-reseller-abn"},{"title":"Notifications \u0026 Webhooks","sidebarTitle":"Notifications - Webhooks","icon":"bell","href":"/docs/v1/api/guide-to-the-api/getting-started/notifications-webhooks"},{"title":"Set Entity Ongoing AML Monitoring Status","sidebarTitle":"","icon":"shield","href":"/docs/v1/api/guide-to-the-api/getting-started/set-entity-ongoing-aml-monitoring-status"},{"title":"Data Source Codes","sidebarTitle":"","icon":"database","href":"/docs/v1/api/guide-to-the-api/getting-started/reference/datasource-codes"},{"title":"Download Test Data","sidebarTitle":"","icon":"download","href":"/docs/v1/api/guide-to-the-api/getting-started/test-data"}]},{"group":"Common API Objects \u0026 Fields","icon":"cube","pages":[{"title":"Common API Objects and Fields","sidebarTitle":"Overview","icon":"cube","href":"/docs/v1/api/guide-to-the-api/common-api-objects-and-fields"},{"title":"Object IDs","sidebarTitle":"","icon":"fingerprint","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/common-api-fields-types"},{"title":"The Document Object","sidebarTitle":"","icon":"file","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/fundamentals-document-object"},{"title":"The Entity Object","sidebarTitle":"","icon":"user","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/fundamentals-entity-object"},{"title":"Key Value Pairs","sidebarTitle":"","icon":"key","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/key-value-pairs"},{"title":"RequestID","sidebarTitle":"","icon":"id-badge","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/requestid"}]},{"group":"Data Types","icon":"table","pages":[{"title":"Working with Names","sidebarTitle":"Names","icon":"signature","href":"/docs/v1/api/guide-to-the-api/data-types/names-with-different-character-sets"},{"title":"Working With Addresses","sidebarTitle":"Addresses","icon":"location-dot","href":"/docs/v1/api/guide-to-the-api/data-types/working-with-addresses"},{"title":"Working With Country Codes","sidebarTitle":"Country Codes","icon":"globe","href":"/docs/v1/api/guide-to-the-api/data-types/working-with-country-codes"},{"title":"Working With Support Docs","sidebarTitle":"Support Docs","icon":"file-lines","href":"/docs/v1/api/guide-to-the-api/data-types/working-with-support-docs"},{"title":"Adding an Email Address","sidebarTitle":"","icon":"envelope","href":"/docs/v1/api/guide-to-the-api/data-types/adding-an-email-address"},{"title":"Adding a Mobile Phone Number","sidebarTitle":"","icon":"mobile","href":"/docs/v1/api/guide-to-the-api/data-types/adding-a-mobile-phone-number"}]},{"group":"Country Specific ID Document Requirements","icon":"id-card","pages":[{"title":"Requirements \u0026 Additional Fields for ID Documents","sidebarTitle":"Overview","icon":"id-card","href":"/docs/v1/api/guide-to-the-api/requirements-additional-fields-for-id-documents"},{"title":"Australian ID Documents","sidebarTitle":"Australia","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/aus-drivers-licence"},{"title":"New Zealand ID Documents","sidebarTitle":"New Zealand","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/nzl-drivers-licence"},{"title":"Chinese ID Documents","sidebarTitle":"China","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/chn-national-id"},{"title":"Mexican ID Documents","sidebarTitle":"Mexico","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/mex-national-id"},{"title":"Thai ID Documents","sidebarTitle":"Thailand","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/tha-national-id"},{"title":"India","sidebarTitle":"","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/ind-passport"},{"title":"Philippines","sidebarTitle":"","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/phi-passport"},{"title":"United States Documents","sidebarTitle":"USA","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/country-specific-documents-usa-v1"},{"title":"International","sidebarTitle":"","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/international-national-id"}]},{"title":"OCR Extraction Document API","sidebarTitle":"","icon":"file-lines","href":"/docs/v1/api/guide-to-the-api/ocr-extraction-document-api"},{"group":"Using the Sandbox","icon":"box","pages":[{"title":"Working with the Sandbox","sidebarTitle":"Overview","icon":"box","href":"/docs/v1/api/guide-to-the-api/working-with-the-sandbox"},{"title":"Using the Sandbox Data and API","sidebarTitle":"Sandbox Data \u0026 API","icon":"code","href":"/docs/v1/api/guide-to-the-api/using-the-sandbox/using-the-sandbox-data-and-api"},{"title":"Testing Error Scenarios","sidebarTitle":"Forcing Test Scenario Errors","icon":"bug","href":"/docs/v1/api/guide-to-the-api/using-the-sandbox/forcing-errors-in-test-scenarios"},{"title":"Typical Test Scenarios","sidebarTitle":"","icon":"vial","href":"/docs/v1/api/guide-to-the-api/using-the-sandbox/typical-test-scenarios"}]}]},{"group":"KYC API Endpoints","pages":[{"group":"status","pages":[{"title":"Service Status","openapi":"get /ruok","href":"/docs/v1/api/kyc-api-endpoints/reference/status/status-check"}]},{"group":"Document","pages":[{"title":"Create New Document.","openapi":"post /document","href":"/docs/v1/api/kyc-api-endpoints/reference/document/create-document"},{"title":"Create and Verify Document.","openapi":"POST /document/new/verify","href":"/docs/v1/api/kyc-api-endpoints/reference/document/verify-document"},{"title":"Search For a Document","openapi":"POST /document/search","href":"/docs/v1/api/kyc-api-endpoints/reference/document/search-document"},{"title":"Retrieve Document Details","openapi":"GET /document/{documentId}","href":"/docs/v1/api/kyc-api-endpoints/reference/document/query-document"},{"title":"Update Existing Document.","openapi":"POST /document/{documentId}","href":"/docs/v1/api/kyc-api-endpoints/reference/document/update-document"},{"title":"Delete Document.","openapi":"DELETE /document/{documentId}","href":"/docs/v1/api/kyc-api-endpoints/reference/document/delete-document"},{"title":"Retrieve Document Verification Check Details.","openapi":"GET /document/{documentId}/checks","href":"/docs/v1/api/kyc-api-endpoints/reference/document/query-document-checks"},{"title":"Retrieve Document and Scan Data","openapi":"GET /document/{documentId}/full","href":"/docs/v1/api/kyc-api-endpoints/reference/document/query-document-full"},{"title":"Update and Verify Document.","openapi":"POST /document/{documentId}/verify","href":"/docs/v1/api/kyc-api-endpoints/reference/document/update-verify-document"}]},{"group":"Entity","pages":[{"title":"Create New Entity.","openapi":"POST /entity","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-entity"},{"title":"Create Entity and Get IDV Token","openapi":"POST /entity/new/idvalidate/getToken","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-entity-get-idv-token"},{"title":"Create Entity and Push Self-Verification Link","openapi":"POST /entity/new/verify/pushToMobile","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-check-entity-push-to-mobile"},{"title":"Create and Verify Entity","openapi":"POST /entity/new/verify/{checkType}/{resultLevel}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-check-entity"},{"title":"Search for Entity","openapi":"POST /entity/search","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/search-entity"},{"title":"Retrieve Entity Details","openapi":"GET /entity/{entityId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/query-entity"},{"title":"Update Existing Entity","openapi":"POST /entity/{entityId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity"},{"title":"Delete Entity","openapi":"DELETE /entity/{entityId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/delete-entity"},{"title":"Update Check Result States (Batch)","openapi":"POST /entity/{entityId}/check/{checkId}/{checkClass}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-class-results"},{"title":"Update Check Result State","openapi":"POST /entity/{entityId}/check/{checkId}/{checkClass}/{checkClassId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-class-result"},{"title":"Retrieve Entity Verification Check Details","openapi":"GET /entity/{entityId}/checks","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/query-entity-checks"},{"title":"Update Entity and evaluate current results and risk without running any new checks","openapi":"POST /entity/{entityId}/evaluate","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-evaluate-entity"},{"title":"Retrieve Entity Details and Document Scan Data","openapi":"GET /entity/{entityId}/full","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/query-entity-full"},{"title":"Update Entity and Get IDV Token","openapi":"POST /entity/{entityId}/idvalidate/getToken","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity-get-idv-token"},{"title":"Update Entity and Initiate IDV Process","openapi":"POST /entity/{entityId}/idvalidate/initProcess","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity-init-idv-process"},{"title":"Generate Individual Verification Report","openapi":"POST /entity/{entityId}/report","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/entity-kyc-report"},{"title":"Update Entity States","openapi":"POST /entity/{entityId}/status","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity-state"},{"title":"Update Entity and Push Self-Verification Link","openapi":"POST /entity/{entityId}/verify/pushToMobile","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-entity-push-to-mobile"},{"title":"Update Entity and Verify Details","openapi":"POST /entity/{entityId}/verify/{checkType}/{resultLevel}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-entity"}]},{"group":"Business","pages":[{"title":"(International) Retrieve a business profile from any country.","openapi":"POST /business/international/profile","href":"/docs/v1/api/kyc-api-endpoints/reference/business/international-business-profile"},{"title":"(International) Search for a business from any country.","openapi":"POST /business/international/search","href":"/docs/v1/api/kyc-api-endpoints/reference/business/international-business-search"},{"title":"(AUS Only) Create Business Entity and Query UBO","openapi":"POST /business/ownership/query","href":"/docs/v1/api/kyc-api-endpoints/reference/business/business-ownership-query"},{"title":"(AUS Only) Run Report(s) against a new or existing organisation entity.","openapi":"POST /business/reports","href":"/docs/v1/api/kyc-api-endpoints/reference/business/run-business-reports"},{"title":"(AUS Only) Run Report(s) against a new or existing organisation entity and produce a PDF formatted document.","openapi":"POST /business/reports/multi","href":"/docs/v1/api/kyc-api-endpoints/reference/business/run-business-reports-multi"},{"title":"(AUS Only) Make a new entity a direct associated entity of a parent organisation.","openapi":"POST /business/{entityId}/associateEntity/new","href":"/docs/v1/api/kyc-api-endpoints/reference/business/create-associate-entity"},{"title":"(AUS Only) Make an existing entity (otherId) a direct associated entity of a parent organisation (entityId), or update an existing association.","openapi":"POST /business/{entityId}/associateEntity/{otherId}","href":"/docs/v1/api/kyc-api-endpoints/reference/business/update-associate-entity"},{"title":"(AUS Only) Remove a previously created association between an entity (otherId) and a parent organisation (entityId).","openapi":"DELETE /business/{entityId}/associateEntity/{otherId}","href":"/docs/v1/api/kyc-api-endpoints/reference/business/delete-entity-association"},{"title":"(AUS Only) Retrieve previous UBO query results","openapi":"GET /business/{entityId}/checks","href":"/docs/v1/api/kyc-api-endpoints/reference/business/query-ownership-checks"},{"title":"(International) List available documents in catalogue","openapi":"GET /business/{entityId}/list","href":"/docs/v1/api/kyc-api-endpoints/reference/business/business-document-catalogue"},{"title":"(AUS Only) Retrieve all the parent associations for an Individual or a Business","openapi":"GET /business/{entityId}/parentAssociations","href":"/docs/v1/api/kyc-api-endpoints/reference/business/query-parent-associations"},{"title":"(International) Get status of document order","openapi":"GET /business/{entityId}/report","href":"/docs/v1/api/kyc-api-endpoints/reference/business/order-business-document-status"},{"title":"(International) Order document from catalogue","openapi":"POST /business/{entityId}/report","href":"/docs/v1/api/kyc-api-endpoints/reference/business/order-business-document"},{"title":"(AUS Only) Subscribe or unsubscribe to continuous monitoring of business details and ownership.","openapi":"POST /business/{entityId}/subscription","href":"/docs/v1/api/kyc-api-endpoints/reference/business/business-ownership-subscription"},{"title":"(AUS Only) Run KYC/AML Checks on Organisation and/or Associated Individuals.","openapi":"POST /business/{entityId}/verify","href":"/docs/v1/api/kyc-api-endpoints/reference/business/check-organisation"}]},{"group":"Push Notification","pages":[{"title":"Push Notification Payload","openapi":"post /your/configured/path/{requestId}","href":"/docs/v1/api/kyc-api-endpoints/reference/push-notification/notify-result"}]},{"group":"Retrieve","pages":[{"title":"(Re)retrieve Response Result.","openapi":"GET /retrieve/response/{requestId}","href":"/docs/v1/api/kyc-api-endpoints/reference/retrieve/retrieve-result"}]},{"group":"Flag","pages":[{"title":"Set Entity Blacklist State.","openapi":"POST /entity/{entityId}/flag/blacklist","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/blacklist-entity"},{"title":"Resolve Duplicate States.","openapi":"POST /entity/{entityId}/flag/duplicate/{otherId}","description":"Resolve the state of a pair of duplicate entities with the '?set=' query parameter as 'true' or 'false'.\nSetting duplicate to 'true' will make entityId invisible for most purposes and otherId will continue to function as normal.\nSetting duplicate to 'false' means the two entities are in fact separate but similar and they will both continue to exist independently but will no longer be identified as duplicates of each other.\n","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/flag-duplicate-entity"},{"title":"Set Entity Ongoing AML Monitoring Status.","openapi":"POST /entity/{entityId}/flag/monitor","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring"},{"title":"Set Entity Watchlist State.","openapi":"POST /entity/{entityId}/flag/watchlist","description":"Mark the entity as watchlisted or not with the '?set=' query parameter as 'true' or 'false'.\n","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/watchlist-entity"}]}]},{"group":"Audit Log API","pages":[{"title":"Audit Log API","sidebarTitle":"Overview","icon":"clipboard-list","href":"/docs/v1/api/audit-log-api/overview"},{"title":"List audit events","openapi":"specs/fc-core-bundled_generated.yaml GET /v2/audit","href":"/docs/v1/api/audit-log-api/list-audit-events"}]},{"group":"Fraud \u0026 AML API Endpoints","pages":[{"group":"Status","pages":[{"title":"Check service status","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /ruok","href":"/api-reference/status/check-service-status"}]},{"group":"Cases","pages":[{"title":"List all cases","deprecated":true,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entity/{entityId}/cases","href":"/api-reference/cases/list-all-cases"},{"title":"Resolve cases for an entity","deprecated":true,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json patch /entity/{entityId}/cases","href":"/api-reference/cases/resolve-cases-for-an-entity"},{"title":"Update a case","deprecated":true,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json patch /entity/{entityId}/cases/{caseId}","href":"/api-reference/cases/update-a-case"}]},{"group":"Transactions","pages":[{"title":"Check a transaction's risk","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json post /transactions","href":"/api-reference/transactions/check-a-transactions-risk"}]},{"group":"Risk","pages":[{"title":"Get an entity's risk level scorecard","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entities/{entityId}/risk","href":"/api-reference/risk/get-an-entitys-risk-level-scorecard"}]},{"group":"Alerts","pages":[{"title":"Fetch all alerts","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /alerts","href":"/api-reference/alerts/fetch-all-alerts"},{"title":"Fetch entities that have had some form of transaction monitoring check completed.","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entities","href":"/api-reference/alerts/fetch-entities-that-have-had-some-form-of-transaction-monitoring-check-completed"},{"title":"Fetch the details for a specific alert","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /alerts/{alertId}","href":"/api-reference/alerts/fetch-the-details-for-a-specific-alert"},{"title":"Resolve a set of alerts for a specific entity","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json patch /entities/{entityId}/alerts","href":"/api-reference/alerts/resolve-a-set-of-alerts-for-a-specific-entity"}]}]},{"group":"IDV API Endpoints","pages":[{"group":"API Reference","pages":[{"title":"Mark all data from an IDV check as captured","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/initProcess","href":"/api-reference/mark-all-data-from-an-idv-check-as-captured"},{"title":"Process an identity document photo for ocr","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/ocr","href":"/api-reference/process-an-identity-document-photo-for-ocr"},{"title":"Process results of IDV check. Optionally re-process results","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/result","href":"/api-reference/process-results-of-idv-check-optionally-re-process-results"},{"title":"Retrieve a token to use with a check","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/token","href":"/api-reference/retrieve-a-token-to-use-with-a-check"},{"title":"Provide onboarding url for hosted onesdk","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/onboarding-url","href":"/api-reference/provide-onboarding-url-for-hosted-onesdk"}]}]},{"group":"KYB Trust Agent","pages":[{"group":"Organization","pages":[{"title":"Document Analyze","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-exp-bundled_generated.yaml post /v2/organizations/documents/analyze","href":"/api-reference/organization/document-analyze"},{"title":"Document Analyses Results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-exp-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}/analyses","href":"/api-reference/organization/document-analyses-results"},{"title":"Document Analysis Result Confirmation","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-exp-bundled_generated.yaml post /v2/organizations/{entityId}/documents/{documentId}/analyses/{analysisId}/confirm","href":"/api-reference/organization/document-analysis-result-confirmation"}]}]},{"group":"KYB V2 API - Preview","pages":[{"group":"Organizations","pages":[{"title":"Organizations Lookup","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/lookup","href":"/api-reference/organizations/organizations-lookup"},{"title":"Organization Profile","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/profile","href":"/api-reference/organizations/organization-profile"},{"title":"Organization Get","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}","href":"/api-reference/organizations/organization-get"},{"title":"Organization Update","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/{entityId}","href":"/api-reference/organizations/organization-update"},{"title":"Organization Ownership","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/ownership","href":"/api-reference/organizations/organization-ownership"},{"title":"Organization Requests","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}/requests","href":"/api-reference/organizations/organization-requests"},{"title":"Organization Request Status","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}/requests/{requestId}","href":"/api-reference/organizations/organization-request-status"}]},{"group":"Hosted URL","pages":[{"title":"Generate Hosted URL","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/hostedUrl","href":"/api-reference/hosted-url/generate-hosted-url"}]},{"group":"Reports","pages":[{"title":"Report Request","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/{entityId}/reports","href":"/api-reference/reports/report-request"}]},{"group":"Documents","pages":[{"title":"Get Attachment","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}","href":"/api-reference/documents/get-attachment"}]}]}]},{"tab":"Release Notes","icon":"code","pages":[{"title":"Release Notes","href":"/docs/v1/release-notes"}]}]}]},"title":"Set Entity Ongoing AML Monitoring Status. - frankieone","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}