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.
Body
application/json
An organization name or a number needs to be provided with region information to lookup in the specific jurisidiction.
Contains the criteria used to lookup for organizations.
Contains the criteria used to lookup for organizations.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://www.mintlify.com/docs.json","name":"frankieone","colors":{"primary":"#1A6CFF","light":"#1A6CFF","dark":"#1A6CFF"},"logo":{"light":"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/light.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=21923909c20fa1b38b317371ccac6e33","dark":"https://mintcdn.com/frankieone-f5583b1b/xa9j0sUrNjbbzTyf/logo/dark.svg?fit=max\u0026auto=format\u0026n=xa9j0sUrNjbbzTyf\u0026q=85\u0026s=196c598869b49c924efc8e44399fda09","href":"https://docs.frankieone.com"},"favicon":"https://mintcdn.com/frankieone-f5583b1b/cNmgsKD2V0ccWp6T/favicon.png?fit=max\u0026auto=format\u0026n=cNmgsKD2V0ccWp6T\u0026q=85\u0026s=82de5d057bc772d870f18df413b453f9","appearance":{"default":"system","strict":false},"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":"6af3966e56004079c2c7d994","clientVersion":"0.0.4102","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":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"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/organizations/lookup-organizations","slug":"/api-reference/organizations/lookup-organizations","pageMetadata":{"title":"Lookup organizations","description":"Lookup for a given business name or business number across business registries.\n\nThe lookup will return a list of matching companies that you can then\npotentially run workflows on.\n\nEach lookup result will have a organizationToken that you can use to create an organization or run workflows on\n\nNote: This process will not save any details from the lookup results.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/lookup","href":"/api-reference/organizations/lookup-organizations","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Lookup for a given business name or business number across business registries.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The lookup will return a list of matching companies that you can then\\npotentially run workflows on.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Each lookup result will have a organizationToken that you can use to create an organization or run workflows on\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Note: This process will not save any details from the lookup results.\"\n })]\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":"Lookup organizations","description":"Lookup for a given business name or business number across business registries.\n\nThe lookup will return a list of matching companies that you can then\npotentially run workflows on.\n\nEach lookup result will have a organizationToken that you can use to create an organization or run workflows on\n\nNote: This process will not save any details from the lookup results.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-bundled_generated.yaml post /v2/organizations/lookup","href":"/api-reference/organizations/lookup-organizations","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Lookup organizations","tags":["Organizations"],"responses":{"200":"ffe9144d-5f60-461e-93ec-708611f399db","400":"f4e85737-8e82-482e-b7f3-5a835bc57415","401":"aad5fd40-80db-4b28-8c62-1b82ef7f04bd","403":"9ad8d539-49eb-44ff-80e9-141a96c37269","404":"05c96cbb-3eed-4ccb-86e9-f2073807e8c1","422":"69659c67-bb96-487a-9dc5-dee0c53d3b82","500":"cdc06629-9c29-4f00-8958-3cff4d694d5e","503":"440240d3-fc94-42ea-810c-ac7353295f8d"},"operationId":"lookupOrganizations","description":"Lookup for a given business name or business number across business registries.\n\nThe lookup will return a list of matching companies that you can then\npotentially run workflows on.\n\nEach lookup result will have a organizationToken that you can use to create an organization or run workflows on\n\nNote: This process will not save any details from the lookup results.","parameters":["11f5f81e-f9c6-4612-997d-ae642dc401c7","824c679d-9304-49bd-b3c7-0474663c52bf","64275df6-2d2e-48aa-b679-15956fe5ad46","c9707070-cc15-4f57-bfd7-8f170c8bac01"],"requestBody":"1ccb9cfa-90ad-4555-bf33-4306d2474fa6","method":"post","type":"path","servers":["6734e950-f09c-4b6e-9778-94aa10d78805","a1a8c4fb-5482-49a1-954f-d93fec6f9ad8"],"security":["4a579483-8bec-4d06-b119-ec6f197e55ff"],"path":"/v2/organizations/lookup","baseUrlOptions":["https://api.uat.frankie.one","https://api.frankie.one"],"title":"Lookup organizations","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"11f5f81e-f9c6-4612-997d-ae642dc401c7":{"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},"824c679d-9304-49bd-b3c7-0474663c52bf":{"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"},"64275df6-2d2e-48aa-b679-15956fe5ad46":{"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"},"c9707070-cc15-4f57-bfd7-8f170c8bac01":{"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."}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Contains the criteria used to lookup for organizations.","properties":{"region":{"type":"object","required":["country"],"properties":{"country":{"type":"string","description":"The ISO-3166-1 country. You must use the alpha3 country code (e.g.\nAUS, USA, IDR, KOR, etc). \n\nFor more details refer to: [https://en.wikipedia.org/wiki/ISO_3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)","isRequired":true,"uniqueKey":"region.country","typeLabel":"string"},"subdivision":{"type":"string","description":"The ISO-3166-2 subdivision code referring to state or province or other regional division. \n\nFor more details refer to: [https://en.wikipedia.org/wiki/ISO_3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)","uniqueKey":"region.subdivision","typeLabel":"string"}},"isRequired":true,"uniqueKey":"region","typeLabel":"object"},"organizationName":{"type":"string","description":"The name of the organization that we are looking up for","uniqueKey":"organizationName","typeLabel":"string"},"organizationNumber":{"type":"object","required":["registrationNumber"],"properties":{"registrationNumber":{"type":"string","description":"The registration number of the specific registry the organization is registered in","isRequired":true,"uniqueKey":"organizationNumber.registrationNumber","typeLabel":"string"},"registryCode":{"type":"string","description":"A code that specifies an associated registry\nex - ABN or ACN","uniqueKey":"organizationNumber.registryCode","typeLabel":"string"}},"uniqueKey":"organizationNumber","typeLabel":"object"}},"required":["region"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"region":{"country":"\u003cstring>","subdivision":"\u003cstring>"},"organizationName":"\u003cstring>"}}},"exampleType":"generated"}},"description":"An organization name or a number needs to be provided with region information to lookup in the specific jurisidiction.","exampleType":"generated"},"responses":{"ffe9144d-5f60-461e-93ec-708611f399db":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["requestId","matchedOrganizations","queryDetails"],"properties":{"requestId":{"type":"string","example":"01HN9XHZN6MGXM9JXG50K59Q85","description":"The unique request identifier for the API call made.","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"matchedOrganizations":{"description":"An array of organizations matching the provided lookup criteria","type":"array","items":{"type":"object","required":["organizationToken","organizationName","country"],"properties":{"organizationToken":{"type":"string","description":"This is the unique Frankie token that contains all the information required from lookup that are needed in succeeding steps","isRequired":true,"uniqueKey":"matchedOrganizations.items.[INDEX].organizationToken","typeLabel":"string"},"country":{"type":"string","description":"The ISO-3166-1 country. You must use the alpha3 country code (e.g.\nAUS, USA, IDR, KOR, etc). \n\nFor more details refer to: [https://en.wikipedia.org/wiki/ISO_3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)","isRequired":true,"uniqueKey":"matchedOrganizations.items.[INDEX].country","typeLabel":"string"},"type":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].type.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].type.description","typeLabel":"string"}},"description":"This is to indicate the type or legal form of an organization as described by the registry. Ex Limtied, Trusts etc.","uniqueKey":"matchedOrganizations.items.[INDEX].type","typeLabel":"object"},"addresses":{"description":"This will contain all the addresses related to the organization as found in the registry","type":"array","items":{"type":"object","description":"Address information in all available formats","required":["country"],"properties":{"country":{"type":"string","description":"The ISO-3166-1 country code. You must use the alpha-3 country code (e.g., AUS, USA, IDR, KOR, etc). Conversion will be handled as needed.\nFor more details, refer to: https://en.wikipedia.org/wiki/ISO_3166-1","x-oapi-codegen-extra-tags":{"audit":"keep"},"isRequired":true,"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].country","typeLabel":"string"},"addressId":{"type":"string","description":"As addresses are added to an entity, they are assigned an ID to assist with tracking.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].addressId","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time the address was last updated. ISO 8601 format.","uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"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":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].sourceId","typeLabel":"string"},"type":{"type":"string","default":"OTHER","enum":["OTHER","RESIDENTIAL","BUSINESS","POSTAL","REGISTERED_OFFICE","PLACE_OF_BUSINESS","OFFICIAL_CORRESPONDANCE","PLACE_OF_BIRTH","OFFICE_LOCALITY","AUTHORITATIVE_RESIDENTIAL","REFORMATTED","ENRICHED"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"description":"Used to indicate what sort of address this is, such as residential, business, postal, etc. Should be used in conjunction with the status field to indicate the current status of the address and provide more context.","uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"typeDescription":{"type":"string","description":"Description for the type or the address type as fetched from an authoritative source like a company registry.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].typeDescription","typeLabel":"string"},"validFrom":{"type":"object","description":"The date this address first became active. Used mostly with business addresses.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].validFrom.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].validFrom.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].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":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].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":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].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":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].validFrom.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].validFrom","typeLabel":"object"},"validTo":{"type":"object","description":"The date this address was no longer used (if available). Used mostly with business addresses.","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].validTo.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].validTo.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].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":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].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":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].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":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].validTo.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].validTo","typeLabel":"object"},"longForm":{"type":"string","description":"In some cases, the address will need to be supplied in \"long form\", such as when it is determined from a document scan, or is unparsable in some way.\nThe service will attempt to convert it to its constituent parts where possible.\nWARNING: Use of longForm is not guaranteed to produce perfect results, due to the variety of potential formats. You have been warned.\nFailure to break down or disambiguate the address will result in an error.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].longForm","typeLabel":"string"},"unitNumber":{"type":"string","description":"Unit/Apartment/Flat/Suite/etc. number","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].unitNumber","typeLabel":"string"},"buildingName":{"type":"string","description":"The name of the building, apartment block, condominium, etc.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].buildingName","typeLabel":"string"},"streetName":{"type":"string","description":"The name of the street.\nThis field should ideally contain only the street name, without the street number or street type. In some cases, especially when auto-populated by external services (e.g., Google), it may include additional address components.\nFor best results, keep the street name separate from the street number and street type. See https://docs.frankieone.com/docs/working-with-addresses for more details.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].streetName","typeLabel":"string"},"streetNumber":{"type":"string","description":"The number assigned to the property on the street. Typically a number, but can also be alphanumeric (e.g., 3A).","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].streetNumber","typeLabel":"string"},"streetType":{"type":"string","description":"The street type, such as Road, Street, Avenue, Circuit, etc.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].streetType","typeLabel":"string"},"neighborhood":{"type":"string","description":"The neighborhood or suburb within the town or city. Use this only if you require both a suburb and a locality/town/city; otherwise, use the \"locality\" parameter.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].neighborhood","typeLabel":"string"},"locality":{"type":"string","description":"The locality, town, village, suburb, or city.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].locality","typeLabel":"string"},"district":{"type":"string","description":"The district, region, county, province, or cantonment.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].district","typeLabel":"string"},"subdivision":{"type":"string","description":"The administrative area, state, or sub-division. Use local abbreviations, such as VIC (Victoria) or TX (Texas).","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].subdivision","typeLabel":"string"},"postalCode":{"type":"string","description":"The postal code of the address.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].postalCode","typeLabel":"string"},"careOf":{"type":"string","description":"The individual or business name at this address, if different from the name of the entity to which this address belongs.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].careOf","typeLabel":"string"},"status":{"type":"string","default":"CURRENT","enum":["CURRENT","PREVIOUS","FUTURE"],"x-oapi-codegen-extra-tags":{"audit":"keep"},"description":"The status of the address information, such as current, previous, or future. Should be used in conjunction with the `type` field to indicate the type of the address and provide more context.","uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"unstructuredLongForm":{"type":"string","description":"Raw, unformatted address as provided by the source. Not normalized or standardized.","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX].unstructuredLongForm","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"matchedOrganizations.items.[INDEX].addresses","typeLabel":"object[]"},"registrationDetails":{"description":"This will contain a list of different registries the organization is registered in","type":"array","items":{"type":"object","required":["registrationNumber"],"properties":{"registrationNumber":{"description":"The registration number of the organization in the registry","type":"string","isRequired":true,"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationNumber","typeLabel":"string"},"registry":{"description":"Registry the organization is registered at","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registry","typeLabel":"string"},"registryDescription":{"description":"The description of the registry","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registryDescription","typeLabel":"string"},"type":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].type.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].type.description","typeLabel":"string"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].type.sourceId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].type","typeLabel":"object"},"class":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].class.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].class.description","typeLabel":"string"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].class.sourceId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].class","typeLabel":"object"},"subClass":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].subClass.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].subClass.description","typeLabel":"string"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].subClass.sourceId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].subClass","typeLabel":"object"},"subType":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].subType.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].subType.description","typeLabel":"string"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].subType.sourceId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].subType","typeLabel":"object"},"status":{"type":"object","properties":{"normalized":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].status.normalized.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].status.normalized.description","typeLabel":"string"}},"description":"normalized status form","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].status.normalized","typeLabel":"object"},"unstructured":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].status.unstructured.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].status.unstructured.description","typeLabel":"string"}},"description":"raw status form","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].status.unstructured","typeLabel":"object"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].status.sourceId","typeLabel":"string"}},"description":"The status of the organization based on its primary registry","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].status","typeLabel":"object"},"isCurrent":{"description":"Indicates that the registration is current","type":"boolean","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].isCurrent","typeLabel":"boolean"},"registeredName":{"type":"object","properties":{"name":{"description":"The organization's name","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.name","typeLabel":"string"},"type":{"description":"The type of name","type":"string","enum":["PRIMARY","OTHER","TRADING_NAME","BUSINESS_NAME","REGISTERED_NAME","NAME_IN_ENGLISH"],"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.type","typeLabel":"enum\u003cstring>"},"validFrom":{"type":"object","description":"The date from which this name will be in effect","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.validFrom.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.validFrom.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.validFrom.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.validFrom","typeLabel":"object"},"validTo":{"type":"object","description":"The date until which this name will be in effect","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.validTo.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.validTo.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.validTo.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.validTo","typeLabel":"object"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName.sourceId","typeLabel":"string"}},"description":"The name of organization in the registry","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName","typeLabel":"object"},"registeredDate":{"type":"object","description":"The date the organization was registered on","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredDate.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredDate.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredDate.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredDate","typeLabel":"object"},"extractedDate":{"type":"object","description":"The date when the organization details were extracted from the registry","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].extractedDate.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].extractedDate.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].extractedDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].extractedDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].extractedDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].extractedDate.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].extractedDate","typeLabel":"object"},"registeredSubdivision":{"description":"The subdivision that the organization was registered at. The registered state for jurisdictions like Australia will be available in this field.","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredSubdivision","typeLabel":"string"},"registeredCountry":{"description":"The country that the organization was registered at","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredCountry","typeLabel":"string"},"registrationStatus":{"type":"object","properties":{"normalized":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationStatus.normalized.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationStatus.normalized.description","typeLabel":"string"}},"description":"normalized status form","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationStatus.normalized","typeLabel":"object"},"unstructured":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationStatus.unstructured.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationStatus.unstructured.description","typeLabel":"string"}},"description":"raw status form","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationStatus.unstructured","typeLabel":"object"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationStatus.sourceId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationStatus","typeLabel":"object"},"registrationNumberType":{"description":"The type of the registration number, e.g. ACN, ABN, etc.","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationNumberType","typeLabel":"string"},"registrationNumberDescription":{"description":"The description of type of the registration number, e.g. Australian Company Number, Australian Business Number, etc.","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registrationNumberDescription","typeLabel":"string"},"updatedDate":{"type":"object","description":"The date on which the registration was last updated","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].updatedDate.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].updatedDate.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].updatedDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].updatedDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].updatedDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].updatedDate.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].updatedDate","typeLabel":"object"},"reviewDate":{"type":"object","description":"The future date when the registration needs to be reviewed","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].reviewDate.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].reviewDate.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].reviewDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].reviewDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].reviewDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].reviewDate.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].reviewDate","typeLabel":"object"},"foundationDate":{"type":"object","description":"In some registries the foundation date (when the organization was registered or founded) is provided","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].foundationDate.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].foundationDate.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].foundationDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].foundationDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].foundationDate.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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].foundationDate.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].foundationDate","typeLabel":"object"},"isSuppressed":{"description":"Denotes whether the information in the registry is suppressed","type":"boolean","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].isSuppressed","typeLabel":"boolean"},"validFrom":{"type":"object","description":"The date on which the registration started","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].validFrom.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].validFrom.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].validFrom.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].validFrom","typeLabel":"object"},"validTo":{"type":"object","description":"The date on which the registration ended","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].validTo.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].validTo.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].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":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].validTo.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].validTo","typeLabel":"object"},"governance":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].governance.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].governance.description","typeLabel":"string"}},"description":"The governance structure of the organization.","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].governance","typeLabel":"object"},"sourceId":{"type":"string","description":"The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].sourceId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails","typeLabel":"object[]"},"alternateNames":{"description":"This will contain all the other names apart from the registered name of the organization. Examples - name in other languages, trading name, older names, etc","type":"array","items":{"type":"object","properties":{"name":{"description":"The organization's name","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].name","typeLabel":"string"},"type":{"description":"The type of name","type":"string","enum":["PRIMARY","OTHER","TRADING_NAME","BUSINESS_NAME","REGISTERED_NAME","NAME_IN_ENGLISH"],"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"validFrom":{"type":"object","description":"The date from which this name will be in effect","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].validFrom.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].validFrom.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].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":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].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":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].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":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].validFrom.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].validFrom","typeLabel":"object"},"validTo":{"type":"object","description":"The date until which this name will be in effect","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].validTo.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].validTo.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].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":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].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":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].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":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].validTo.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].validTo","typeLabel":"object"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].sourceId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX]","typeLabel":"object"},"uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames","typeLabel":"object[]"},"name":{"type":"object","properties":{"name":{"description":"The organization's name","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].name.name","typeLabel":"string"},"type":{"description":"The type of name","type":"string","enum":["PRIMARY","OTHER","TRADING_NAME","BUSINESS_NAME","REGISTERED_NAME","NAME_IN_ENGLISH"],"uniqueKey":"matchedOrganizations.items.[INDEX].name.type","typeLabel":"enum\u003cstring>"},"validFrom":{"type":"object","description":"The date from which this name will be in effect","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].name.validFrom.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].name.validFrom.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].name.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":"matchedOrganizations.items.[INDEX].name.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":"matchedOrganizations.items.[INDEX].name.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":"matchedOrganizations.items.[INDEX].name.validFrom.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].name.validFrom","typeLabel":"object"},"validTo":{"type":"object","description":"The date until which this name will be in effect","properties":{"year":{"type":"string","description":"Year in \"YYYY\" format.","example":"1990","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].name.validTo.year","typeLabel":"string"},"month":{"type":"string","description":"Month in \"MM\" format.","example":"03","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].name.validTo.month","typeLabel":"string"},"day":{"type":"string","description":"Day in \"DD\" format.","example":"27","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].name.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":"matchedOrganizations.items.[INDEX].name.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":"matchedOrganizations.items.[INDEX].name.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":"matchedOrganizations.items.[INDEX].name.validTo.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].name.validTo","typeLabel":"object"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].name.sourceId","typeLabel":"string"}},"description":"The name as registered in the primary registry of the organization","uniqueKey":"matchedOrganizations.items.[INDEX].name","typeLabel":"object"},"status":{"type":"object","properties":{"normalized":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].status.normalized.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].status.normalized.description","typeLabel":"string"}},"description":"normalized status form","uniqueKey":"matchedOrganizations.items.[INDEX].status.normalized","typeLabel":"object"},"unstructured":{"type":"object","properties":{"code":{"description":"Short standard code or normalized representation of the information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].status.unstructured.code","typeLabel":"string"},"description":{"description":"The information relevant to the code, could be a more descriptive information","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].status.unstructured.description","typeLabel":"string"}},"description":"raw status form","uniqueKey":"matchedOrganizations.items.[INDEX].status.unstructured","typeLabel":"object"},"sourceId":{"type":"string","description":"Where specific information was sourced. This is a reference to an informationSource object in the informationSources map.","uniqueKey":"matchedOrganizations.items.[INDEX].status.sourceId","typeLabel":"string"}},"description":"The status based on the primary registry the organization is registered in","uniqueKey":"matchedOrganizations.items.[INDEX].status","typeLabel":"object"},"phoneNumbers":{"type":"array","items":{"type":"object","properties":{"phoneNumberId":{"type":"string","description":"As phone numbers are added to an entity, they are assigned an ID to assist with tracking.\nIf you are adjusting phone numbers, you will need to include the ID to reference it correctly in the list.","example":"ad165f64-5717-4562-b3fc-2c963f66bfa9","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].phoneNumberId","typeLabel":"string"},"isPreferred":{"type":"boolean","example":true,"description":"Indicates whether this is the individual's preferred phone number.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].isPreferred","typeLabel":"boolean"},"type":{"type":"string","enum":["OTHER","WORK","HOME","MOBILE","BUSINESS","FAX"],"description":"The type of phone number.","example":"MOBILE","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"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":"14fd5f64-5717-4562-b3fc-2c963f66ba34","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].sourceId","typeLabel":"string"},"country":{"type":"string","description":"ISO-3166-1 alpha-3 country code.","example":"AUS","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].country","typeLabel":"string"},"number":{"type":"string","description":"The phone number.","example":"0426192340","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].number","typeLabel":"string"},"linkedAddresses":{"type":"array","readOnly":true,"description":"If the phone number is attached to one or more addresses, the address IDs of those addresses will be present.","items":{"type":"object","properties":{"addressId":{"description":"The addressId of the linked address.","type":"string","example":"fa335f64-5717-4562-b3fc-2c963f66cf41","uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].linkedAddresses.items.[INDEX].addressId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].linkedAddresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].linkedAddresses","typeLabel":"object[]"},"unstructuredLongForm":{"type":"string","description":"Used to capture free-form phone numbers or to store numbers that could not be normalized.","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].unstructuredLongForm","typeLabel":"string"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time the phone number was last updated. ISO 8601 format.","uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"matchedOrganizations.items.[INDEX].phoneNumbers","typeLabel":"object[]"},"emailAddresses":{"type":"array","items":{"type":"object","properties":{"emailAddressId":{"type":"string","description":"As email addresses are added to an entity, they are assigned a unique identifier to assist with modification and reference.\nTo modify an email, include the emailId in an update request.","example":"aa385f64-5717-4562-b3fc-2c963f66af21","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX].emailAddressId","typeLabel":"string"},"type":{"type":"string","enum":["OTHER","WORK","PERSONAL","BUSINESS"],"example":"WORK","description":"The type of email address, if known.","x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"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":"31dd15f64-5717-4562-b3fc-2c963f66234d","readOnly":true,"x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX].sourceId","typeLabel":"string"},"email":{"type":"string","description":"The individual's email address. This email can be used to notify the individual of any verification requirements.","example":"leonardo_dc@outlook.com","x-oapi-codegen-extra-tags":{"audit":"mask"},"uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX].email","typeLabel":"string"},"isPreferred":{"type":"boolean","description":"Indicates whether this email address is the individual's preferred email. The preferred email will be used to send notifications at the client's request.","default":true,"x-oapi-codegen-extra-tags":{"audit":"keep"},"uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX].isPreferred","typeLabel":"boolean"},"linkedAddresses":{"type":"array","readOnly":true,"description":"If the email is attached to one or more addresses, the address IDs of those addresses will be present.","items":{"type":"object","properties":{"addressId":{"description":"The addressId of the linked address.","type":"string","example":"adc215f64-5717-4562-b3fc-2c963f66222a","uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX].linkedAddresses.items.[INDEX].addressId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX].linkedAddresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX].linkedAddresses","typeLabel":"object[]"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time the email address was last updated. ISO 8601 format.","uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"matchedOrganizations.items.[INDEX].emailAddresses","typeLabel":"object[]"},"websiteUrls":{"type":"array","items":{"title":"Website URL","type":"object","properties":{"websiteUrl":{"type":"string","description":"The website URL.","uniqueKey":"matchedOrganizations.items.[INDEX].websiteUrls.items.[INDEX].websiteUrl","typeLabel":"string"},"sourceId":{"type":"string","description":"Reference to the information source where this data was obtained.\nThis should correspond to an informationSource object in the informationSources map.\n","uniqueKey":"matchedOrganizations.items.[INDEX].websiteUrls.items.[INDEX].sourceId","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX].websiteUrls.items.[INDEX]","typeLabel":"Website URL · object"},"uniqueKey":"matchedOrganizations.items.[INDEX].websiteUrls","typeLabel":"Website URL · object[]"},"subdivision":{"type":"string","description":"The ISO-3166-2 subdivision code referring to state or province or other regional division. \n\nFor more details refer to: [https://en.wikipedia.org/wiki/ISO_3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)","uniqueKey":"matchedOrganizations.items.[INDEX].subdivision","typeLabel":"string"}},"uniqueKey":"matchedOrganizations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"matchedOrganizations","typeLabel":"object[]"},"queryDetails":{"type":"object","description":"Contains the criteria used to lookup for organizations.","properties":{"region":{"type":"object","required":["country"],"properties":{"country":{"type":"string","description":"The ISO-3166-1 country. You must use the alpha3 country code (e.g.\nAUS, USA, IDR, KOR, etc). \n\nFor more details refer to: [https://en.wikipedia.org/wiki/ISO_3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)","isRequired":true,"uniqueKey":"queryDetails.region.country","typeLabel":"string"},"subdivision":{"type":"string","description":"The ISO-3166-2 subdivision code referring to state or province or other regional division. \n\nFor more details refer to: [https://en.wikipedia.org/wiki/ISO_3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)","uniqueKey":"queryDetails.region.subdivision","typeLabel":"string"}},"isRequired":true,"uniqueKey":"queryDetails.region","typeLabel":"object"},"organizationName":{"type":"string","description":"The name of the organization that we are looking up for","uniqueKey":"queryDetails.organizationName","typeLabel":"string"},"organizationNumber":{"type":"object","required":["registrationNumber"],"properties":{"registrationNumber":{"type":"string","description":"The registration number of the specific registry the organization is registered in","isRequired":true,"uniqueKey":"queryDetails.organizationNumber.registrationNumber","typeLabel":"string"},"registryCode":{"type":"string","description":"A code that specifies an associated registry\nex - ABN or ACN","uniqueKey":"queryDetails.organizationNumber.registryCode","typeLabel":"string"}},"uniqueKey":"queryDetails.organizationNumber","typeLabel":"object"}},"required":["region"],"isRequired":true,"uniqueKey":"queryDetails","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"ExampleLookup":{"title":"ExampleLookup","value":{"requestId":"01J949482NZT359YHTT07X6GBT","matchedOrganizations":[{"addresses":[{"addressId":"b39ec506-712e-47b6-a0f5-50d9e5fb34e9","sourceId":"d37e3af7-8c3b-48c7-8d50-3ec07d4375f9","type":"BUSINESS","validFrom":{"year":"2006","month":"08","day":"07","unstructured":"2006-08-07"},"unitNumber":"LEVEL 1","streetName":"141 BROADWAY","locality":"NEDLANDS","country":"AUS","postalCode":"6009"}],"registrationDetails":[{"registry":"ABR","registryDescription":{"code":"ABR","description":"Australian Business Register"},"class":{"code":"LMSH","description":"Limited By Shares","sourceId":"d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"},"status":{"normalized":{"code":"ACTV","description":"ACTIVE"},"unstructured":{"code":"REGD","description":"Registered"},"sourceId":"d37e3af7-8c3b-48c7-8d50-3ec07d4375f9"},"isCurrent":true,"registeredName":"INSURANCE AUSTRALIA LIMITED","registeredNameDetails":{"validFrom":{"year":"2006","month":"08","day":"07","unstructured":"2006-08-07","normalized":"2006-08-07"},"validTo":{"year":"2006","month":"08","day":"07","unstructured":"2006-08-07","normalized":"2006-08-07"}},"registeredDate":{"year":"2006","month":"08","day":"07","unstructured":"2006-08-07","normalized":"2006-08-07"},"extractedDate":{"year":"2006","month":"08","day":"07","unstructured":"2006-08-07","normalized":"2006-08-07"},"registrationNumber":"11000016722","registrationNumberType":"ABN","registrationNumberDescription":"Australian Business Number","updatedDate":{"year":"2006","month":"08","day":"07","unstructured":"2006-08-07","normalized":"2006-08-07"}}],"organizationToken":"string","country":"string","subdivision":"string"}],"queryDetails":{"organizationName":"INSURANCE AUSTRALIA LIMITED","organizationNumber":{"registrationNumber":"11000016722","registryCode":"ABN"},"region":{"country":"AUS"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"f4e85737-8e82-482e-b7f3-5a835bc57415":{"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":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"},"aad5fd40-80db-4b28-8c62-1b82ef7f04bd":{"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":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"},"9ad8d539-49eb-44ff-80e9-141a96c37269":{"description":"Forbidden","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"},"05c96cbb-3eed-4ccb-86e9-f2073807e8c1":{"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":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"},"69659c67-bb96-487a-9dc5-dee0c53d3b82":{"description":"Unprocessable Entity (WebDAV)","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"},"cdc06629-9c29-4f00-8958-3cff4d694d5e":{"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":{"Example":{"title":"Example","value":{"errorCode":"\u003cstring>","errorMsg":"\u003cstring>","details":[{"issue":"\u003cstring>","issueLocation":"\u003cstring>","issueType":"\u003cstring>"}],"requestId":"01HN9XHZN6MGXM9JXG50K59Q85"}}},"exampleType":"generated"}},"exampleType":"generated"},"440240d3-fc94-42ea-810c-ac7353295f8d":{"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":{"4a579483-8bec-4d06-b119-ec6f197e55ff":{"Api-Key":{"type":"apiKey","in":"header","name":"api_key","description":"","scopes":[]}}},"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"}]},"originalFileLocation":"specs/fc-kyb-bundled_generated.yaml"},"subdomain":"frankieone-f5583b1b","siteName":"frankieone","title":"Lookup organizations - frankieone","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/organizations/lookup-organizations","matchLevel":0},"v1":{"href":"/docs/v1/introduction/getting-started/welcome-to-frankie","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-09-30T05:08:26.578Z","originalFileLocation":"api-reference/organizations/lookup-organizations.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Lookup for a given business name or business number across business registries. The lookup will return a list of matching companies that you can then potentially run workflows on. Each lookup result will have a organizationToken that you can use to create an organization or run workflows on Note: This process will not save any details from the lookup results.\">\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=\"Lookup organizations - frankieone\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lookup for a given business name or business number across business registries. The lookup will return a list of matching companies that you can then potentially run workflows on. Each lookup result will have a organizationToken that you can use to create an organization or run workflows on Note: This process will not save any details from the lookup results.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"frankieone\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations\">\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=Organizations\u0026amp;title=Lookup+organizations\u0026amp;description=Lookup+for+a+given+business+name+or+business+number+across+business+registries.%0A%0AThe+lookup+will+return+a+list+of+matching+companies+that+you+can+then%0Apotential\u0026amp;theme=3c4744f86ac72d7d8cd5a2da\u0026amp;signature=456c9b37f6aac0b7b9cbc00e40193470a55faecc4cacb5c85d25065f5983dda6\">\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=\"Lookup organizations - frankieone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lookup for a given business name or business number across business registries. The lookup will return a list of matching companies that you can then potentially run workflows on. Each lookup result will have a organizationToken that you can use to create an organization or run workflows on Note: This process will not save any details from the lookup results.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://frankieone-f5583b1b.mintlify.site/_mintlify/api/og/v2?division=Organizations\u0026amp;title=Lookup+organizations\u0026amp;description=Lookup+for+a+given+business+name+or+business+number+across+business+registries.%0A%0AThe+lookup+will+return+a+list+of+matching+companies+that+you+can+then%0Apotential\u0026amp;theme=3c4744f86ac72d7d8cd5a2da\u0026amp;signature=456c9b37f6aac0b7b9cbc00e40193470a55faecc4cacb5c85d25065f5983dda6\">\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/organizations/lookup-organizations\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/organizations/lookup-organizations.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/organizations/lookup-organizations#webpage\",\"url\":\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations\",\"name\":\"Lookup organizations\",\"description\":\"Lookup for a given business name or business number across business registries. The lookup will return a list of matching companies that you can then potentially run workflows on. Each lookup result will have a organizationToken that you can use to create an organization or run workflows on Note: This process will not save any details from the lookup results.\",\"dateModified\":\"2026-09-30T05:08:26.578Z\",\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"frankieone\",\"item\":\"https://docs.frankieone.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Lookup organizations\",\"item\":\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations#apireference\",\"headline\":\"Lookup organizations\",\"name\":\"Lookup organizations\",\"description\":\"Lookup for a given business name or business number across business registries. The lookup will return a list of matching companies that you can then potentially run workflows on. Each lookup result will have a organizationToken that you can use to create an organization or run workflows on Note: This process will not save any details from the lookup results.\",\"url\":\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations\",\"mainEntityOfPage\":{\"@id\":\"https://docs.frankieone.com/api-reference/organizations/lookup-organizations#webpage\"},\"dateModified\":\"2026-09-30T05:08:26.578Z\",\"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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"frankieone\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/organizations/lookup-organizations.md","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","description":"Create a new session for an individual. This is only required for onboarding fraud checks where device data is required and at this stage \nit is NOT specifically needed for Transaction and Activity monitoring.\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","description":"Retrieve all the information of the Organization with the matching entity ID.","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","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.","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":"Lookup organizations - frankieone","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}