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":true},"background":{"color":{"light":"#f4f5fc","dark":"#10152e"}},"navbar":{"links":[{"href":"https://status.frankieone.com/","label":"Support"}],"primary":{"type":"button","label":"Book a Demo","href":"https://frankieone.com/book-a-demo"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/frankieone"}},"seo":{"metatags":{"canonical":"https://docs.frankieone.com","og:url":"https://docs.frankieone.com"}},"fonts":{"heading":{"family":"DM Sans","weight":800,"source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2","format":"woff2"},"body":{"family":"DM Sans","source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Hp2ywxg089UriCZOIHQ.woff2","format":"woff2"}},"integrations":{"ga4":{"measurementId":"G-TQB66YCL53"}},"errors":{"404":{"redirect":true,"title":"Sorry, we couldn't find the page you're looking for.","description":"Please try searching for a different term, use the navigation bar, or return to the homepage."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Service Status","icon":"signal","href":"https://status.frankieone.com"},{"anchor":"Blog","icon":"newspaper","href":"https://frankieone.com/frankieone-blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"frankieone-f5583b1b","hasAudioNarration":false,"actualSubdomain":"frankieone-f5583b1b","customDomains":["docs.frankieone.com"],"gitSource":{"type":"github","owner":"frankieone","repo":"config-api-documentation-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae7d8606bddb0a059f6ecaf","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API","count":236},{"language":"default","tag":"Portal","count":188},{"language":"default","tag":"OneSDK","count":137},{"language":"default","tag":"KYC","count":131},{"language":"default","tag":"KYB","count":68},{"language":"default","tag":"KYC API Endpoints","count":50},{"language":"default","tag":"KYC V2 API","count":45},{"language":"default","tag":"About OneSDK","count":40},{"language":"default","tag":"Guide to the API","count":38},{"language":"default","tag":"Introduction","count":35}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"help@frankieone.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":":root{color-scheme:light dark}[data-theme=\"dark\"]{color-scheme:dark}[data-theme=\"light\"]{color-scheme:light}span[data-as=\"p\"]:not(:where([data-page=\"/\"])){color:light-dark(#000, #FFF)!important}ul{color:light-dark(#000000, #FFFFFF)!important}tr{color:light-dark(#000000, #FFFFFF)!important}p{color:light-dark(#000000, #FFFFFF)!important}code{color:#1A6CFF!important}"}],"page":{"pagePath":"api-reference/organizations/organizations-lookup","slug":"/api-reference/organizations/organizations-lookup","pageMetadata":{"title":"Organizations Lookup","description":"Lookup for a given business name or business number across international\nbusiness registries.\n\n\nThe lookup will return a list of matching companies that you can then\npotentially query using the business profile query.\n\nEach lookup result will have a organizationToken that you use to retrieve the\nspecific company details using the profile or ownership function.\n\n\nNote: This process will not save any details from the lookup results.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/lookup","href":"/api-reference/organizations/organizations-lookup","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 international\\nbusiness registries.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The lookup will return a list of matching companies that you can then\\npotentially query using the business profile query.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Each lookup result will have a organizationToken that you use to retrieve the\\nspecific company details using the profile or ownership function.\"\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":"Organizations Lookup","description":"Lookup for a given business name or business number across international\nbusiness registries.\n\n\nThe lookup will return a list of matching companies that you can then\npotentially query using the business profile query.\n\nEach lookup result will have a organizationToken that you use to retrieve the\nspecific company details using the profile or ownership function.\n\n\nNote: This process will not save any details from the lookup results.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/lookup","href":"/api-reference/organizations/organizations-lookup","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Organizations Lookup","tags":["Organizations"],"responses":{"200":"e92c9e9f-fe55-4fc1-9d12-45f353bab6f9","400":"d1d4deb3-7279-4dbe-aade-a7f674344a60","401":"ffe4d66c-cfc7-48bf-8c15-0a7e1e35c142","403":"100164fe-17a3-4d1f-94bc-e576f6497254","404":"eb5df090-f49c-4012-bad1-7cc455351d78","422":"b21983ff-a123-4025-aa28-c59ed594a392","500":"bdc4a556-3264-4821-8cf7-27b50ed5d70a","503":"4a57a4bb-4cc9-4bf2-8d47-c52354bc7257"},"operationId":"lookupOrganizations","description":"Lookup for a given business name or business number across international\nbusiness registries.\n\n\nThe lookup will return a list of matching companies that you can then\npotentially query using the business profile query.\n\nEach lookup result will have a organizationToken that you use to retrieve the\nspecific company details using the profile or ownership function.\n\n\nNote: This process will not save any details from the lookup results.","parameters":["2d106c66-c7a5-4b2d-99ad-a53b4c6e42cb","8d588bcd-d969-4e73-adb5-925b4760d51e","5e50a9cd-7109-46bc-b23f-3968f7e87c27","9f10e505-db1a-4528-9c2f-38a13351b193"],"requestBody":"b9e2933d-9972-453b-ab98-45b563755aa0","method":"post","type":"path","servers":["2a7e8f01-e065-4147-9a7f-ea7a48020f38","f83c037e-d5b0-40fe-8804-cefc59737f57"],"security":["48d965fc-4a14-4f33-b1f3-403322eb6498"],"path":"/v2/organizations/lookup","baseUrlOptions":["https://api.kycaml.frankiefinancial.io","https://api.kycaml.uat.frankiefinancial.io"],"title":"Organizations Lookup","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2d106c66-c7a5-4b2d-99ad-a53b4c6e42cb":{"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},"8d588bcd-d969-4e73-adb5-925b4760d51e":{"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"},"5e50a9cd-7109-46bc-b23f-3968f7e87c27":{"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"},"9f10e505-db1a-4528-9c2f-38a13351b193":{"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","pattern":"^[A-Z]{3}$","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 associated to the entity","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":{"e92c9e9f-fe55-4fc1-9d12-45f353bab6f9":{"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","pattern":"^[A-Z]{3}$","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"},"isCurrent":{"description":"Indicates that the registration is current","type":"boolean","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].isCurrent","typeLabel":"boolean"},"registeredName":{"description":"The name of organization in the registry","type":"string","uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredName","typeLabel":"string"},"registeredNameDetails":{"type":"object","description":"The registered name details of an organization","properties":{"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].registeredNameDetails.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].registeredNameDetails.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].registeredNameDetails.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].registeredNameDetails.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].registeredNameDetails.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].registeredNameDetails.validFrom.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredNameDetails.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].registeredNameDetails.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].registeredNameDetails.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].registeredNameDetails.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].registeredNameDetails.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].registeredNameDetails.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].registeredNameDetails.validTo.normalized","typeLabel":"string\u003cdate>"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredNameDetails.validTo","typeLabel":"object"}},"uniqueKey":"matchedOrganizations.items.[INDEX].registrationDetails.items.[INDEX].registeredNameDetails","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"}},"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"}},"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","uniqueKey":"matchedOrganizations.items.[INDEX].alternateNames.items.[INDEX].type","typeLabel":"string"},"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":"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].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","uniqueKey":"matchedOrganizations.items.[INDEX].name.type","typeLabel":"string"},"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":"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].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"}},"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","pattern":"^[A-Z]{3}$","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 associated to the entity","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":{"Example":{"title":"Example","value":{"requestId":"01HN9XHZN6MGXM9JXG50K59Q85","matchedOrganizations":[{"organizationToken":"\u003cstring>","country":"\u003cstring>","type":{"code":"\u003cstring>","description":"\u003cstring>"},"addresses":[{"country":"\u003cstring>","addressId":"\u003cstring>","updatedAt":"2023-11-07T05:31:56Z","sourceId":"\u003cstring>","type":"OTHER","typeDescription":"\u003cstring>","validFrom":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"validTo":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"longForm":"\u003cstring>","unitNumber":"\u003cstring>","buildingName":"\u003cstring>","streetName":"\u003cstring>","streetNumber":"\u003cstring>","streetType":"\u003cstring>","neighborhood":"\u003cstring>","locality":"\u003cstring>","district":"\u003cstring>","subdivision":"\u003cstring>","postalCode":"\u003cstring>","careOf":"\u003cstring>","status":"CURRENT","unstructuredLongForm":"\u003cstring>"}],"registrationDetails":[{"registrationNumber":"\u003cstring>","registry":"\u003cstring>","registryDescription":"\u003cstring>","isCurrent":true,"registeredName":"\u003cstring>","registeredNameDetails":{"validFrom":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"validTo":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"}},"registeredDate":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"extractedDate":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"registeredSubdivision":"\u003cstring>","registeredCountry":"\u003cstring>","registrationStatus":{"normalized":{"code":"\u003cstring>","description":"\u003cstring>"},"unstructured":{"code":"\u003cstring>","description":"\u003cstring>"}},"registrationNumberType":"\u003cstring>","registrationNumberDescription":"\u003cstring>","updatedDate":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"reviewDate":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"foundationDate":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"isSuppressed":true,"validFrom":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"validTo":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"}}],"alternateNames":[{"name":"\u003cstring>","type":"\u003cstring>","validFrom":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"validTo":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"sourceId":"\u003cstring>"}],"name":{"name":"\u003cstring>","type":"\u003cstring>","validFrom":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"validTo":{"year":"1990","month":"03","day":"27","unstructured":"12 Rajab 1445 AH","type":"GREGORIAN","normalized":"1990-03-31"},"sourceId":"\u003cstring>"},"status":{"normalized":{"code":"\u003cstring>","description":"\u003cstring>"},"unstructured":{"code":"\u003cstring>","description":"\u003cstring>"}},"phoneNumbers":[{"phoneNumberId":"ad165f64-5717-4562-b3fc-2c963f66bfa9","isPreferred":true,"type":"MOBILE","sourceId":"14fd5f64-5717-4562-b3fc-2c963f66ba34","country":"AUS","number":"0426192340","linkedAddresses":[{"addressId":"fa335f64-5717-4562-b3fc-2c963f66cf41"}],"unstructuredLongForm":"\u003cstring>","updatedAt":"2023-11-07T05:31:56Z"}],"emailAddresses":[{"emailAddressId":"aa385f64-5717-4562-b3fc-2c963f66af21","type":"WORK","sourceId":"31dd15f64-5717-4562-b3fc-2c963f66234d","email":"leonardo_dc@outlook.com","isPreferred":true,"linkedAddresses":[{"addressId":"adc215f64-5717-4562-b3fc-2c963f66222a"}],"updatedAt":"2023-11-07T05:31:56Z"}],"websiteUrls":[{"websiteUrl":"\u003cstring>","sourceId":"\u003cstring>"}],"subdivision":"\u003cstring>"}],"queryDetails":{"region":{"country":"\u003cstring>","subdivision":"\u003cstring>"},"organizationName":"\u003cstring>","organizationNumber":{"registrationNumber":"\u003cstring>","registryCode":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"d1d4deb3-7279-4dbe-aade-a7f674344a60":{"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"},"ffe4d66c-cfc7-48bf-8c15-0a7e1e35c142":{"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"},"100164fe-17a3-4d1f-94bc-e576f6497254":{"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"},"eb5df090-f49c-4012-bad1-7cc455351d78":{"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"},"b21983ff-a123-4025-aa28-c59ed594a392":{"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"},"bdc4a556-3264-4821-8cf7-27b50ed5d70a":{"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"},"4a57a4bb-4cc9-4bf2-8d47-c52354bc7257":{"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":{"48d965fc-4a14-4f33-b1f3-403322eb6498":{"Api-Key":{"type":"apiKey","in":"header","name":"api_key","description":"","scopes":[],"schemeName":"Api-Key"}}},"servers":{"2a7e8f01-e065-4147-9a7f-ea7a48020f38":{"url":"https://api.kycaml.frankiefinancial.io","description":"Production API Base URL"},"f83c037e-d5b0-40fe-8804-cefc59737f57":{"url":"https://api.kycaml.uat.frankiefinancial.io","description":"UAT Environment API Base URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api_key","description":"","scopes":[],"schemeName":"Api-Key"},"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-facade-bundled_generated.yaml"},"subdomain":"frankieone-f5583b1b","siteName":"frankieone","title":"Organizations Lookup - frankieone","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/introduction/overview","matchLevel":4},"v1":{"href":"/api-reference/organizations/organizations-lookup","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T22:12:24.930Z","originalFileLocation":"api-reference/organizations/organizations-lookup.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"system\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Lookup for a given business name or business number across international business registries. The lookup will return a list of matching companies that you can then potentially query using the business profile query. Each lookup result will have a organizationToken that you use to retrieve the specific company details using the profile or ownership function. 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=\"Organizations Lookup - frankieone\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lookup for a given business name or business number across international business registries. The lookup will return a list of matching companies that you can then potentially query using the business profile query. Each lookup result will have a organizationToken that you use to retrieve the specific company details using the profile or ownership function. 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/organizations-lookup\">\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=Organizations+Lookup\u0026amp;description=Lookup+for+a+given+business+name+or+business+number+across+international%0Abusiness+registries.%0A%0A%0AThe+lookup+will+return+a+list+of+matching+companies+that+you+can\u0026amp;theme=3c4744f86ac72d7d8cd5a2da\u0026amp;signature=b86bb17c60c8fb57ee101fdf4f2c5498f3f6d38472489261d71f672054360f24\">\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=\"Organizations Lookup - frankieone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lookup for a given business name or business number across international business registries. The lookup will return a list of matching companies that you can then potentially query using the business profile query. Each lookup result will have a organizationToken that you use to retrieve the specific company details using the profile or ownership function. 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=Organizations+Lookup\u0026amp;description=Lookup+for+a+given+business+name+or+business+number+across+international%0Abusiness+registries.%0A%0A%0AThe+lookup+will+return+a+list+of+matching+companies+that+you+can\u0026amp;theme=3c4744f86ac72d7d8cd5a2da\u0026amp;signature=b86bb17c60c8fb57ee101fdf4f2c5498f3f6d38472489261d71f672054360f24\">\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/organizations-lookup\">\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/organizations-lookup.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/organizations-lookup#webpage\",\"url\":\"https://docs.frankieone.com/api-reference/organizations/organizations-lookup\",\"name\":\"Organizations Lookup\",\"description\":\"Lookup for a given business name or business number across international business registries. The lookup will return a list of matching companies that you can then potentially query using the business profile query. Each lookup result will have a organizationToken that you use to retrieve the specific company details using the profile or ownership function. Note: This process will not save any details from the lookup results.\",\"dateModified\":\"2026-10-14T22:12:24.930Z\",\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.frankieone.com/api-reference/organizations/organizations-lookup#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.frankieone.com/api-reference/organizations/organizations-lookup#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"frankieone\",\"item\":\"https://docs.frankieone.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Organizations Lookup\",\"item\":\"https://docs.frankieone.com/api-reference/organizations/organizations-lookup\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.frankieone.com/api-reference/organizations/organizations-lookup#apireference\",\"headline\":\"Organizations Lookup\",\"name\":\"Organizations Lookup\",\"description\":\"Lookup for a given business name or business number across international business registries. The lookup will return a list of matching companies that you can then potentially query using the business profile query. Each lookup result will have a organizationToken that you use to retrieve the specific company details using the profile or ownership function. Note: This process will not save any details from the lookup results.\",\"url\":\"https://docs.frankieone.com/api-reference/organizations/organizations-lookup\",\"mainEntityOfPage\":{\"@id\":\"https://docs.frankieone.com/api-reference/organizations/organizations-lookup#webpage\"},\"dateModified\":\"2026-10-14T22:12:24.930Z\",\"publisher\":{\"@id\":\"https://docs.frankieone.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.frankieone.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"frankieone\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"frankieone","nav":{"global":{"anchors":[{"anchor":"Service Status","icon":"signal","href":"https://status.frankieone.com"},{"anchor":"Blog","icon":"newspaper","href":"https://frankieone.com/frankieone-blog"}]},"versions":[{"version":"v2","pages":[{"title":"v2","href":"/v2/introduction/overview"}]},{"version":"v1","tabs":[{"tab":"Introduction","icon":"book","pages":[{"title":"Introduction","href":"/docs/v1/introduction/getting-started/welcome-to-frankie"}]},{"tab":"OneSDK","icon":"display-code","pages":[{"title":"OneSDK","href":"/docs/v1/onesdk/oneSDK/about-onesdk"}]},{"tab":"KYC","icon":"user-group","pages":[{"title":"KYC","href":"/docs/v1/kyc/kyc-info/overview"}]},{"tab":"KYB","icon":"briefcase","pages":[{"title":"KYB","href":"/docs/v1/kyb/overview"}]},{"tab":"Portal","icon":"credit-card","pages":[{"title":"Portal","href":"/docs/v1/portal/getting-started/overview"}]},{"tab":"Fraud","icon":"shield-halved","pages":[{"title":"Fraud","href":"/docs/v1/fraud-activity-monitoring/fraud-overview"}]},{"tab":"API","icon":"terminal","groups":[{"group":"Guide to the API","pages":[{"title":"Introduction to the API","sidebarTitle":"Introduction","icon":"book","href":"/docs/v1/api/guide-to-the-api/introduction-to-the-api"},{"group":"Getting Started","icon":"rocket","pages":[{"title":"Authentication","sidebarTitle":"","icon":"key","href":"/docs/v1/api/guide-to-the-api/getting-started/reference/authentication"},{"title":"Errors","sidebarTitle":"","icon":"triangle-exclamation","href":"/docs/v1/api/guide-to-the-api/getting-started/reference/errors"},{"title":"Asynchronous Calls (Background Processes)","sidebarTitle":"","icon":"clock","href":"/docs/v1/api/guide-to-the-api/getting-started/asynchronous-calls-backgrounding-processes"},{"title":"Entity Profiles Available","sidebarTitle":"Available Entity Profiles","icon":"id-card","href":"/docs/v1/api/guide-to-the-api/getting-started/entity-profiles-available-to-test-with"},{"title":"Entity extraData Key Value Pairs","sidebarTitle":"Customer Reference Numbers \u0026 Entity KVPs","icon":"hashtag","href":"/docs/v1/api/guide-to-the-api/getting-started/entity-extradata-key-value-pairs"},{"title":"Reseller Checks with Experian AU","sidebarTitle":"Reseller Checks (Experian AU)","icon":"building-columns","href":"/docs/v1/api/guide-to-the-api/getting-started/experian-reseller-abn"},{"title":"Notifications \u0026 Webhooks","sidebarTitle":"Notifications - Webhooks","icon":"bell","href":"/docs/v1/api/guide-to-the-api/getting-started/notifications-webhooks"},{"title":"Set Entity Ongoing AML Monitoring Status","sidebarTitle":"","icon":"shield","href":"/docs/v1/api/guide-to-the-api/getting-started/set-entity-ongoing-aml-monitoring-status"},{"title":"Data Source Codes","sidebarTitle":"","icon":"database","href":"/docs/v1/api/guide-to-the-api/getting-started/reference/datasource-codes"},{"title":"Download Test Data","sidebarTitle":"","icon":"download","href":"/docs/v1/api/guide-to-the-api/getting-started/test-data"}]},{"group":"Common API Objects \u0026 Fields","icon":"cube","pages":[{"title":"Common API Objects and Fields","sidebarTitle":"Overview","icon":"cube","href":"/docs/v1/api/guide-to-the-api/common-api-objects-and-fields"},{"title":"Object IDs","sidebarTitle":"","icon":"fingerprint","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/common-api-fields-types"},{"title":"The Document Object","sidebarTitle":"","icon":"file","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/fundamentals-document-object"},{"title":"The Entity Object","sidebarTitle":"","icon":"user","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/fundamentals-entity-object"},{"title":"Key Value Pairs","sidebarTitle":"","icon":"key","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/key-value-pairs"},{"title":"RequestID","sidebarTitle":"","icon":"id-badge","href":"/docs/v1/api/guide-to-the-api/common-api-objects-fields/requestid"}]},{"group":"Data Types","icon":"table","pages":[{"title":"Working with Names","sidebarTitle":"Names","icon":"signature","href":"/docs/v1/api/guide-to-the-api/data-types/names-with-different-character-sets"},{"title":"Working With Addresses","sidebarTitle":"Addresses","icon":"location-dot","href":"/docs/v1/api/guide-to-the-api/data-types/working-with-addresses"},{"title":"Working With Country Codes","sidebarTitle":"Country Codes","icon":"globe","href":"/docs/v1/api/guide-to-the-api/data-types/working-with-country-codes"},{"title":"Working With Support Docs","sidebarTitle":"Support Docs","icon":"file-lines","href":"/docs/v1/api/guide-to-the-api/data-types/working-with-support-docs"},{"title":"Adding an Email Address","sidebarTitle":"","icon":"envelope","href":"/docs/v1/api/guide-to-the-api/data-types/adding-an-email-address"},{"title":"Adding a Mobile Phone Number","sidebarTitle":"","icon":"mobile","href":"/docs/v1/api/guide-to-the-api/data-types/adding-a-mobile-phone-number"}]},{"group":"Country Specific ID Document Requirements","icon":"id-card","pages":[{"title":"Requirements \u0026 Additional Fields for ID Documents","sidebarTitle":"Overview","icon":"id-card","href":"/docs/v1/api/guide-to-the-api/requirements-additional-fields-for-id-documents"},{"title":"Australian ID Documents","sidebarTitle":"Australia","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/aus-drivers-licence"},{"title":"New Zealand ID Documents","sidebarTitle":"New Zealand","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/nzl-drivers-licence"},{"title":"Chinese ID Documents","sidebarTitle":"China","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/chn-national-id"},{"title":"Mexican ID Documents","sidebarTitle":"Mexico","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/mex-national-id"},{"title":"Thai ID Documents","sidebarTitle":"Thailand","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/tha-national-id"},{"title":"India","sidebarTitle":"","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/ind-passport"},{"title":"Philippines","sidebarTitle":"","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/phi-passport"},{"title":"United States Documents","sidebarTitle":"USA","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/country-specific-documents-usa-v1"},{"title":"International","sidebarTitle":"","icon":"","href":"/docs/v1/api/guide-to-the-api/country-specific-id-document-requirements/international-national-id"}]},{"title":"OCR Extraction Document API","sidebarTitle":"","icon":"file-lines","href":"/docs/v1/api/guide-to-the-api/ocr-extraction-document-api"},{"group":"Using the Sandbox","icon":"box","pages":[{"title":"Working with the Sandbox","sidebarTitle":"Overview","icon":"box","href":"/docs/v1/api/guide-to-the-api/working-with-the-sandbox"},{"title":"Using the Sandbox Data and API","sidebarTitle":"Sandbox Data \u0026 API","icon":"code","href":"/docs/v1/api/guide-to-the-api/using-the-sandbox/using-the-sandbox-data-and-api"},{"title":"Testing Error Scenarios","sidebarTitle":"Forcing Test Scenario Errors","icon":"bug","href":"/docs/v1/api/guide-to-the-api/using-the-sandbox/forcing-errors-in-test-scenarios"},{"title":"Typical Test Scenarios","sidebarTitle":"","icon":"vial","href":"/docs/v1/api/guide-to-the-api/using-the-sandbox/typical-test-scenarios"}]}]},{"group":"KYC API Endpoints","pages":[{"group":"status","pages":[{"title":"Service Status","openapi":"get /ruok","href":"/docs/v1/api/kyc-api-endpoints/reference/status/status-check"}]},{"group":"Document","pages":[{"title":"Create New Document.","openapi":"post /document","href":"/docs/v1/api/kyc-api-endpoints/reference/document/create-document"},{"title":"Create and Verify Document.","openapi":"POST /document/new/verify","href":"/docs/v1/api/kyc-api-endpoints/reference/document/verify-document"},{"title":"Search For a Document","openapi":"POST /document/search","href":"/docs/v1/api/kyc-api-endpoints/reference/document/search-document"},{"title":"Retrieve Document Details","openapi":"GET /document/{documentId}","href":"/docs/v1/api/kyc-api-endpoints/reference/document/query-document"},{"title":"Update Existing Document.","openapi":"POST /document/{documentId}","href":"/docs/v1/api/kyc-api-endpoints/reference/document/update-document"},{"title":"Delete Document.","openapi":"DELETE /document/{documentId}","href":"/docs/v1/api/kyc-api-endpoints/reference/document/delete-document"},{"title":"Retrieve Document Verification Check Details.","openapi":"GET /document/{documentId}/checks","href":"/docs/v1/api/kyc-api-endpoints/reference/document/query-document-checks"},{"title":"Retrieve Document and Scan Data","openapi":"GET /document/{documentId}/full","href":"/docs/v1/api/kyc-api-endpoints/reference/document/query-document-full"},{"title":"Update and Verify Document.","openapi":"POST /document/{documentId}/verify","href":"/docs/v1/api/kyc-api-endpoints/reference/document/update-verify-document"}]},{"group":"Entity","pages":[{"title":"Create New Entity.","openapi":"POST /entity","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-entity"},{"title":"Create Entity and Get IDV Token","openapi":"POST /entity/new/idvalidate/getToken","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-entity-get-idv-token"},{"title":"Create Entity and Push Self-Verification Link","openapi":"POST /entity/new/verify/pushToMobile","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-check-entity-push-to-mobile"},{"title":"Create and Verify Entity","openapi":"POST /entity/new/verify/{checkType}/{resultLevel}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/create-check-entity"},{"title":"Search for Entity","openapi":"POST /entity/search","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/search-entity"},{"title":"Retrieve Entity Details","openapi":"GET /entity/{entityId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/query-entity"},{"title":"Update Existing Entity","openapi":"POST /entity/{entityId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity"},{"title":"Delete Entity","openapi":"DELETE /entity/{entityId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/delete-entity"},{"title":"Update Check Result States (Batch)","openapi":"POST /entity/{entityId}/check/{checkId}/{checkClass}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-class-results"},{"title":"Update Check Result State","openapi":"POST /entity/{entityId}/check/{checkId}/{checkClass}/{checkClassId}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-class-result"},{"title":"Retrieve Entity Verification Check Details","openapi":"GET /entity/{entityId}/checks","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/query-entity-checks"},{"title":"Update Entity and evaluate current results and risk without running any new checks","openapi":"POST /entity/{entityId}/evaluate","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-evaluate-entity"},{"title":"Retrieve Entity Details and Document Scan Data","openapi":"GET /entity/{entityId}/full","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/query-entity-full"},{"title":"Update Entity and Get IDV Token","openapi":"POST /entity/{entityId}/idvalidate/getToken","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity-get-idv-token"},{"title":"Update Entity and Initiate IDV Process","openapi":"POST /entity/{entityId}/idvalidate/initProcess","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity-init-idv-process"},{"title":"Generate Individual Verification Report","openapi":"POST /entity/{entityId}/report","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/entity-kyc-report"},{"title":"Update Entity States","openapi":"POST /entity/{entityId}/status","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-entity-state"},{"title":"Update Entity and Push Self-Verification Link","openapi":"POST /entity/{entityId}/verify/pushToMobile","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-entity-push-to-mobile"},{"title":"Update Entity and Verify Details","openapi":"POST /entity/{entityId}/verify/{checkType}/{resultLevel}","href":"/docs/v1/api/kyc-api-endpoints/reference/entity/update-check-entity"}]},{"group":"Business","pages":[{"title":"(International) Retrieve a business profile from any country.","openapi":"POST /business/international/profile","href":"/docs/v1/api/kyc-api-endpoints/reference/business/international-business-profile"},{"title":"(International) Search for a business from any country.","openapi":"POST /business/international/search","href":"/docs/v1/api/kyc-api-endpoints/reference/business/international-business-search"},{"title":"(AUS Only) Create Business Entity and Query UBO","openapi":"POST /business/ownership/query","href":"/docs/v1/api/kyc-api-endpoints/reference/business/business-ownership-query"},{"title":"(AUS Only) Run Report(s) against a new or existing organisation entity.","openapi":"POST /business/reports","href":"/docs/v1/api/kyc-api-endpoints/reference/business/run-business-reports"},{"title":"(AUS Only) Run Report(s) against a new or existing organisation entity and produce a PDF formatted document.","openapi":"POST /business/reports/multi","href":"/docs/v1/api/kyc-api-endpoints/reference/business/run-business-reports-multi"},{"title":"(AUS Only) Make a new entity a direct associated entity of a parent organisation.","openapi":"POST /business/{entityId}/associateEntity/new","href":"/docs/v1/api/kyc-api-endpoints/reference/business/create-associate-entity"},{"title":"(AUS Only) Make an existing entity (otherId) a direct associated entity of a parent organisation (entityId), or update an existing association.","openapi":"POST /business/{entityId}/associateEntity/{otherId}","href":"/docs/v1/api/kyc-api-endpoints/reference/business/update-associate-entity"},{"title":"(AUS Only) Remove a previously created association between an entity (otherId) and a parent organisation (entityId).","openapi":"DELETE /business/{entityId}/associateEntity/{otherId}","href":"/docs/v1/api/kyc-api-endpoints/reference/business/delete-entity-association"},{"title":"(AUS Only) Retrieve previous UBO query results","openapi":"GET /business/{entityId}/checks","href":"/docs/v1/api/kyc-api-endpoints/reference/business/query-ownership-checks"},{"title":"(International) List available documents in catalogue","openapi":"GET /business/{entityId}/list","href":"/docs/v1/api/kyc-api-endpoints/reference/business/business-document-catalogue"},{"title":"(AUS Only) Retrieve all the parent associations for an Individual or a Business","openapi":"GET /business/{entityId}/parentAssociations","href":"/docs/v1/api/kyc-api-endpoints/reference/business/query-parent-associations"},{"title":"(International) Get status of document order","openapi":"GET /business/{entityId}/report","href":"/docs/v1/api/kyc-api-endpoints/reference/business/order-business-document-status"},{"title":"(International) Order document from catalogue","openapi":"POST /business/{entityId}/report","href":"/docs/v1/api/kyc-api-endpoints/reference/business/order-business-document"},{"title":"(AUS Only) Subscribe or unsubscribe to continuous monitoring of business details and ownership.","openapi":"POST /business/{entityId}/subscription","href":"/docs/v1/api/kyc-api-endpoints/reference/business/business-ownership-subscription"},{"title":"(AUS Only) Run KYC/AML Checks on Organisation and/or Associated Individuals.","openapi":"POST /business/{entityId}/verify","href":"/docs/v1/api/kyc-api-endpoints/reference/business/check-organisation"}]},{"group":"Push Notification","pages":[{"title":"Push Notification Payload","openapi":"post /your/configured/path/{requestId}","href":"/docs/v1/api/kyc-api-endpoints/reference/push-notification/notify-result"}]},{"group":"Retrieve","pages":[{"title":"(Re)retrieve Response Result.","openapi":"GET /retrieve/response/{requestId}","href":"/docs/v1/api/kyc-api-endpoints/reference/retrieve/retrieve-result"}]},{"group":"Flag","pages":[{"title":"Set Entity Blacklist State.","openapi":"POST /entity/{entityId}/flag/blacklist","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/blacklist-entity"},{"title":"Resolve Duplicate States.","openapi":"POST /entity/{entityId}/flag/duplicate/{otherId}","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/flag-duplicate-entity"},{"title":"Set Entity Ongoing AML Monitoring Status.","openapi":"POST /entity/{entityId}/flag/monitor","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/entity-monitoring"},{"title":"Set Entity Watchlist State.","openapi":"POST /entity/{entityId}/flag/watchlist","href":"/docs/v1/api/kyc-api-endpoints/reference/flag/watchlist-entity"}]}]},{"group":"Audit Log API","pages":[{"title":"Audit Log API","sidebarTitle":"Overview","icon":"clipboard-list","href":"/docs/v1/api/audit-log-api/overview"},{"title":"List audit events","openapi":"specs/fc-core-bundled_generated.yaml GET /v2/audit","href":"/docs/v1/api/audit-log-api/list-audit-events"}]},{"group":"Fraud \u0026 AML API Endpoints","pages":[{"group":"Status","pages":[{"title":"Check service status","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /ruok","href":"/api-reference/status/check-service-status"}]},{"group":"Cases","pages":[{"title":"List all cases","deprecated":true,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entity/{entityId}/cases","href":"/api-reference/cases/list-all-cases"},{"title":"Resolve cases for an entity","deprecated":true,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json patch /entity/{entityId}/cases","href":"/api-reference/cases/resolve-cases-for-an-entity"},{"title":"Update a case","deprecated":true,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json patch /entity/{entityId}/cases/{caseId}","href":"/api-reference/cases/update-a-case"}]},{"group":"Transactions","pages":[{"title":"Check a transaction's risk","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json post /transactions","href":"/api-reference/transactions/check-a-transactions-risk"}]},{"group":"Risk","pages":[{"title":"Get an entity's risk level scorecard","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entities/{entityId}/risk","href":"/api-reference/risk/get-an-entitys-risk-level-scorecard"}]},{"group":"Alerts","pages":[{"title":"Fetch all alerts","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /alerts","href":"/api-reference/alerts/fetch-all-alerts"},{"title":"Fetch entities that have had some form of transaction monitoring check completed.","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /entities","href":"/api-reference/alerts/fetch-entities-that-have-had-some-form-of-transaction-monitoring-check-completed"},{"title":"Fetch the details for a specific alert","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json get /alerts/{alertId}","href":"/api-reference/alerts/fetch-the-details-for-a-specific-alert"},{"title":"Resolve a set of alerts for a specific entity","deprecated":null,"version":null,"openapi":"/specs/KYT-V2-Transaction-Monitoring.json patch /entities/{entityId}/alerts","href":"/api-reference/alerts/resolve-a-set-of-alerts-for-a-specific-entity"}]}]},{"group":"IDV API Endpoints","pages":[{"group":"API Reference","pages":[{"title":"Mark all data from an IDV check as captured","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/initProcess","href":"/api-reference/mark-all-data-from-an-idv-check-as-captured"},{"title":"Process an identity document photo for ocr","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/ocr","href":"/api-reference/process-an-identity-document-photo-for-ocr"},{"title":"Process results of IDV check. Optionally re-process results","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/result","href":"/api-reference/process-results-of-idv-check-optionally-re-process-results"},{"title":"Retrieve a token to use with a check","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/token","href":"/api-reference/retrieve-a-token-to-use-with-a-check"},{"title":"Provide onboarding url for hosted onesdk","deprecated":null,"version":null,"openapi":"/specs/Identity-Verification-Service-API.json post /idvalidate/onboarding-url","href":"/api-reference/provide-onboarding-url-for-hosted-onesdk"}]}]},{"group":"KYB Trust Agent","pages":[{"group":"Organization","pages":[{"title":"Document Analyze","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-exp-bundled_generated.yaml post /v2/organizations/documents/analyze","href":"/api-reference/organization/document-analyze"},{"title":"Document Analyses Results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-exp-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}/analyses","href":"/api-reference/organization/document-analyses-results"},{"title":"Document Analysis Result Confirmation","description":"Confirm Document Analysis Results","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-exp-bundled_generated.yaml post /v2/organizations/{entityId}/documents/{documentId}/analyses/{analysisId}/confirm","href":"/api-reference/organization/document-analysis-result-confirmation"}]}]},{"group":"KYB V2 API - Preview","pages":[{"group":"Organizations","pages":[{"title":"Organizations Lookup","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/lookup","href":"/api-reference/organizations/organizations-lookup"},{"title":"Organization Profile","description":"Create an entity based on Profile information retrieved for an organization from registries specific to a region. This will get organization details and official details where available.","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/profile","href":"/api-reference/organizations/organization-profile"},{"title":"Organization Get","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}","href":"/api-reference/organizations/organization-get"},{"title":"Organization Update","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/{entityId}","href":"/api-reference/organizations/organization-update"},{"title":"Organization Ownership","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/ownership","href":"/api-reference/organizations/organization-ownership"},{"title":"Organization Requests","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}/requests","href":"/api-reference/organizations/organization-requests"},{"title":"Organization Request Status","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}/requests/{requestId}","href":"/api-reference/organizations/organization-request-status"}]},{"group":"Hosted URL","pages":[{"title":"Generate Hosted URL","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/hostedUrl","href":"/api-reference/hosted-url/generate-hosted-url"}]},{"group":"Reports","pages":[{"title":"Report Request","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml post /v2/organizations/{entityId}/reports","href":"/api-reference/reports/report-request"}]},{"group":"Documents","pages":[{"title":"Get Attachment","deprecated":null,"version":null,"openapi":"/specs/fc-kyb-facade-bundled_generated.yaml get /v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}","href":"/api-reference/documents/get-attachment"}]}]}]},{"tab":"Release Notes","icon":"code","pages":[{"title":"Release Notes","href":"/docs/v1/release-notes"}]}]}]},"basePath":"","title":"Organizations Lookup - frankieone","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}