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.
Entities are assigned a FrankieOne auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required.
To modify an entity, set the entityId of the entity you wish to update in an update request.
{"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":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae7d8606bddb0a059f6ecaf","clientVersion":"0.0.4094","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":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}ul{color:light-dark(#000000, #FFFFFF)!important}tr{color:light-dark(#000000, #FFFFFF)!important}p{color:light-dark(#000000, #FFFFFF)!important}code{color:#1A6CFF!important}"}],"page":{"pagePath":"api-reference/organization-documents/create-a-new-document-for-an-organization","slug":"/api-reference/organization-documents/create-a-new-document-for-an-organization","pageMetadata":{"title":"Create a new document for an organization.","description":"Add a new document to an organization entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/documents","href":"/api-reference/organization-documents/create-a-new-document-for-an-organization","autogeneratedByOpenApi":true},"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: \"Add a new document to an organization entity.\"\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":"Create a new document for an organization.","description":"Add a new document to an organization entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/documents","href":"/api-reference/organization-documents/create-a-new-document-for-an-organization","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a new document for an organization.","responses":{"201":"938ce1ef-47d3-4136-8a0e-ae5a79433eab","400":"e3f84c43-8898-4844-b385-a06cbbb057c1","401":"c0bc7072-bb99-4764-b3a3-801f1e96ed47","404":"8a47ac38-e24a-466e-a981-45c3cb912acc","500":"787de23c-ccb8-48f1-8275-0f6660ef9a5d","502":"99c1a23e-c7ec-4ef1-98f6-7f2ea0f2d858","503":"994a1d04-b789-4115-ae1c-46e5f2bc3a63"},"requestBody":"6bc09294-6e43-4dee-9ddb-2b19e577005f","operationId":"createOrganizationDocuments","description":"Add a new document to an organization entity.","parameters":["e85a6f11-13f5-42d0-ab5f-8a882f144c3a","f0884286-eebd-4834-8e14-b5550398832d","e54c8d99-05a9-4215-a9d2-e91eef5677d4","34e8dacd-d0b4-4a5e-be50-477aa050f049","41f85427-4598-4a6f-91cf-c4e566594147"],"tags":["Organization Documents"],"security":["01bd7e1f-c2c1-403e-b60c-9a5c75dc584f","054b3e1e-bc9e-4934-8c4e-d57d8b4930a9"],"method":"post","type":"path","servers":["6734e950-f09c-4b6e-9778-94aa10d78805","a1a8c4fb-5482-49a1-954f-d93fec6f9ad8"],"path":"/v2/organizations/{entityId}/documents","baseUrlOptions":["https://api.uat.frankie.one","https://api.frankie.one"],"title":"Create a new document for an organization.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e85a6f11-13f5-42d0-ab5f-8a882f144c3a":{"name":"api_key","in":"header","schema":{"type":"string","example":"245c765b124a098d09ef8765....","isRequired":true,"description":"Your API key provided by FrankieOne","uniqueKey":"","typeLabel":"string"},"description":"Your API key provided by FrankieOne","required":true},"f0884286-eebd-4834-8e14-b5550398832d":{"name":"X-Frankie-CustomerID","in":"header","required":true,"schema":{"type":"string","example":"12345678-1234-1234-1234-123456789012","isRequired":true,"description":"Your Customer ID provided by FrankieOne","uniqueKey":"","typeLabel":"string"},"description":"Your Customer ID provided by FrankieOne"},"e54c8d99-05a9-4215-a9d2-e91eef5677d4":{"name":"X-Frankie-CustomerChildID","in":"header","required":false,"schema":{"type":"string","example":"87654321-4321-4321-4321-210987654321","isRequired":false,"description":"Your Customer Child ID provided by FrankieOne","uniqueKey":"","typeLabel":"string"},"description":"Your Customer Child ID provided by FrankieOne"},"34e8dacd-d0b4-4a5e-be50-477aa050f049":{"name":"X-Frankie-Channel","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"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.","uniqueKey":"","typeLabel":"string"},"description":"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."},"41f85427-4598-4a6f-91cf-c4e566594147":{"name":"X-Frankie-Username","in":"header","description":"Username provided by API caller","required":false,"schema":{"type":"string","example":"fred.flintstone@frankieone.com","isRequired":false,"description":"Username provided by API caller","uniqueKey":"","typeLabel":"string"}},"88828199-a00e-4106-9cd1-d7c30898ce11":{"name":"entityId","in":"path","schema":{"type":"string","isRequired":true,"description":"Unique FrankieOne identifier for an entity","uniqueKey":"","typeLabel":"string"},"description":"Unique FrankieOne identifier for an entity","required":true},"37244387-ba85-4ff4-98ef-bca6d52e817f":{"name":"level","in":"query","schema":{"type":"string","default":"meta","enum":["id","meta","base64"],"description":"Determines what level of detail to return in the response\n - id: Return just an id\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and data in base64 format","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Determines what level of detail to return in the response\n - id: Return just an id\n - meta: Return all metadata only, no links or base64 data\n - base64: Return all metadata and data in base64 format"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"document":{"type":"object","title":"DocumentCreate","required":["type","country"],"properties":{"type":{"type":"string","enum":["OTHER","DRIVERS_LICENSE","PASSPORT","VISA","IMMIGRATION","NATIONAL_ID","TAX_ID","NATIONAL_HEALTH_ID","CONCESSION","HEALTH_CONCESSION","PENSION","MILITARY_ID","BIRTH_CERT","CITIZENSHIP","MARRIAGE_CERT","DEATH_CERT","NAME_CHANGE","UTILITY_BILL","BANK_STATEMENT","BANK_ACCOUNT","INTENT_PROOF","ATTESTATION","SELF_IMAGE","DEVICE","VEHICLE_REGISTRATION","PROOF_OF_ADDRESS","HOUSE_REGISTRATION","YELLOW_HOUSE_REGISTRATION","WORK_PERMIT","EMPLOYMENT_CERTIFICATE","NOTARY_PUBLIC_ID","EXTERNAL_ADMIN","CHARGES","PRE_ASIC","ANNUAL_RETURN","REPORT","TRUST_DEED","DEED_OF_VARIATION","REGISTER_OF_UNIT_HOLDERS","PARTNERSHIP_AGREEMENT","ADMIN_CHANGE","COMPANY_REPORT","CHECK_RESULTS","AVIATION_SECURITY_ID","MARITIME_SECURITY_ID","ORGANIZATION_PROFILE","ORGANIZATION_OWNERSHIP"],"description":"Valid document ID types.\n\n - \"OTHER\": Generic document type. Unspecified.\n - \"DRIVERS_LICENSE\": Driver's license.\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 - \"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 change 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\": Proof of intent, generally a photo/video or a scanned letter.\n - \"ATTESTATION\": Document of attestation (e.g., Statutory Declaration).\n\n NOTE: These cannot be used as a supporting document:\n - \"SELF_IMAGE\": A \"selfie\" used for comparisons.\n - \"DEVICE\": Device ID.\n - \"VEHICLE_REGISTRATION\": Vehicle registration number.\n - \"PROOF_OF_ADDRESS\": Any document that provides 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\n Business-related documentation:\n\n - \"EXTERNAL_ADMIN\": Details of appointed administrator.\n - \"CHARGES\": Details of any charges 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 - \"DEED_OF_VARIATION\": Deed of variation document.\n - \"REGISTER_OF_UNIT_HOLDERS\": Register of unit holders document.\n - \"PARTNERSHIP_AGREEMENT\": Partnership agreement documents.\n - \"ADMIN_CHANGE\": Change of administrator.\n - \"COMPANY_REPORT\": Registry-filed company reports.\n - \"ORGANIZATION_PROFILE\": Organization profile document.\n - \"ORGANIZATION_OWNERSHIP\": Organization ownership document.\n\n Special document types:\n\n - \"CHECK_RESULTS\": Special document type for specifying results of checks completed other than through Frankie.\n - \"AVIATION_SECURITY_ID\": Aviation Security Identification Card.\n - \"MARITIME_SECURITY_ID\": Maritime Security Identification Card.","x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.type","typeLabel":"enum\u003cstring>"},"country":{"type":"string","maxLength":3,"description":"The ISO 3166 alpha-3 country code where the document was issued, if relevant.\nFor more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","example":"AUS","x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.country","typeLabel":"string"},"class":{"type":"string","description":"The classification of the document, indicating how it should be used or interpreted.","enum":["OTHER","IDENTITY","SUPPORTING","REPORT"],"example":"IDENTITY","uniqueKey":"document.class","typeLabel":"enum\u003cstring>"},"documentId":{"type":"string","format":"uuid","description":"As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference.\nTo modify a document, include the documentId in an update request.","example":"92de15f64-5717-4562-b3fc-2c963f6665a7","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.documentId","typeLabel":"string\u003cuuid>"},"expiryDate":{"type":"object","description":"The expiry date of the document in YYYY-MM-DD format.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.expiryDate.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.expiryDate.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.expiryDate.day","typeLabel":"string"},"unstructured":{"type":"string","description":"Raw date format without normalization or standardization to the Gregorian calendar.\nThis can be used to provide non-Gregorian dates (e.g., Islamic dates).","example":"12 Rajab 1445 AH","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.expiryDate.unstructured","typeLabel":"string"},"type":{"type":"string","default":"GREGORIAN","enum":["BUDDHIST","DISCORDIAN","GREGORIAN","HEBREW","ISLAMIC","JULIAN","LUNAR","MESO_AMERICAN","PERSIAN","OTHER"],"description":"The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.expiryDate.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"document.expiryDate","typeLabel":"object"},"issueDate":{"type":"object","description":"The issue date of the document in YYYY-MM-DD format.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.issueDate.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.issueDate.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.issueDate.day","typeLabel":"string"},"unstructured":{"type":"string","description":"Raw date format without normalization or standardization to the Gregorian calendar.\nThis can be used to provide non-Gregorian dates (e.g., Islamic dates).","example":"12 Rajab 1445 AH","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.issueDate.unstructured","typeLabel":"string"},"type":{"type":"string","default":"GREGORIAN","enum":["BUDDHIST","DISCORDIAN","GREGORIAN","HEBREW","ISLAMIC","JULIAN","LUNAR","MESO_AMERICAN","PERSIAN","OTHER"],"description":"The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.issueDate.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"document.issueDate","typeLabel":"object"},"primaryIdentifier":{"type":"string","description":"The primary ID number of the document, e.g., the ID number on a driver licence.","example":"000734130","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary ID number of the document, e.g., the card number on a driver licence.","example":"P0001975","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.secondaryIdentifier","typeLabel":"string"},"isDigital":{"type":"boolean","description":"Indicator that this document is sourced via digital means.","uniqueKey":"document.isDigital","typeLabel":"boolean"},"isExternallyVerified":{"type":"boolean","description":"Indicator that this document has been externally verified outside of Frankie system.","uniqueKey":"document.isExternallyVerified","typeLabel":"boolean"},"subtype":{"type":"string","description":"The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report).","example":"Photo Comparison","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.subtype","typeLabel":"string"},"subdivision":{"type":"string","description":"The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., \"VIC\" for the Australian state of Victoria or \"MA\" for the US state of Massachusetts.","example":"VIC","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.subdivision","typeLabel":"string"},"validFrom":{"type":"object","description":"The date when the validity period for this document began, if applicable.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validFrom.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validFrom.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validFrom.day","typeLabel":"string"},"unstructured":{"type":"string","description":"Raw date format without normalization or standardization to the Gregorian calendar.\nThis can be used to provide non-Gregorian dates (e.g., Islamic dates).","example":"12 Rajab 1445 AH","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validFrom.unstructured","typeLabel":"string"},"type":{"type":"string","default":"GREGORIAN","enum":["BUDDHIST","DISCORDIAN","GREGORIAN","HEBREW","ISLAMIC","JULIAN","LUNAR","MESO_AMERICAN","PERSIAN","OTHER"],"description":"The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.validFrom.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"document.validFrom","typeLabel":"object"},"validTo":{"type":"object","description":"The date when the validity period for this document ended, if applicable.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validTo.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validTo.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validTo.day","typeLabel":"string"},"unstructured":{"type":"string","description":"Raw date format without normalization or standardization to the Gregorian calendar.\nThis can be used to provide non-Gregorian dates (e.g., Islamic dates).","example":"12 Rajab 1445 AH","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validTo.unstructured","typeLabel":"string"},"type":{"type":"string","default":"GREGORIAN","enum":["BUDDHIST","DISCORDIAN","GREGORIAN","HEBREW","ISLAMIC","JULIAN","LUNAR","MESO_AMERICAN","PERSIAN","OTHER"],"description":"The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.validTo.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"document.validTo","typeLabel":"object"},"supplementaryData":{"oneOf":[{"type":"object","description":"Supplementary information relevant to a national health id.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.0.type","typeLabel":"enum\u003cstring>"},"reference":{"type":"string","description":"The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card).","example":"1","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.0.reference","typeLabel":"string"},"nameOnCardLine1":{"type":"string","description":"The individual's name as it appears on the card.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.nameOnCardLine1","typeLabel":"string"},"nameOnCardLine2":{"type":"string","description":"If the individual's name spans more than one line, this is the part of the name that appears on line 2.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.nameOnCardLine2","typeLabel":"string"},"nameOnCardLine3":{"type":"string","description":"If the individual's name spans more than two lines, this is the part of the name that appears on line 3.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.nameOnCardLine3","typeLabel":"string"},"nameOnCardLine4":{"type":"string","description":"If the individual's name spans more than three lines, this is the part of the name that appears on line 4.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.nameOnCardLine4","typeLabel":"string"},"middleNameOnCard":{"type":"string","description":"The individual's middle name or initial as it appears on the card.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.middleNameOnCard","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.0","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a birth certificate.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.1.type","typeLabel":"enum\u003cstring>"},"registrationDate":{"type":"string","description":"The date the birth was registered.","example":"2000","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.1.registrationDate","typeLabel":"string"},"registrationDistrict":{"type":"string","description":"The district where the birth was registered.","example":"Sydney","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.1.registrationDistrict","typeLabel":"string"},"dateOfPrint":{"type":"string","description":"The date the birth certificate was printed.","example":"2000","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.1.dateOfPrint","typeLabel":"string"},"givenName":{"type":"string","description":"The given name as printed on the certificate.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.1.givenName","typeLabel":"string"},"otherNames":{"type":"string","description":"Other name(s) as printed on the certificate.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.1.otherNames","typeLabel":"string"},"familyName":{"type":"string","description":"The family name as printed on the certificate.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.1.familyName","typeLabel":"string"},"countryOfBirth":{"type":"string","description":"The country of birth as printed on the certificate. ISO 3166-1 alpha-3 code.","example":"AUS","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.1.countryOfBirth","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.1","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a national ID.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.2.type","typeLabel":"enum\u003cstring>"},"homeCountryFullName":{"type":"string","description":"The original full name from the individual's home country national ID.","example":"张伟明","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.2.homeCountryFullName","typeLabel":"string"},"paternalFamilyName":{"type":"string","description":"The individual's family name inherited from the father's side.","example":"MENDOZA","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.2.paternalFamilyName","typeLabel":"string"},"maternalFamilyName":{"type":"string","description":"The individual's family name inherited from the mother's side.","example":"GARCIA","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.2.maternalFamilyName","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.2","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a citizenship certificate.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.3.type","typeLabel":"enum\u003cstring>"},"acquisitionDate":{"type":"string","description":"The date citizenship was acquired.","example":"2000/01/01","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.3.acquisitionDate","typeLabel":"string"},"primaryCountry":{"type":"string","description":"The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code.","example":"USA","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.3.primaryCountry","typeLabel":"string"},"secondaryCountry":{"type":"string","description":"The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code.","example":"CAN","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.3.secondaryCountry","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.3","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a national health id.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.4.type","typeLabel":"enum\u003cstring>"},"homeCountryFullName":{"type":"string","description":"The original name from the home country of passport.","example":"张伟明","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.4.homeCountryFullName","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.4","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a marriage certificate.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.5.type","typeLabel":"enum\u003cstring>"},"partner1GivenName":{"type":"string","description":"The given name of partner 1.","example":"Harry","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner1GivenName","typeLabel":"string"},"partner1FamilyName":{"type":"string","description":"The family name of partner 1.","example":"Versailles","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner1FamilyName","typeLabel":"string"},"partner1OtherName":{"type":"string","description":"The other name of partner 1.","example":"S.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner1OtherName","typeLabel":"string"},"partner2GivenName":{"type":"string","description":"The given name of partner 2.","example":"Harry","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner2GivenName","typeLabel":"string"},"partner2FamilyName":{"type":"string","description":"The family name of partner 2.","example":"Versailles","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner2FamilyName","typeLabel":"string"},"partner2OtherName":{"type":"string","description":"The other name of partner 2.","example":"S.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner2OtherName","typeLabel":"string"},"registrationDate":{"type":"string","description":"The date the marriage was registered.","example":"2023","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.registrationDate","typeLabel":"string"},"marriageDate":{"type":"string","description":"The date the marriage was held.","example":"2023-10-01","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.marriageDate","typeLabel":"string"},"dateOfPrint":{"type":"string","description":"The date the birth certificate was printed.","example":"2023-10-01","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.dateOfPrint","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.5","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a name change certificate.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.6.type","typeLabel":"enum\u003cstring>"},"dateOfPrint":{"type":"string","description":"The date the name change certificate was printed.","example":"2000/01/01","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.6.dateOfPrint","typeLabel":"string"},"registrationDate":{"type":"string","description":"The date the name change certificate was registered.","example":"2000/01/01","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.6.registrationDate","typeLabel":"string"},"registeredFamilyName":{"type":"string","description":"The family name registered in the name change certificate.","example":"Doe","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.6.registeredFamilyName","typeLabel":"string"},"registeredGivenName":{"type":"string","description":"The given name registered in the name change certificate.","example":"John","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.6.registeredGivenName","typeLabel":"string"},"registeredOtherGivenNames":{"type":"string","description":"Other given names registered in the name change certificate.","example":"Roy Michael","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.6.registeredOtherGivenNames","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.6","typeLabel":"object"}],"uniqueKey":"document.supplementaryData","typeLabel":"object"},"customAttributes":{"type":"object","additionalProperties":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The attribute type.","type":"string","maxLength":64,"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.customAttributes.additionalProperties.type","typeLabel":"string"},"value":{"description":"The value assigned to the attribute.","type":"string","x-oapi-codegen-extra-tags":{"audit":"mask"},"isRequired":true,"uniqueKey":"document.customAttributes.additionalProperties.value","typeLabel":"string"}},"uniqueKey":"document.customAttributes.additionalProperties","typeLabel":"object"},"uniqueKey":"document.customAttributes","typeLabel":"object"},"attachments":{"type":"array","description":"List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document.\n\nAttachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request.","items":{"type":"object","required":["data"],"description":"Document attachment details.","properties":{"data":{"oneOf":[{"type":"object","description":"A Base64-encoded string or URI representing the data.","required":["uri"],"properties":{"uri":{"type":"string","description":"URI identifying the resource location.","example":"https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg","x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data.oneOf.0.uri","typeLabel":"string"}},"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data.oneOf.0","typeLabel":"object"},{"type":"object","description":"A Base64-encoded string or URI representing the data.","required":["base64"],"properties":{"base64":{"type":"string","description":"Base64-encoded string of the raw attachment data.","example":"ZG9jdW1lbnQgaW1hZ2UgZ29lcyBoZXJl","x-oapi-codegen-extra-tags":{"audit":"redact"},"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data.oneOf.1.base64","typeLabel":"string"}},"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data","typeLabel":"object"},"attachmentId":{"type":"string","format":"uuid","description":"When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].attachmentId","typeLabel":"string\u003cuuid>"},"filename":{"type":"string","description":"If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.attachments.items.[INDEX].filename","typeLabel":"string"},"mimeType":{"type":"string","description":"The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].mimeType","typeLabel":"string"},"pageNumber":{"type":"integer","description":"If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].pageNumber","typeLabel":"integer"},"side":{"type":"string","enum":["FRONT","BACK"],"description":"Indicates whether the attachment is the front or back side of a document.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].side","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"General types of valid document attachments.\n - \"PHOTO\": Any photo.\n - \"VIDEO\": Any video.\n - \"AUDIO\": Any audio.\n - \"PDF\": PDF or PS file (may contain text, images, or both).\n - \"DOC\": Word document, RTF, etc.\n - \"ZIP\": Any compressed file(s).","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].type","typeLabel":"string"},"location":{"description":"Reference to where the data can be retrieved from.","type":"string","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].location","typeLabel":"string"},"lastMalwareScanAt":{"type":"string","format":"date-time","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].lastMalwareScanAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"document.attachments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"document.attachments","typeLabel":"object[]"}},"uniqueKey":"document","typeLabel":"DocumentCreate · object"},"comment":{"type":"object","properties":{"text":{"type":"string","description":"The text content of the comment.","example":"Update after speaking to customer over the phone directly.","uniqueKey":"comment.text","typeLabel":"string"},"entityId":{"type":"string","description":"Entities are assigned a FrankieOne auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required.\nTo modify an entity, set the entityId of the entity you wish to update in an update request.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","uniqueKey":"comment.entityId","typeLabel":"string"},"entityType":{"type":"string","enum":["INDIVIDUAL","ORGANIZATION","UNKNOWN"],"description":"The type of entity within Frankie. This can be \"INDIVIDUAL\", \"ORGANIZATION\", or \"UNKNOWN\".","uniqueKey":"comment.entityType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"comment","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"comment":{"text":"Update after speaking to customer over the phone directly.","entityId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"938ce1ef-47d3-4136-8a0e-ae5a79433eab":{"description":"Created","content":{"application/json":{"schema":{"type":"object","required":["requestId"],"properties":{"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"entityId":{"type":"string","description":"Entities are assigned a FrankieOne auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required.\nTo modify an entity, set the entityId of the entity you wish to update in an update request.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"entityId","typeLabel":"string"},"document":{"type":"object","required":["type","country"],"properties":{"type":{"type":"string","enum":["OTHER","DRIVERS_LICENSE","PASSPORT","VISA","IMMIGRATION","NATIONAL_ID","TAX_ID","NATIONAL_HEALTH_ID","CONCESSION","HEALTH_CONCESSION","PENSION","MILITARY_ID","BIRTH_CERT","CITIZENSHIP","MARRIAGE_CERT","DEATH_CERT","NAME_CHANGE","UTILITY_BILL","BANK_STATEMENT","BANK_ACCOUNT","INTENT_PROOF","ATTESTATION","SELF_IMAGE","DEVICE","VEHICLE_REGISTRATION","PROOF_OF_ADDRESS","HOUSE_REGISTRATION","YELLOW_HOUSE_REGISTRATION","WORK_PERMIT","EMPLOYMENT_CERTIFICATE","NOTARY_PUBLIC_ID","EXTERNAL_ADMIN","CHARGES","PRE_ASIC","ANNUAL_RETURN","REPORT","TRUST_DEED","DEED_OF_VARIATION","REGISTER_OF_UNIT_HOLDERS","PARTNERSHIP_AGREEMENT","ADMIN_CHANGE","COMPANY_REPORT","CHECK_RESULTS","AVIATION_SECURITY_ID","MARITIME_SECURITY_ID","ORGANIZATION_PROFILE","ORGANIZATION_OWNERSHIP"],"description":"Valid document ID types.\n\n - \"OTHER\": Generic document type. Unspecified.\n - \"DRIVERS_LICENSE\": Driver's license.\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 - \"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 change 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\": Proof of intent, generally a photo/video or a scanned letter.\n - \"ATTESTATION\": Document of attestation (e.g., Statutory Declaration).\n\n NOTE: These cannot be used as a supporting document:\n - \"SELF_IMAGE\": A \"selfie\" used for comparisons.\n - \"DEVICE\": Device ID.\n - \"VEHICLE_REGISTRATION\": Vehicle registration number.\n - \"PROOF_OF_ADDRESS\": Any document that provides 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\n Business-related documentation:\n\n - \"EXTERNAL_ADMIN\": Details of appointed administrator.\n - \"CHARGES\": Details of any charges 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 - \"DEED_OF_VARIATION\": Deed of variation document.\n - \"REGISTER_OF_UNIT_HOLDERS\": Register of unit holders document.\n - \"PARTNERSHIP_AGREEMENT\": Partnership agreement documents.\n - \"ADMIN_CHANGE\": Change of administrator.\n - \"COMPANY_REPORT\": Registry-filed company reports.\n - \"ORGANIZATION_PROFILE\": Organization profile document.\n - \"ORGANIZATION_OWNERSHIP\": Organization ownership document.\n\n Special document types:\n\n - \"CHECK_RESULTS\": Special document type for specifying results of checks completed other than through Frankie.\n - \"AVIATION_SECURITY_ID\": Aviation Security Identification Card.\n - \"MARITIME_SECURITY_ID\": Maritime Security Identification Card.","x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.type","typeLabel":"enum\u003cstring>"},"country":{"type":"string","maxLength":3,"description":"The ISO 3166 alpha-3 country code where the document was issued, if relevant.\nFor more information, please refer to: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes","example":"AUS","x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.country","typeLabel":"string"},"class":{"type":"string","enum":["OTHER","IDENTITY","SUPPORTING","REPORT"],"description":"The classification of the document, indicating how it should be used or interpreted.","example":"IDENTITY","uniqueKey":"document.class","typeLabel":"enum\u003cstring>"},"documentId":{"type":"string","format":"uuid","description":"As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference.\nTo modify a document, include the documentId in an update request.","example":"92de15f64-5717-4562-b3fc-2c963f6665a7","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.documentId","typeLabel":"string\u003cuuid>"},"entityId":{"type":"string","description":"Entities are assigned a FrankieOne auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required.\nTo modify an entity, set the entityId of the entity you wish to update in an update request.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.entityId","typeLabel":"string"},"expiryDate":{"type":"object","description":"The expiry date of the document in YYYY-MM-DD format.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.expiryDate.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.expiryDate.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.expiryDate.day","typeLabel":"string"},"unstructured":{"type":"string","description":"Raw date format without normalization or standardization to the Gregorian calendar.\nThis can be used to provide non-Gregorian dates (e.g., Islamic dates).","example":"12 Rajab 1445 AH","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.expiryDate.unstructured","typeLabel":"string"},"type":{"type":"string","default":"GREGORIAN","enum":["BUDDHIST","DISCORDIAN","GREGORIAN","HEBREW","ISLAMIC","JULIAN","LUNAR","MESO_AMERICAN","PERSIAN","OTHER"],"description":"The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.expiryDate.type","typeLabel":"enum\u003cstring>"},"normalized":{"type":"string","format":"date","description":"Full date in ISO 8601 format (\"YYYY-MM-DD\"). This is a read-only field.","example":"1990-03-31","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.expiryDate.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"document.expiryDate","typeLabel":"object"},"issueDate":{"type":"object","description":"The issue date of the document in YYYY-MM-DD format.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.issueDate.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.issueDate.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.issueDate.day","typeLabel":"string"},"unstructured":{"type":"string","description":"Raw date format without normalization or standardization to the Gregorian calendar.\nThis can be used to provide non-Gregorian dates (e.g., Islamic dates).","example":"12 Rajab 1445 AH","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.issueDate.unstructured","typeLabel":"string"},"type":{"type":"string","default":"GREGORIAN","enum":["BUDDHIST","DISCORDIAN","GREGORIAN","HEBREW","ISLAMIC","JULIAN","LUNAR","MESO_AMERICAN","PERSIAN","OTHER"],"description":"The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.issueDate.type","typeLabel":"enum\u003cstring>"},"normalized":{"type":"string","format":"date","description":"Full date in ISO 8601 format (\"YYYY-MM-DD\"). This is a read-only field.","example":"1990-03-31","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.issueDate.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"document.issueDate","typeLabel":"object"},"primaryIdentifier":{"type":"string","description":"The primary ID number of the document, e.g., the ID number on a driver licence.","example":"000734130","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.primaryIdentifier","typeLabel":"string"},"secondaryIdentifier":{"type":"string","description":"The secondary ID number of the document, e.g., the card number on a driver licence.","example":"P0001975","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.secondaryIdentifier","typeLabel":"string"},"isDigital":{"type":"boolean","description":"Indicator that this document is sourced via digital means.","uniqueKey":"document.isDigital","typeLabel":"boolean"},"isExternallyVerified":{"type":"boolean","description":"Indicator that this document has been externally verified outside of Frankie system.","uniqueKey":"document.isExternallyVerified","typeLabel":"boolean"},"subtype":{"type":"string","description":"The sub-type of the document, if relevant. This can include specific report or attestation types, e.g., FACIAL_COMPARISON (attestation) or KYC (report).","example":"Photo Comparison","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.subtype","typeLabel":"string"},"subdivision":{"type":"string","description":"The abbreviated ISO 3166 subdivision/region where the ID was issued, e.g., \"VIC\" for the Australian state of Victoria or \"MA\" for the US state of Massachusetts.","example":"VIC","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.subdivision","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the document record was created, in ISO 8601 format.","example":"2024-01-15T02:18:11.365Z","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the document record was last updated, in ISO 8601 format.","example":"2025-01-16T02:18:11.365Z","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.updatedAt","typeLabel":"string\u003cdate-time>"},"validFrom":{"type":"object","description":"The date when the validity period for this document began, if applicable.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validFrom.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validFrom.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validFrom.day","typeLabel":"string"},"unstructured":{"type":"string","description":"Raw date format without normalization or standardization to the Gregorian calendar.\nThis can be used to provide non-Gregorian dates (e.g., Islamic dates).","example":"12 Rajab 1445 AH","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validFrom.unstructured","typeLabel":"string"},"type":{"type":"string","default":"GREGORIAN","enum":["BUDDHIST","DISCORDIAN","GREGORIAN","HEBREW","ISLAMIC","JULIAN","LUNAR","MESO_AMERICAN","PERSIAN","OTHER"],"description":"The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.validFrom.type","typeLabel":"enum\u003cstring>"},"normalized":{"type":"string","format":"date","description":"Full date in ISO 8601 format (\"YYYY-MM-DD\"). This is a read-only field.","example":"1990-03-31","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validFrom.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"document.validFrom","typeLabel":"object"},"validTo":{"type":"object","description":"The date when the validity period for this document ended, if applicable.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validTo.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validTo.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validTo.day","typeLabel":"string"},"unstructured":{"type":"string","description":"Raw date format without normalization or standardization to the Gregorian calendar.\nThis can be used to provide non-Gregorian dates (e.g., Islamic dates).","example":"12 Rajab 1445 AH","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validTo.unstructured","typeLabel":"string"},"type":{"type":"string","default":"GREGORIAN","enum":["BUDDHIST","DISCORDIAN","GREGORIAN","HEBREW","ISLAMIC","JULIAN","LUNAR","MESO_AMERICAN","PERSIAN","OTHER"],"description":"The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESO_AMERICAN, PERSIAN, or OTHER.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.validTo.type","typeLabel":"enum\u003cstring>"},"normalized":{"type":"string","format":"date","description":"Full date in ISO 8601 format (\"YYYY-MM-DD\"). This is a read-only field.","example":"1990-03-31","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.validTo.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"document.validTo","typeLabel":"object"},"sourceId":{"type":"string","description":"The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map.","example":"324f15f64-5717-4562-b3fc-2c963f66ffa1","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.sourceId","typeLabel":"string"},"supplementaryData":{"oneOf":[{"type":"object","description":"Supplementary information relevant to a national health id.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.0.type","typeLabel":"enum\u003cstring>"},"reference":{"type":"string","description":"The individual reference number used to identify the position of the applicant's name on the health card. Required for Australian Medicare cards (this is the number to the left of the name on the card).","example":"1","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.0.reference","typeLabel":"string"},"nameOnCardLine1":{"type":"string","description":"The individual's name as it appears on the card.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.nameOnCardLine1","typeLabel":"string"},"nameOnCardLine2":{"type":"string","description":"If the individual's name spans more than one line, this is the part of the name that appears on line 2.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.nameOnCardLine2","typeLabel":"string"},"nameOnCardLine3":{"type":"string","description":"If the individual's name spans more than two lines, this is the part of the name that appears on line 3.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.nameOnCardLine3","typeLabel":"string"},"nameOnCardLine4":{"type":"string","description":"If the individual's name spans more than three lines, this is the part of the name that appears on line 4.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.nameOnCardLine4","typeLabel":"string"},"middleNameOnCard":{"type":"string","description":"The individual's middle name or initial as it appears on the card.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.0.middleNameOnCard","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.0","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a birth certificate.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.1.type","typeLabel":"enum\u003cstring>"},"registrationDate":{"type":"string","description":"The date the birth was registered.","example":"2000","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.1.registrationDate","typeLabel":"string"},"registrationDistrict":{"type":"string","description":"The district where the birth was registered.","example":"Sydney","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.1.registrationDistrict","typeLabel":"string"},"dateOfPrint":{"type":"string","description":"The date the birth certificate was printed.","example":"2000","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.1.dateOfPrint","typeLabel":"string"},"givenName":{"type":"string","description":"The given name as printed on the certificate.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.1.givenName","typeLabel":"string"},"otherNames":{"type":"string","description":"Other name(s) as printed on the certificate.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.1.otherNames","typeLabel":"string"},"familyName":{"type":"string","description":"The family name as printed on the certificate.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.1.familyName","typeLabel":"string"},"countryOfBirth":{"type":"string","description":"The country of birth as printed on the certificate. ISO 3166-1 alpha-3 code.","example":"AUS","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.1.countryOfBirth","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.1","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a national ID.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.2.type","typeLabel":"enum\u003cstring>"},"homeCountryFullName":{"type":"string","description":"The original full name from the individual's home country national ID.","example":"张伟明","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.2.homeCountryFullName","typeLabel":"string"},"paternalFamilyName":{"type":"string","description":"The individual's family name inherited from the father's side.","example":"MENDOZA","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.2.paternalFamilyName","typeLabel":"string"},"maternalFamilyName":{"type":"string","description":"The individual's family name inherited from the mother's side.","example":"GARCIA","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.2.maternalFamilyName","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.2","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a citizenship certificate.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.3.type","typeLabel":"enum\u003cstring>"},"acquisitionDate":{"type":"string","description":"The date citizenship was acquired.","example":"2000/01/01","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.3.acquisitionDate","typeLabel":"string"},"primaryCountry":{"type":"string","description":"The primary country of citizenship, represented by its three-letter ISO 3166-1 alpha-3 code.","example":"USA","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.3.primaryCountry","typeLabel":"string"},"secondaryCountry":{"type":"string","description":"The secondary country of citizenship, if applicable, represented by its three-letter ISO 3166-1 alpha-3 code.","example":"CAN","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.3.secondaryCountry","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.3","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a national health id.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.4.type","typeLabel":"enum\u003cstring>"},"homeCountryFullName":{"type":"string","description":"The original name from the home country of passport.","example":"张伟明","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.4.homeCountryFullName","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.4","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a marriage certificate.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.5.type","typeLabel":"enum\u003cstring>"},"partner1GivenName":{"type":"string","description":"The given name of partner 1.","example":"Harry","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner1GivenName","typeLabel":"string"},"partner1FamilyName":{"type":"string","description":"The family name of partner 1.","example":"Versailles","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner1FamilyName","typeLabel":"string"},"partner1OtherName":{"type":"string","description":"The other name of partner 1.","example":"S.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner1OtherName","typeLabel":"string"},"partner2GivenName":{"type":"string","description":"The given name of partner 2.","example":"Harry","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner2GivenName","typeLabel":"string"},"partner2FamilyName":{"type":"string","description":"The family name of partner 2.","example":"Versailles","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner2FamilyName","typeLabel":"string"},"partner2OtherName":{"type":"string","description":"The other name of partner 2.","example":"S.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.partner2OtherName","typeLabel":"string"},"registrationDate":{"type":"string","description":"The date the marriage was registered.","example":"2023","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.registrationDate","typeLabel":"string"},"marriageDate":{"type":"string","description":"The date the marriage was held.","example":"2023-10-01","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.marriageDate","typeLabel":"string"},"dateOfPrint":{"type":"string","description":"The date the birth certificate was printed.","example":"2023-10-01","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.5.dateOfPrint","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.5","typeLabel":"object"},{"type":"object","description":"Supplementary information relevant to a name change certificate.","required":["type"],"properties":{"type":{"type":"string","description":"The document type that defines the type of supplementary data returned.","enum":["NATIONAL_HEALTH_ID","BIRTH_CERT","NATIONAL_ID","CITIZENSHIP","PASSPORT","MARRIAGE_CERT"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.supplementaryData.oneOf.6.type","typeLabel":"enum\u003cstring>"},"dateOfPrint":{"type":"string","description":"The date the name change certificate was printed.","example":"2000/01/01","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.6.dateOfPrint","typeLabel":"string"},"registrationDate":{"type":"string","description":"The date the name change certificate was registered.","example":"2000/01/01","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.supplementaryData.oneOf.6.registrationDate","typeLabel":"string"},"registeredFamilyName":{"type":"string","description":"The family name registered in the name change certificate.","example":"Doe","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.6.registeredFamilyName","typeLabel":"string"},"registeredGivenName":{"type":"string","description":"The given name registered in the name change certificate.","example":"John","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.6.registeredGivenName","typeLabel":"string"},"registeredOtherGivenNames":{"type":"string","description":"Other given names registered in the name change certificate.","example":"Roy Michael","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.supplementaryData.oneOf.6.registeredOtherGivenNames","typeLabel":"string"}},"uniqueKey":"document.supplementaryData.oneOf.6","typeLabel":"object"}],"uniqueKey":"document.supplementaryData","typeLabel":"object"},"customAttributes":{"type":"object","additionalProperties":{"type":"object","required":["type","value"],"properties":{"type":{"description":"The attribute type.","type":"string","maxLength":64,"x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.customAttributes.additionalProperties.type","typeLabel":"string"},"value":{"description":"The value assigned to the attribute.","type":"string","x-oapi-codegen-extra-tags":{"audit":"mask"},"isRequired":true,"uniqueKey":"document.customAttributes.additionalProperties.value","typeLabel":"string"}},"uniqueKey":"document.customAttributes.additionalProperties","typeLabel":"object"},"uniqueKey":"document.customAttributes","typeLabel":"object"},"attachments":{"type":"array","description":"List of scans, pages, or files for a single document, e.g., front and back images of a driver licence, or page 1, 2, and 3 of a supporting document.\n\nAttachments can be uploaded in a single call or in multiple calls. To upload attachments over multiple calls, include the documentId in the request.","items":{"type":"object","required":["data"],"description":"Document attachment details.","properties":{"data":{"oneOf":[{"type":"object","description":"A Base64-encoded string or URI representing the data.","required":["uri"],"properties":{"uri":{"type":"string","description":"URI identifying the resource location.","example":"https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg","x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data.oneOf.0.uri","typeLabel":"string"}},"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data.oneOf.0","typeLabel":"object"},{"type":"object","description":"A Base64-encoded string or URI representing the data.","required":["base64"],"properties":{"base64":{"type":"string","description":"Base64-encoded string of the raw attachment data.","example":"ZG9jdW1lbnQgaW1hZ2UgZ29lcyBoZXJl","x-oapi-codegen-extra-tags":{"audit":"redact"},"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data.oneOf.1.base64","typeLabel":"string"}},"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"document.attachments.items.[INDEX].data","typeLabel":"object"},"attachmentId":{"type":"string","format":"uuid","description":"When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. It can be referenced in subsequent calls if you are uploading additional or updated data.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].attachmentId","typeLabel":"string\u003cuuid>"},"sourceId":{"type":"string","readOnly":true,"description":"The source from which specific information was sourced. This is a link to an informationSource object in the informationSources map.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].sourceId","typeLabel":"string"},"createdAt":{"type":"string","readOnly":true,"format":"date-time","description":"The date and time the attachment was created. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time the attachment was last updated. This is not the date of the attached document, which should be in the idIssued attribute of the document that owns this attachment.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"filename":{"type":"string","description":"If you are uploading a file where it is important to keep the original filename, you can provide it here. Otherwise, the Frankie service will assign an arbitrary name based on the attachmentId and an extension based on the MIME type.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"document.attachments.items.[INDEX].filename","typeLabel":"string"},"mimeType":{"type":"string","description":"The standard MIME type of the file being uploaded. This will be verified, but providing it can help speed up processing.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].mimeType","typeLabel":"string"},"pageNumber":{"type":"integer","description":"If uploading multiple pages, this can be used to track page numbers. There is no enforcement of these numbers. You can have multiple page 1's or a page 29 if you wish.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].pageNumber","typeLabel":"integer"},"side":{"type":"string","enum":["FRONT","BACK"],"description":"Indicates whether the attachment is the front or back side of a document.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].side","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"General types of valid document attachments.\n - \"PHOTO\": Any photo.\n - \"VIDEO\": Any video.\n - \"AUDIO\": Any audio.\n - \"PDF\": PDF or PS file (may contain text, images, or both).\n - \"DOC\": Word document, RTF, etc.\n - \"ZIP\": Any compressed file(s).","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].type","typeLabel":"string"},"location":{"description":"Reference to where the data can be retrieved from.","type":"string","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].location","typeLabel":"string"},"lastMalwareScanAt":{"type":"string","format":"date-time","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].lastMalwareScanAt","typeLabel":"string\u003cdate-time>"},"retrievalStatus":{"type":"string","readOnly":true,"enum":["NORMAL","EXCLUDED","FAILED"],"description":"The reason why the data in a response is missing.\n\n- \"NORMAL\": The data was retrieved and is included. If it is empty, then\n it was never provided or was provided empty.\n\n- \"EXCLUDED\": The retrieval request was not for 'full' data, or the object\n has been deleted, so the data is not included.\n\n- \"FAILED\": The data could not be retrieved from the secure document\n store.\n\nThe retrievalStatus enum will not usually be set in a request. If an\nattachment in a response has a 'FAILED' retrieval state, then\nthat object should not be sent back in a future update. It should\neither be omitted or the original data should be resent if it is available\nfrom another source. However, it is safe to send the object in an update\nwith the state received in a response. Any state other than 'NORMAL' (or\n'') will cause the blank data to be ignored, but other fields in the\nobject will be updated if needed.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"document.attachments.items.[INDEX].retrievalStatus","typeLabel":"enum\u003cstring>"}},"uniqueKey":"document.attachments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"document.attachments","typeLabel":"object[]"}},"uniqueKey":"document","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"requestId":"01HN9XHZN6MGXM9JXG50K59Q85","entityId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","document":{"type":"OTHER","country":"AUS","class":"IDENTITY","documentId":"92de15f64-5717-4562-b3fc-2c963f6665a7","entityId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","expiryDate":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"issueDate":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"primaryIdentifier":"000734130","secondaryIdentifier":"P0001975","isDigital":true,"isExternallyVerified":true,"subtype":"Photo Comparison","subdivision":"VIC","createdAt":"2024-01-15T02:18:11.365Z","updatedAt":"2025-01-16T02:18:11.365Z","validFrom":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"validTo":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"sourceId":"324f15f64-5717-4562-b3fc-2c963f66ffa1","supplementaryData":{"type":"NATIONAL_HEALTH_ID","reference":"1","nameOnCardLine1":"\u003cstring>","nameOnCardLine2":"\u003cstring>","nameOnCardLine3":"\u003cstring>","nameOnCardLine4":"\u003cstring>","middleNameOnCard":"\u003cstring>"},"customAttributes":{},"attachments":[{"data":{"uri":"https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"},"attachmentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","sourceId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","filename":"\u003cstring>","mimeType":"\u003cstring>","pageNumber":123,"side":"FRONT","type":"\u003cstring>","location":"\u003cstring>","lastMalwareScanAt":"2023-11-07T05:31:56Z","retrievalStatus":"NORMAL"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"e3f84c43-8898-4844-b385-a06cbbb057c1":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid EntityId":{"title":"Invalid EntityId","value":{"errorCode":"API-0400,","errorMsg":"Multiple Errors: See Issues list","details":[{"issue":"entityId in path must be of type uuid: \"test\"","issueLocation":"VALIDATE-entityId"}],"requestId":"01HM5XJ7VASZ3EJMB1VQGTBFJ4"}}},"exampleType":"examples"}},"exampleType":"examples"},"c0bc7072-bb99-4764-b3a3-801f1e96ed47":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid authentication":{"title":"Invalid authentication","value":{"errorCode":"AUTH-0002,","errorMsg":"Unauthorized","details":[{"issue":"Invalid Authentication provided. Access denied.","issueLocation":"request"}],"requestId":"00000000S6MNG7624K2TDXT1E3"}},"No Api-Key":{"title":"No Api-Key","value":{"errorCode":"AUTH-0401","errorMsg":"Unauthorized","details":[{"issue":"No api key provided. Access denied.","issueLocation":"request"}],"requestId":"00000001S6MNG7624K2TDXT1E3"}}},"exampleType":"examples"}},"exampleType":"examples"},"8a47ac38-e24a-466e-a981-45c3cb912acc":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Unable to retrieve entity":{"title":"Unable to retrieve entity","value":{"errorCode":"ENT-1010,","errorMsg":"Unable to retrieve requested entity","details":[{"issue":"entityId","issueLocation":"Cannot retrieve entityId (027d1e3d-95af-f19a-313a-3b869da9ce10)"}],"requestId":"01HM5EM2QNNSC9K0PX9VC06HX3"}}},"exampleType":"examples"}},"exampleType":"examples"},"787de23c-ccb8-48f1-8275-0f6660ef9a5d":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Internal Server Error":{"title":"Internal Server Error","value":{"errorCode":"SYS-1063,","errorMsg":"Failed to generate KYC report","requestId":"01HM5EM2QNNSC9K0PX9VC06HX3"}}},"exampleType":"examples"}},"exampleType":"examples"},"99c1a23e-c7ec-4ef1-98f6-7f2ea0f2d858":{"description":"Bad Gateway","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"},"994a1d04-b789-4115-ae1c-46e5f2bc3a63":{"description":"Service Unavailable","content":{"application/json":{"schema":{"type":"object","x-examples":{"400":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0400","errorMsg":"Parsing credentials from \"\u003cinvalid>\" failed, because invalid.","httpStatusCode":400},"401":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0401","errorMsg":"Unauthenticated due to invalid credentials.","httpStatusCode":401},"409":{"requestId":"0123456789ABCDEFGHIJKLMNOP","errorCode":"API-0409","errorMsg":"Conflict.","httpStatusCode":409}},"properties":{"errorCode":{"type":"string","uniqueKey":"errorCode","typeLabel":"string"},"errorMsg":{"type":"string","uniqueKey":"errorMsg","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"issue":{"type":"string","description":"Description of the issue.","uniqueKey":"details.items.[INDEX].issue","typeLabel":"string"},"issueLocation":{"type":"string","description":"The location or context where the issue was identified.","uniqueKey":"details.items.[INDEX].issueLocation","typeLabel":"string"},"issueType":{"type":"string","description":"The type or category of the issue.","uniqueKey":"details.items.[INDEX].issueType","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","uniqueKey":"requestId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"01bd7e1f-c2c1-403e-b60c-9a5c75dc584f":{"Api-Key":{"type":"apiKey","in":"header","name":"api_key","description":"","scopes":[]}},"054b3e1e-bc9e-4934-8c4e-d57d8b4930a9":{"jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":["kyb:api","write:kyb:api"]}}},"servers":{"6734e950-f09c-4b6e-9778-94aa10d78805":{"url":"https://api.uat.frankie.one","description":"UAT Environment API Base URL"},"a1a8c4fb-5482-49a1-954f-d93fec6f9ad8":{"url":"https://api.frankie.one","description":"Production API Base URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api_key","description":"","scopes":[]},"schema":{"title":"api_key","type":"string","description":"","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Api-Key","name":"api_key"}],"title":"Api-Key"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":["kyb:api","write:kyb:api"]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"jwt","name":"Authorization"}],"title":"jwt"}]},"originalFileLocation":"specs/fc-kyb-bundled_generated.yaml"},"subdomain":"frankieone-f5583b1b","siteName":"frankieone","title":"Create a new document for an organization. - frankieone","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/organization-documents/create-a-new-document-for-an-organization","matchLevel":0},"v1":{"href":"/docs/v1/introduction/getting-started/welcome-to-frankie","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-09-30T05:08:26.736Z","originalFileLocation":"api-reference/organization-documents/create-a-new-document-for-an-organization.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=\"Add a new document to an organization entity.\">\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=\"Create a new document for an organization. - frankieone\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add a new document to an organization entity.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"frankieone\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.frankieone.com/api-reference/organization-documents/create-a-new-document-for-an-organization\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://frankieone-f5583b1b.mintlify.site/_mintlify/api/og/v2?division=Organization+Documents\u0026amp;title=Create+a+new+document+for+an+organization.\u0026amp;description=Add+a+new+document+to+an+organization+entity.\u0026amp;theme=3c4744f86ac72d7d8cd5a2da\u0026amp;signature=b32609bf6db32754f5c323cf83d57b45ea2bb6f2dda5af3c5d09f2048c60b592\">\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=\"Create a new document for an organization. - frankieone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add a new document to an organization entity.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://frankieone-f5583b1b.mintlify.site/_mintlify/api/og/v2?division=Organization+Documents\u0026amp;title=Create+a+new+document+for+an+organization.\u0026amp;description=Add+a+new+document+to+an+organization+entity.\u0026amp;theme=3c4744f86ac72d7d8cd5a2da\u0026amp;signature=b32609bf6db32754f5c323cf83d57b45ea2bb6f2dda5af3c5d09f2048c60b592\">\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/api-reference/organization-documents/create-a-new-document-for-an-organization\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/organization-documents/create-a-new-document-for-an-organization.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/api-reference/organization-documents/create-a-new-document-for-an-organization#webpage\",\"url\":\"https://docs.frankieone.com/api-reference/organization-documents/create-a-new-document-for-an-organization\",\"name\":\"Create a new document for an organization.\",\"description\":\"Add a new document to an organization entity.\",\"dateModified\":\"2026-09-30T05:08:26.736Z\",\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.frankieone.com/api-reference/organization-documents/create-a-new-document-for-an-organization#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.frankieone.com/api-reference/organization-documents/create-a-new-document-for-an-organization#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"KYB V2 API\",\"item\":\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Organization Documents\",\"item\":\"https://docs.frankieone.com/api-reference/organization-documents/get-all-documents-for-an-organization-entity\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a new document for an organization.\",\"item\":\"https://docs.frankieone.com/api-reference/organization-documents/create-a-new-document-for-an-organization\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.frankieone.com/api-reference/organization-documents/create-a-new-document-for-an-organization#apireference\",\"headline\":\"Create a new document for an organization.\",\"name\":\"Create a new document for an organization.\",\"description\":\"Add a new document to an organization entity.\",\"url\":\"https://docs.frankieone.com/api-reference/organization-documents/create-a-new-document-for-an-organization\",\"mainEntityOfPage\":{\"@id\":\"https://docs.frankieone.com/api-reference/organization-documents/create-a-new-document-for-an-organization#webpage\"},\"dateModified\":\"2026-09-30T05:08:26.736Z\",\"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","tabs":[{"tab":"Introduction","icon":"book","pages":[{"title":"Introduction","href":"/v2/introduction/overview"}]},{"tab":"KYC","icon":"user-group","pages":[{"title":"KYC","href":"/docs/frankieone-introduction-to-kyc"}]},{"tab":"KYB","icon":"building","pages":[{"title":"KYB","href":"/docs/introduction-to-kyb"}]},{"tab":"Fraud and Transaction Monitoring","icon":"shield-halved","pages":[{"title":"Fraud and Transaction Monitoring","href":"/v2/docs/tm/fraud-and-transaction-monitoring-introduction"}]},{"tab":"OneSDK","icon":"display-code","pages":[{"title":"OneSDK","href":"/docs/about-onesdk"}]},{"tab":"Portal","icon":"credit-card","pages":[{"title":"Portal","href":"/docs/getting-started-with-the-frankieone-portal"}]},{"tab":"API","icon":"terminal","pages":[{"group":"Introduction","pages":[{"title":"Introduction to FrankieOne API","href":"/v2/api/introduction/introduction-to-frankie-one-api"},{"title":"Authentication","href":"/docs/reference/authentication"},{"group":"Errors","pages":[{"title":"Errors","sidebarTitle":"Overview","href":"/docs/reference/errors"},{"title":"API Error Codes","href":"/docs/reference/error-codes"}]},{"title":"Data Sources Codes","href":"/docs/reference/datasource-codes"},{"title":"UAT Test Data","sidebarTitle":"UAT Test Data","href":"/docs/uat-test-data"},{"title":"API Testing Tips","href":"/v2/api/developers/api-testing-guide"},{"title":"KYC API Enums Reference","href":"/docs/reference/kyc-enums"},{"title":"API endpoints","href":"/docs/reference/api-endpoints"},{"title":"Outbound IP addresses","href":"/docs/reference/outbound-ip-addresses"},{"title":"Risk Factors","sidebarTitle":"Risk Factors","hidden":false,"href":"/docs/risk-factors"},{"title":"Event Notifications \u0026 Webhooks","sidebarTitle":"Webhooks \u0026 Event Notifications","href":"/docs/reference/webhooks"},{"title":"API Versioning","href":"/v2/api/introduction/api-versioning"},{"title":"Resources","href":"/docs/introduction/resources"}]},{"group":"KYC V2 API","pages":[{"group":"Individual Entities","pages":[{"title":"Create an individual entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals","href":"/api-reference/individual-entities/create-an-individual-entity"},{"title":"Get an individual entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}","href":"/api-reference/individual-entities/get-an-individual-entity"},{"title":"Delete an individual entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}","href":"/api-reference/individual-entities/delete-an-individual-entity"},{"title":"Update an individual entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}","href":"/api-reference/individual-entities/update-an-individual-entity"}]},{"group":"Individual Workflows","pages":[{"title":"Get a list of executable workflows","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/workflows","href":"/api-reference/individual-workflows/get-a-list-of-executable-workflows"},{"title":"Create an individual and execute a workflow for the given service profile","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/new/serviceprofiles/{serviceName}/workflows/{workflowName}/execute","href":"/api-reference/individual-workflows/create-an-individual-and-execute-a-workflow-for-the-given-service-profile"},{"title":"Execute a workflow for the given service profile","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute","href":"/api-reference/individual-workflows/execute-a-workflow-for-the-given-service-profile"},{"title":"Evaluate a workflow for the given service profile using existing results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/evaluate","href":"/api-reference/individual-workflows/evaluate-a-workflow-for-the-given-service-profile-using-existing-results"},{"title":"Get a list of executions and their results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions","href":"/api-reference/individual-workflows/get-a-list-of-executions-and-their-results"},{"title":"Get the result of a specific execution by its executionId.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}","href":"/api-reference/individual-workflows/get-the-result-of-a-specific-execution-by-its-executionid"},{"title":"Override the status of a specific workflow execution.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}","href":"/api-reference/individual-workflows/override-the-status-of-a-specific-workflow-execution"}]},{"group":"Individual Profiles","pages":[{"title":"Get a service profile for a given individual entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/serviceprofiles/{serviceName}","href":"/api-reference/individual-profiles/get-a-service-profile-for-a-given-individual-entity"},{"title":"Update a profile for a given individual entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/serviceprofiles/{serviceName}","href":"/api-reference/individual-profiles/update-a-profile-for-a-given-individual-entity"}]},{"group":"Individual Results","pages":[{"title":"Approve Manual KYC for an individual","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/results/mkyc","href":"/api-reference/individual-results/approve-manual-kyc-for-an-individual"},{"title":"Invalidate any Manual KYC evidences of an individual","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/results/mkyc/invalidate","href":"/api-reference/individual-results/invalidate-any-manual-kyc-evidences-of-an-individual"},{"title":"Update the status of AML process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/aml","href":"/api-reference/individual-results/update-the-status-of-aml-process-results"},{"title":"Update the status of IDV process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/idv","href":"/api-reference/individual-results/update-the-status-of-idv-process-results"},{"title":"Update the status of Matchlist process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/matchlist","href":"/api-reference/individual-results/update-the-status-of-matchlist-process-results"},{"title":"Update the status of Duplicate process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/duplicate","href":"/api-reference/individual-results/update-the-status-of-duplicate-process-results"},{"title":"Update the status of Fraud process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/results/fraud","href":"/api-reference/individual-results/update-the-status-of-fraud-process-results"},{"title":"Get a list of process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/results","href":"/api-reference/individual-results/get-a-list-of-process-results"},{"title":"Get a process result","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/results/{processResultId}","href":"/api-reference/individual-results/get-a-process-result"},{"title":"Update the status of a supporting document","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/documents/{documentId}/status","href":"/api-reference/individual-results/update-the-status-of-a-supporting-document"}]},{"group":"Individual Entity Elements","pages":[{"title":"Delete a name","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/names/{nameId}","href":"/api-reference/individual-entity-elements/delete-a-name"},{"title":"Delete a date of birth","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/datesOfBirth/{dateOfBirthId}","href":"/api-reference/individual-entity-elements/delete-a-date-of-birth"},{"title":"Delete an address","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/addresses/{addressId}","href":"/api-reference/individual-entity-elements/delete-an-address"},{"title":"Delete an email address","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/emailaddresses/{emailAddressId}","href":"/api-reference/individual-entity-elements/delete-an-email-address"},{"title":"Delete phone number","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/phonenumbers/{phoneNumberId}","href":"/api-reference/individual-entity-elements/delete-phone-number"},{"title":"Withdraw a previously provided consent","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/consents/{consentType}","href":"/api-reference/individual-entity-elements/withdraw-a-previously-provided-consent"},{"title":"Get a list of external references","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/externalreferences","href":"/api-reference/individual-entity-elements/get-a-list-of-external-references"},{"title":"Delete an external reference","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/externalreferences/{referenceId}","href":"/api-reference/individual-entity-elements/delete-an-external-reference"}]},{"group":"Search","pages":[{"title":"Search for individual profiles","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/search/serviceprofiles","href":"/api-reference/search/search-for-individual-profiles"}]},{"group":"Individual Documents","pages":[{"title":"Get all documents for an entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/documents","href":"/api-reference/individual-documents/get-all-documents-for-an-entity"},{"title":"Create a new document for an individual.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/documents","href":"/api-reference/individual-documents/create-a-new-document-for-an-individual"},{"title":"Get a single document by its id.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml get /v2/individuals/{entityId}/documents/{documentId}","href":"/api-reference/individual-documents/get-a-single-document-by-its-id"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/documents/{documentId}","href":"/api-reference/individual-documents/delete-a-document"},{"title":"Update a single document by its id.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/documents/{documentId}","href":"/api-reference/individual-documents/update-a-single-document-by-its-id"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml delete /v2/individuals/{entityId}/documents/{documentId}/attachments/{attachmentId}","href":"/api-reference/individual-documents/delete-an-attachment"}]},{"group":"Individual Risks","pages":[{"title":"Update an individual entity's risk level for a service profile.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/serviceprofiles/{serviceName}/risk","href":"/api-reference/individual-risks/update-an-individual-entitys-risk-level-for-a-service-profile"}]},{"group":"Monitoring","pages":[{"title":"Turn on/off monitoring for a given entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml patch /v2/individuals/{entityId}/monitor","href":"/api-reference/monitoring/turn-onoff-monitoring-for-a-given-entity"}]},{"group":"IDV","pages":[{"title":"Get an IDV Token for the given individual.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/actions/idv/token","href":"/api-reference/idv/get-an-idv-token-for-the-given-individual"},{"title":"Submit an identity document photo for ocr processing. Results will be in the form of an identity document with populated with ocr results.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/actions/idv/ocr","href":"/api-reference/idv/submit-an-identity-document-photo-for-ocr-processing-results-will-be-in-the-form-of-an-identity-document-with-populated-with-ocr-results"},{"title":"At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/actions/idv/process","href":"/api-reference/idv/at-the-end-of-the-idv-data-capture-process-with-all-photos-and-videos-captured-signal-to-idv-provider-that-check-is-ready-to-analyse-and-check"},{"title":"At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/{entityId}/actions/idv/checkstatus","href":"/api-reference/idv/at-the-end-of-the-idv-data-capture-process-with-all-photos-and-videos-captured-signal-to-idv-provider-that-check-is-ready-to-analyse-and-check-1"}]},{"group":"HostedURL","pages":[{"title":"Provide hosted url for a hosted version of onesdk.","deprecated":null,"version":null,"openapi":"/specs/fc-kyc-bundled_generated.yaml post /v2/individuals/hostedurl","href":"/api-reference/hostedurl/provide-hosted-url-for-a-hosted-version-of-onesdk"}]}]},{"group":"Transaction and Activity Monitoring V2 API","pages":[{"group":"Activities","pages":[{"title":"Evaluate an activity","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml post /v2/activities","href":"/api-reference/activities/evaluate-an-activity"},{"title":"Classify activities","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml post /v2/activities/classify","href":"/api-reference/activities/classify-activities"},{"title":"Get Individual Activities","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml get /v2/individuals/{entityId}/activities","href":"/api-reference/activities/get-individual-activities"},{"title":"Get Organization Activities","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml get /v2/organizations/{entityId}/activities","href":"/api-reference/activities/get-organization-activities"}]},{"group":"Results","pages":[{"title":"Update Results","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml patch /v2/individuals/{entityId}/results/activity","href":"/api-reference/results/update-results"},{"title":"Update Organization Results","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml patch /v2/organizations/{entityId}/results/activity","href":"/api-reference/results/update-organization-results"}]},{"group":"Sessions","pages":[{"title":"Create Individual Session.\n","deprecated":null,"version":null,"openapi":"/specs/fc-act-bundled_generated.yaml post /v2/individuals/{entityId}/sessions","href":"/api-reference/sessions/create-individual-session"}]}]},{"group":"KYB V2 API","pages":[{"group":"Organizations","pages":[{"title":"Lookup organizations","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/lookup","href":"/api-reference/organizations/lookup-organizations"},{"title":"Get an organization entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}","href":"/api-reference/organizations/get-an-organization-entity"},{"title":"Delete an organization entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}","href":"/api-reference/organizations/delete-an-organization-entity"},{"title":"Update basic attributes of an organization entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}","href":"/api-reference/organizations/update-basic-attributes-of-an-organization-entity"},{"title":"Create an organization entity","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations","href":"/api-reference/organizations/create-an-organization-entity"}]},{"group":"Organization Workflows","pages":[{"title":"Execute a workflow with organization details","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/workflows/{workflowName}/execute","href":"/api-reference/organization-workflows/execute-a-workflow-with-organization-details"},{"title":"Execute a workflow for the given orgnaization entityId","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute","href":"/api-reference/organization-workflows/execute-a-workflow-for-the-given-orgnaization-entityid"},{"title":"Evaluate a workflow for the given organization entityId using existing results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/evaluate","href":"/api-reference/organization-workflows/evaluate-a-workflow-for-the-given-organization-entityid-using-existing-results"},{"title":"Get the result of a specific execution by its executionId","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}","href":"/api-reference/organization-workflows/get-the-result-of-a-specific-execution-by-its-executionid"},{"title":"Get a list of executions and their results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions","href":"/api-reference/organization-workflows/get-a-list-of-executions-and-their-results"}]},{"group":"Organization Results","pages":[{"title":"Get a list of process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/results","href":"/api-reference/organization-results/get-a-list-of-process-results"},{"title":"Get a process result","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/results/{processResultId}","href":"/api-reference/organization-results/get-a-process-result"},{"title":"Update the status of AML process results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/results/aml","href":"/api-reference/organization-results/update-the-status-of-aml-process-results"}]},{"group":"Organization Profiles","pages":[{"title":"Get a service profile for a given organization entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/serviceprofiles/{serviceName}","href":"/api-reference/organization-profiles/get-a-service-profile-for-a-given-organization-entity"},{"title":"Update a profile for a given organization entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/serviceprofiles/{serviceName}","href":"/api-reference/organization-profiles/update-a-profile-for-a-given-organization-entity"}]},{"group":"Organization Documents","pages":[{"title":"Get all documents for an organization entity","description":"Get all documents for an organization entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/documents","href":"/api-reference/organization-documents/get-all-documents-for-an-organization-entity"},{"title":"Create a new document for an organization.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/documents","href":"/api-reference/organization-documents/create-a-new-document-for-an-organization"},{"title":"Get a single document by its id.","description":"Get a single document by its id for an organization entity.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}","href":"/api-reference/organization-documents/get-a-single-document-by-its-id"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/documents/{documentId}","href":"/api-reference/organization-documents/delete-a-document"},{"title":"Update a single document by its id.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/documents/{documentId}","href":"/api-reference/organization-documents/update-a-single-document-by-its-id"},{"title":"Get trust analyses results for a document","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}/analyses","href":"/api-reference/organization-documents/get-trust-analyses-results-for-a-document"},{"title":"Confirm a trust analysis result for a document","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/{entityId}/documents/{documentId}/analyses/{analysisId}/confirm","href":"/api-reference/organization-documents/confirm-a-trust-analysis-result-for-a-document"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}","href":"/api-reference/organization-documents/delete-an-attachment"}]},{"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":"Organization Risks","pages":[{"title":"Update an organization entity's risk level for a service profile.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/serviceprofiles/{serviceName}/risk","href":"/api-reference/organization-risks/update-an-organization-entitys-risk-level-for-a-service-profile"}]},{"group":"Organization Relationships","pages":[{"title":"Get all manually added relationships for organization","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml get /v2/organizations/{entityId}/relationships","href":"/api-reference/organization-relationships/get-all-manually-added-relationships-for-organization"},{"title":"Add or update relationships for an organization","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml put /v2/organizations/{entityId}/relationships","href":"/api-reference/organization-relationships/add-or-update-relationships-for-an-organization"},{"title":"Delete relationships for an organization","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/relationships","href":"/api-reference/organization-relationships/delete-relationships-for-an-organization"}]},{"group":"Organization Addresses","pages":[{"title":"Delete an address","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/addresses/{addressId}","href":"/api-reference/organization-addresses/delete-an-address"}]},{"group":"Organization Custom Attributes","pages":[{"title":"Delete a custom attribute","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/customattributes/{key}","href":"/api-reference/organization-custom-attributes/delete-a-custom-attribute"}]},{"group":"Organization External References","pages":[{"title":"Delete an organization external reference","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml delete /v2/organizations/{entityId}/externalreferences/{referenceId}","href":"/api-reference/organization-external-references/delete-an-organization-external-reference"}]},{"group":"Organization Monitoring","pages":[{"title":"Turn on/off monitoring for a given organization","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml patch /v2/organizations/{entityId}/monitor","href":"/api-reference/organization-monitoring/turn-onoff-monitoring-for-a-given-organization"}]}]},{"group":"Core V2 API","pages":[{"group":"Audit","pages":[{"title":"List audit events","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/audit","href":"/api-reference/audit/list-audit-events"}]},{"group":"Comments","pages":[{"title":"Add a comment to an object","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/comments","href":"/api-reference/comments/add-a-comment-to-an-object"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/tags","href":"/api-reference/tags/list-tags"},{"title":"List tags objects","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/tags/objects","href":"/api-reference/tags/list-tags-objects"},{"title":"Remove tag objects","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/tags/objects/remove","href":"/api-reference/tags/remove-tag-objects"}]},{"group":"Workflows","pages":[{"title":"Get a list of executable workflows","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/workflows","href":"/api-reference/workflows/get-a-list-of-executable-workflows"},{"title":"Update Workflow Information","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml patch /v2/workflows/{workflowId}","href":"/api-reference/workflows/update-workflow-information"}]},{"group":"Workflow Definitions","pages":[{"title":"Create or update a workflow definition","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml put /v2/workflowDefinitions/{workflowDefinitionId}","href":"/api-reference/workflow-definitions/create-or-update-a-workflow-definition"}]},{"group":"Search","pages":[{"title":"Search for profiles","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/search/serviceprofiles","href":"/api-reference/search/search-for-profiles"}]},{"group":"Matchlists","pages":[{"title":"Search for matchlist entries","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/search/matchlists","href":"/api-reference/matchlists/search-for-matchlist-entries"},{"title":"Retrieve a list of matchlist details","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/matchlists","href":"/api-reference/matchlists/retrieve-a-list-of-matchlist-details"},{"title":"Get a list of matchlist entries","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/matchlists/{matchlistName}/entries","href":"/api-reference/matchlists/get-a-list-of-matchlist-entries"},{"title":"Create one or more entries in a matchlist","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/matchlists/{matchlistName}/entries","href":"/api-reference/matchlists/create-one-or-more-entries-in-a-matchlist"},{"title":"Retrieve a matchlist entry","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/matchlists/{matchlistName}/entries/{entryId}","href":"/api-reference/matchlists/retrieve-a-matchlist-entry"},{"title":"Modify a matchlist entry","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml patch /v2/matchlists/{matchlistName}/entries/{entryId}","href":"/api-reference/matchlists/modify-a-matchlist-entry"},{"title":"Add an individual entity to a matchlist","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/matchlists/{matchlistName}/entries/addEntity","href":"/api-reference/matchlists/add-an-individual-entity-to-a-matchlist"},{"title":"Remove an individual entity matchlist","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml patch /v2/matchlists/{matchlistName}/entries/removeEntity","href":"/api-reference/matchlists/remove-an-individual-entity-matchlist"}]},{"group":"Results","pages":[{"title":"Redact Process Result","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/results/{entityId}/processes/{processResultId}/redact","href":"/api-reference/results/redact-process-result"}]},{"group":"Reports","pages":[{"title":"List Extract PII jobs","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml get /v2/report/extractPII","href":"/api-reference/reports/list-extract-pii-jobs"},{"title":"Extract PII report","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/report/extractPII","href":"/api-reference/reports/extract-pii-report"},{"title":"Download Extract PII files","deprecated":null,"version":null,"openapi":"/specs/fc-core-bundled_generated.yaml post /v2/report/extractPII/download","href":"/api-reference/reports/download-extract-pii-files"}]}]}]},{"tab":"Implementations","icon":"play","pages":[{"title":"Implementations","href":"/v2/api/developers/frankie-one-key-terms"}]},{"tab":"Release Notes","icon":"code","pages":[{"title":"Release Notes","href":"/docs/release-notes"}]}]},{"version":"v1","pages":[{"title":"v1","href":"/docs/v1/introduction/getting-started/welcome-to-frankie"}]}]},"basePath":"","title":"Create a new document for an organization. - frankieone","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}