Opaque token returned in the previous response. When provided, the API returns the next page of documents (e.g. next 100 filings). When the previous response had no continuationKey, there are no more pages.
When present, pass this value as the continuationKey query parameter on the next request to retrieve the next page of documents. When absent, there are no more pages.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema/docs.json","name":"Kyckr Developer Portal","colors":{"primary":"#0A955D","light":"#0CF191","dark":"#022A37"},"logo":{"light":"https://mintcdn.com/kyckr-0823abd6/9HYzjBYpwF1KfywI/logo/kyckr-light.svg?fit=max\u0026auto=format\u0026n=9HYzjBYpwF1KfywI\u0026q=85\u0026s=20b2e45cb5a675284a993a6e1a528191","dark":"https://mintcdn.com/kyckr-0823abd6/9HYzjBYpwF1KfywI/logo/kyckr-dark.svg?fit=max\u0026auto=format\u0026n=9HYzjBYpwF1KfywI\u0026q=85\u0026s=b662f6c44f6491f637c636b5dd752083"},"background":{"color":{"dark":"#022A37"}},"fonts":{"family":"Inter","format":"woff2"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kyckr-0823abd6","hasAudioNarration":false,"actualSubdomain":"kyckr-0823abd6","customDomains":["developer.kyckr.com"],"gitSource":{"type":"github","owner":"kyckr","repo":"kyckr-developer-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af3c7d4f804892cd158cf8c","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"Country Guides","count":29},{"language":"default","tag":"Documentation","count":28},{"language":"default","tag":"Europe","count":20},{"language":"default","tag":"Company V1 API","count":18},{"language":"default","tag":"Features","count":12},{"language":"default","tag":"Company V2 API","count":10},{"language":"default","tag":"Platform Details","count":8},{"language":"default","tag":"Asia-Pacific","count":7},{"language":"default","tag":"Companies","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/companies/documents","slug":"/api-reference/companies/documents","pageMetadata":{"title":"Documents","description":"Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml get /companies/{kyckrId}/documents","href":"/api-reference/companies/documents","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.\"\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":"Documents","description":"Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml get /companies/{kyckrId}/documents","href":"/api-reference/companies/documents","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Documents","responses":{"200":"efe2f735-8a0e-42ca-a084-eeaa1fed69b4","400":"75beb878-5720-4689-aaf8-4a40510ec693","401":"f4e5e0d0-c6e4-4661-b0a1-61b93f29780d","403":"58e2c8d3-2f91-4c0d-960b-c113a917b7f4","404":"ea6c7bc7-b572-4478-bfff-75974c081908","429":"8357e7f8-b368-468a-a2e5-5dbb5002ef1b"},"operationId":"get-companies-kyckrId-documents","description":"Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.","parameters":["b9747440-9867-4525-a76c-997b6663cf6a"],"tags":["Companies"],"method":"get","type":"path","servers":["52056110-dacd-42df-b277-b4df3b874155","6582fdfb-ba6b-4769-a3c2-70b187893c91"],"security":["21181e8a-db2f-43ce-8605-55452752624c"],"path":"/companies/{kyckrId}/documents","baseUrlOptions":["https://api.kyckr.com/v2","https://test-api.kyckr.com/v2"],"title":"Documents","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b9747440-9867-4525-a76c-997b6663cf6a":{"schema":{"type":"string","description":"Opaque token returned in the previous response. When provided, the API returns the next page of documents (e.g. next 100 filings). When the previous response had no continuationKey, there are no more pages.","uniqueKey":"","typeLabel":"string"},"in":"query","name":"continuationKey","description":"Opaque token returned in the previous response. When provided, the API returns the next page of documents (e.g. next 100 filings). When the previous response had no continuationKey, there are no more pages."},"ba64c0c8-4ae2-46fe-9b06-4291e004aa47":{"name":"kyckrId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Kyckr company reference, a shared format, usable across our V2 APIs","uniqueKey":"","typeLabel":"string"},"description":"Kyckr company reference, a shared format, usable across our V2 APIs","example":"GB|MTE2NTUyOTA"},"31ca94c0-89d5-4e30-a196-9cfb58df0bdb":{"name":"customerReference","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Optional reference supplied by customer for tracking purposes","uniqueKey":"","typeLabel":"string"},"description":"Optional reference supplied by customer for tracking purposes"}},"responses":{"efe2f735-8a0e-42ca-a084-eeaa1fed69b4":{"description":"OK","content":{"application/json":{"schema":{"type":"object","title":"BaseResponse","description":"","properties":{"orderId":{"type":"string","example":"12345","description":"The related orderId.","uniqueKey":"orderId","typeLabel":"string"},"correlationId":{"type":"string","description":"The related correlationId to this request, for support purposes. \r\n","uniqueKey":"correlationId","typeLabel":"string"},"customerReference":{"type":"string","description":"A customer provided reference, which appears in the order list.","uniqueKey":"customerReference","typeLabel":"string"},"timeStamp":{"type":"string","format":"date-time","description":"The UTC time at which the request occurred.","uniqueKey":"timeStamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"string","description":"The response status details for the current request. ","uniqueKey":"details","typeLabel":"string"},"cost":{"type":"object","description":"Cost of an item","properties":{"type":{"type":"string","enum":["credit","lite"],"example":"credit","uniqueKey":"cost.type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","example":3,"uniqueKey":"cost.value","typeLabel":"number"}},"uniqueKey":"cost","typeLabel":"object"},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference","example":"/orders/12345","uniqueKey":"links.self","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"links","typeLabel":"object"},"data":{"type":"array","items":{"title":"DocumentDescription","type":"object","properties":{"id":{"type":"string","description":"Product ID","uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"cost":{"type":"object","description":"Cost of an item","properties":{"type":{"type":"string","enum":["credit","lite"],"example":"credit","uniqueKey":"data.items.[INDEX].cost.type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","example":3,"uniqueKey":"data.items.[INDEX].cost.value","typeLabel":"number"}},"uniqueKey":"data.items.[INDEX].cost","typeLabel":"object"},"name":{"type":"string","description":"Name of document","example":"Form 15 - Annual Accounts 2021/22","uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"documentDate":{"description":"The date associated with the document, usually the filing date","type":"string","format":"date","uniqueKey":"data.items.[INDEX].documentDate","typeLabel":"string\u003cdate>"},"category":{"type":"string","description":"Type of document","example":"Annual Accounts","uniqueKey":"data.items.[INDEX].category","typeLabel":"string"},"deliveryTimeMinutes":{"type":"integer","description":"Target delivery time in minutes","example":15,"uniqueKey":"data.items.[INDEX].deliveryTimeMinutes","typeLabel":"integer"},"documentFormat":{"type":"array","description":"A list of mime-types for files that will be returned for an order","example":["application/pdf"],"minItems":1,"uniqueItems":true,"items":{"type":"string","enum":["application/pdf","application/json","application/zip","application/xml"],"uniqueKey":"data.items.[INDEX].documentFormat.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"data.items.[INDEX].documentFormat","typeLabel":"enum\u003cstring>[]"},"documentDatapoints":{"type":"object","properties":{"companyDetails":{"type":"boolean","uniqueKey":"data.items.[INDEX].documentDatapoints.companyDetails","typeLabel":"boolean"},"directors":{"type":"boolean","uniqueKey":"data.items.[INDEX].documentDatapoints.directors","typeLabel":"boolean"},"shareholders":{"type":"boolean","uniqueKey":"data.items.[INDEX].documentDatapoints.shareholders","typeLabel":"boolean"},"declaredBeneficialOwners":{"type":"boolean","uniqueKey":"data.items.[INDEX].documentDatapoints.declaredBeneficialOwners","typeLabel":"boolean"}},"uniqueKey":"data.items.[INDEX].documentDatapoints","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"DocumentDescription · object"},"uniqueKey":"data","typeLabel":"DocumentDescription · object[]"},"continuationKey":{"oneOf":[{"type":"string","description":"When present, pass this value as the continuationKey query parameter on the next request to retrieve the next page of documents. When absent, there are no more pages.","uniqueKey":"continuationKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"When present, pass this value as the continuationKey query parameter on the next request to retrieve the next page of documents. When absent, there are no more pages.","uniqueKey":"continuationKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"continuationKey","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"BaseResponse · object"},"examples":{"Example":{"title":"Example","value":{"orderId":"12345","correlationId":"\u003cstring>","customerReference":"\u003cstring>","timeStamp":"2023-11-07T05:31:56Z","details":"\u003cstring>","cost":{"type":"credit","value":3},"links":{"self":"/orders/12345"},"data":[{"id":"\u003cstring>","cost":{"type":"credit","value":3},"name":"Form 15 - Annual Accounts 2021/22","documentDate":"2023-12-25","category":"Annual Accounts","deliveryTimeMinutes":15,"documentFormat":["application/pdf"],"documentDatapoints":{"companyDetails":true,"directors":true,"shareholders":true,"declaredBeneficialOwners":true}}],"continuationKey":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"75beb878-5720-4689-aaf8-4a40510ec693":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","title":"BaseResponse","description":"","properties":{"orderId":{"type":"string","example":"12345","description":"The related orderId.","uniqueKey":"orderId","typeLabel":"string"},"correlationId":{"type":"string","description":"The related correlationId to this request, for support purposes. \r\n","uniqueKey":"correlationId","typeLabel":"string"},"customerReference":{"type":"string","description":"A customer provided reference, which appears in the order list.","uniqueKey":"customerReference","typeLabel":"string"},"timeStamp":{"type":"string","format":"date-time","description":"The UTC time at which the request occurred.","uniqueKey":"timeStamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"string","description":"The response status details for the current request. ","uniqueKey":"details","typeLabel":"string"},"cost":{"type":"object","description":"Cost of an item","properties":{"type":{"type":"string","enum":["credit","lite"],"example":"credit","uniqueKey":"cost.type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","example":3,"uniqueKey":"cost.value","typeLabel":"number"}},"uniqueKey":"cost","typeLabel":"object"},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference","example":"/orders/12345","uniqueKey":"links.self","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"links","typeLabel":"object"},"data":{"title":"Problem Details","type":"object","properties":{"type":{"type":"string","uniqueKey":"data.type","typeLabel":"string"},"title":{"type":"string","uniqueKey":"data.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"data.detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"data.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.errors","typeLabel":"string[]"}},"uniqueKey":"data","typeLabel":"Problem Details · object"}},"uniqueKey":"","typeLabel":"BaseResponse · object"},"examples":{"Missing Parameter":{"title":"Missing Parameter","value":{"orderId":12345,"correlationId":"string","customerReference":"string","timeStamp":"2019-08-24T14:15:22Z","details":"string","cost":{"type":"credit","value":0},"links":{"self":"../dictionary"},"data":{"type":"https://httpstatuses.com/400","title":"Missing Parameter","detail":"The `isoCode` parameter is required","errors":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"f4e5e0d0-c6e4-4661-b0a1-61b93f29780d":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","title":"BaseResponse","description":"","properties":{"orderId":{"type":"string","example":"12345","description":"The related orderId.","uniqueKey":"orderId","typeLabel":"string"},"correlationId":{"type":"string","description":"The related correlationId to this request, for support purposes. \r\n","uniqueKey":"correlationId","typeLabel":"string"},"customerReference":{"type":"string","description":"A customer provided reference, which appears in the order list.","uniqueKey":"customerReference","typeLabel":"string"},"timeStamp":{"type":"string","format":"date-time","description":"The UTC time at which the request occurred.","uniqueKey":"timeStamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"string","description":"The response status details for the current request. ","uniqueKey":"details","typeLabel":"string"},"cost":{"type":"object","description":"Cost of an item","properties":{"type":{"type":"string","enum":["credit","lite"],"example":"credit","uniqueKey":"cost.type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","example":3,"uniqueKey":"cost.value","typeLabel":"number"}},"uniqueKey":"cost","typeLabel":"object"},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference","example":"/orders/12345","uniqueKey":"links.self","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"links","typeLabel":"object"},"data":{"title":"Problem Details","type":"object","properties":{"type":{"type":"string","uniqueKey":"data.type","typeLabel":"string"},"title":{"type":"string","uniqueKey":"data.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"data.detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"data.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.errors","typeLabel":"string[]"}},"uniqueKey":"data","typeLabel":"Problem Details · object"}},"uniqueKey":"","typeLabel":"BaseResponse · object"},"examples":{"Unauthorized":{"title":"Unauthorized","value":{"orderId":12345,"correlationId":"string","customerReference":"string","timeStamp":"2019-08-24T14:15:22Z","details":"string","cost":{"type":"credit","value":0},"links":{"self":"../dictionary"},"data":{"type":"https://httpstatuses.com/401","title":"Unauthorized","detail":"Please authorize before making requests","errors":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"58e2c8d3-2f91-4c0d-960b-c113a917b7f4":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","title":"BaseResponse","description":"","properties":{"orderId":{"type":"string","example":"12345","description":"The related orderId.","uniqueKey":"orderId","typeLabel":"string"},"correlationId":{"type":"string","description":"The related correlationId to this request, for support purposes. \r\n","uniqueKey":"correlationId","typeLabel":"string"},"customerReference":{"type":"string","description":"A customer provided reference, which appears in the order list.","uniqueKey":"customerReference","typeLabel":"string"},"timeStamp":{"type":"string","format":"date-time","description":"The UTC time at which the request occurred.","uniqueKey":"timeStamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"string","description":"The response status details for the current request. ","uniqueKey":"details","typeLabel":"string"},"cost":{"type":"object","description":"Cost of an item","properties":{"type":{"type":"string","enum":["credit","lite"],"example":"credit","uniqueKey":"cost.type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","example":3,"uniqueKey":"cost.value","typeLabel":"number"}},"uniqueKey":"cost","typeLabel":"object"},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference","example":"/orders/12345","uniqueKey":"links.self","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"links","typeLabel":"object"},"data":{"title":"Problem Details","type":"object","properties":{"type":{"type":"string","uniqueKey":"data.type","typeLabel":"string"},"title":{"type":"string","uniqueKey":"data.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"data.detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"data.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.errors","typeLabel":"string[]"}},"uniqueKey":"data","typeLabel":"Problem Details · object"}},"uniqueKey":"","typeLabel":"BaseResponse · object"},"examples":{"Forbidden":{"title":"Forbidden","value":{"orderId":12345,"correlationId":"string","customerReference":"string","timeStamp":"2019-08-24T14:15:22Z","details":"string","cost":{"type":"credit","value":0},"links":{"self":"../dictionary"},"data":{"type":"https://httpstatuses.com/403","title":"Forbidden","detail":"This feature is not available on this account","errors":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"ea6c7bc7-b572-4478-bfff-75974c081908":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","title":"BaseResponse","description":"","properties":{"orderId":{"type":"string","example":"12345","description":"The related orderId.","uniqueKey":"orderId","typeLabel":"string"},"correlationId":{"type":"string","description":"The related correlationId to this request, for support purposes. \r\n","uniqueKey":"correlationId","typeLabel":"string"},"customerReference":{"type":"string","description":"A customer provided reference, which appears in the order list.","uniqueKey":"customerReference","typeLabel":"string"},"timeStamp":{"type":"string","format":"date-time","description":"The UTC time at which the request occurred.","uniqueKey":"timeStamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"string","description":"The response status details for the current request. ","uniqueKey":"details","typeLabel":"string"},"cost":{"type":"object","description":"Cost of an item","properties":{"type":{"type":"string","enum":["credit","lite"],"example":"credit","uniqueKey":"cost.type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","example":3,"uniqueKey":"cost.value","typeLabel":"number"}},"uniqueKey":"cost","typeLabel":"object"},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference","example":"/orders/12345","uniqueKey":"links.self","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"links","typeLabel":"object"},"data":{"title":"Problem Details","type":"object","properties":{"type":{"type":"string","uniqueKey":"data.type","typeLabel":"string"},"title":{"type":"string","uniqueKey":"data.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"data.detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"data.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.errors","typeLabel":"string[]"}},"uniqueKey":"data","typeLabel":"Problem Details · object"}},"uniqueKey":"","typeLabel":"BaseResponse · object"},"examples":{"Not Found":{"title":"Not Found","value":{"orderId":12345,"correlationId":"string","customerReference":"string","timeStamp":"2019-08-24T14:15:22Z","details":"string","cost":{"type":"credit","value":0},"links":{"self":"../dictionary"},"data":{"type":"https://httpstatuses.com/404","title":"Not Found","detail":"This resource could not be found","errors":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"8357e7f8-b368-468a-a2e5-5dbb5002ef1b":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","title":"BaseResponse","description":"","properties":{"orderId":{"type":"string","example":"12345","description":"The related orderId.","uniqueKey":"orderId","typeLabel":"string"},"correlationId":{"type":"string","description":"The related correlationId to this request, for support purposes. \r\n","uniqueKey":"correlationId","typeLabel":"string"},"customerReference":{"type":"string","description":"A customer provided reference, which appears in the order list.","uniqueKey":"customerReference","typeLabel":"string"},"timeStamp":{"type":"string","format":"date-time","description":"The UTC time at which the request occurred.","uniqueKey":"timeStamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"string","description":"The response status details for the current request. ","uniqueKey":"details","typeLabel":"string"},"cost":{"type":"object","description":"Cost of an item","properties":{"type":{"type":"string","enum":["credit","lite"],"example":"credit","uniqueKey":"cost.type","typeLabel":"enum\u003cstring>"},"value":{"type":"number","example":3,"uniqueKey":"cost.value","typeLabel":"number"}},"uniqueKey":"cost","typeLabel":"object"},"links":{"type":"object","properties":{"self":{"type":"string","format":"uri-reference","example":"/orders/12345","uniqueKey":"links.self","typeLabel":"string\u003curi-reference>"}},"uniqueKey":"links","typeLabel":"object"},"data":{"title":"Problem Details","type":"object","properties":{"type":{"type":"string","uniqueKey":"data.type","typeLabel":"string"},"title":{"type":"string","uniqueKey":"data.title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"data.detail","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"data.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.errors","typeLabel":"string[]"}},"uniqueKey":"data","typeLabel":"Problem Details · object"}},"uniqueKey":"","typeLabel":"BaseResponse · object"},"examples":{"Rate limit exceeded":{"title":"Rate limit exceeded","value":{"orderId":12345,"correlationId":"string","customerReference":"string","timeStamp":"2019-08-24T14:15:22Z","details":"string","cost":{"type":"credit","value":0},"links":{"self":"../dictionary"},"data":{"type":"https://httpstatuses.com/429","title":"Too Many Requests","detail":"This service rate limit has been reached","errors":[]}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"21181e8a-db2f-43ce-8605-55452752624c":{"AuthHeader":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"AuthHeader"}}},"servers":{"52056110-dacd-42df-b277-b4df3b874155":{"url":"https://api.kyckr.com/v2","description":"Production"},"6582fdfb-ba6b-4769-a3c2-70b187893c91":{"url":"https://test-api.kyckr.com/v2","description":"Testing"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"AuthHeader"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"AuthHeader","name":"Authorization"}],"title":"AuthHeader"}]},"originalFileLocation":"openapi/company_v2.yaml"},"subdomain":"kyckr-0823abd6","siteName":"Kyckr Developer Portal","title":"Documents - Kyckr Developer Portal","navMaps":{"firstHrefInVersion":{"Company V2":{"href":"/api-reference/companies/documents","matchLevel":0},"Company V1":{"href":"/Introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T16:50:59.061Z","originalFileLocation":"api-reference/companies/documents.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kyckr Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kyckr-0823abd6/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kyckr-0823abd6/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kyckr-0823abd6/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kyckr-0823abd6/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Documents - Kyckr Developer Portal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kyckr Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.kyckr.com/api-reference/companies/documents\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kyckr-0823abd6.mintlify.site/_mintlify/api/og/v2?division=Companies\u0026amp;title=Documents\u0026amp;description=Retrieve+a+list+of+available+documents+for+a+company.++After+finding+a+document+of+interest%2C+use+the+Create+Order+API+to+order+a+copy+of+the+document.\u0026amp;theme=49b3d6ccc6497baec79937a6\u0026amp;signature=315a34ffc46fbe7631431a77f21be260ef13e8550e74879019ffb5691a090f5c\">\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=\"Documents - Kyckr Developer Portal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kyckr-0823abd6.mintlify.site/_mintlify/api/og/v2?division=Companies\u0026amp;title=Documents\u0026amp;description=Retrieve+a+list+of+available+documents+for+a+company.++After+finding+a+document+of+interest%2C+use+the+Create+Order+API+to+order+a+copy+of+the+document.\u0026amp;theme=49b3d6ccc6497baec79937a6\u0026amp;signature=315a34ffc46fbe7631431a77f21be260ef13e8550e74879019ffb5691a090f5c\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/kyckr-0823abd6/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kyckr Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A955D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.kyckr.com/api-reference/companies/documents\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/companies/documents.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.kyckr.com/#organization\",\"name\":\"Kyckr Developer Portal\",\"url\":\"https://developer.kyckr.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kyckr-0823abd6/9HYzjBYpwF1KfywI/logo/kyckr-light.svg?fit=max\u0026auto=format\u0026n=9HYzjBYpwF1KfywI\u0026q=85\u0026s=20b2e45cb5a675284a993a6e1a528191\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.kyckr.com#website\",\"name\":\"Kyckr Developer Portal\",\"url\":\"https://developer.kyckr.com\",\"publisher\":{\"@id\":\"https://developer.kyckr.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.kyckr.com/api-reference/companies/documents#webpage\",\"url\":\"https://developer.kyckr.com/api-reference/companies/documents\",\"name\":\"Documents\",\"description\":\"Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.\",\"dateModified\":\"2026-11-10T16:50:59.061Z\",\"isPartOf\":{\"@id\":\"https://developer.kyckr.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.kyckr.com/api-reference/companies/documents#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.kyckr.com/api-reference/companies/documents#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Company V2 API\",\"item\":\"https://developer.kyckr.com/company-v2/api-reference/changelog\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Companies\",\"item\":\"https://developer.kyckr.com/api-reference/companies/search-for-companies\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Documents\",\"item\":\"https://developer.kyckr.com/api-reference/companies/documents\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.kyckr.com/api-reference/companies/documents#apireference\",\"headline\":\"Documents\",\"name\":\"Documents\",\"description\":\"Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.\",\"url\":\"https://developer.kyckr.com/api-reference/companies/documents\",\"mainEntityOfPage\":{\"@id\":\"https://developer.kyckr.com/api-reference/companies/documents#webpage\"},\"dateModified\":\"2026-11-10T16:50:59.061Z\",\"publisher\":{\"@id\":\"https://developer.kyckr.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.kyckr.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kyckr Developer Portal\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Kyckr Developer Portal\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/companies/documents.md","siteName":"Kyckr Developer Portal","nav":{"global":null,"versions":[{"version":"Company V2","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/Introduction"}]},{"tab":"API Reference","groups":[{"group":"About","pages":[{"title":"Overview","href":"/company-v2/api-reference/overview"}]},{"group":"Company V2 API","pages":[{"title":"Changelog","href":"/company-v2/api-reference/changelog"},{"group":"Companies","pages":[{"title":"Search for companies","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml get /companies","href":"/api-reference/companies/search-for-companies"},{"title":"Lite Profile","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml get /companies/{kyckrId}/lite","href":"/api-reference/companies/lite-profile"},{"title":"Enhanced Profile","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml get /companies/{kyckrId}/enhanced","href":"/api-reference/companies/enhanced-profile"},{"title":"Request Enhanced Profile","description":"**Recommended pattern for production integrations.** Creates a request for an enhanced company profile and returns an orderId immediately, with no server-side connection hold. Use GET /orders/{orderId} to retrieve the profile when ready. The resulting profile data is identical to that returned by a successful GET 200 on this resource.\n\nHolding connections server-side costs infrastructure capacity at scale. POST + poll avoids that cost: the server acknowledges immediately, and the client polls at its own cadence. This is the preferred pattern for high-volume pipelines and resource-conscious integrations.\n\nGET is also available for ad-hoc or low-volume use (one-off scripts, manual exploration): it returns data directly when available in time and automatically falls back to 202 with an orderId otherwise.\n\nProfile content (where filed in structured form at the registry):\n- Registration Information (Lite Profile + expanded details where available)\n- Share capital structure\n- Company Officials (incl. Directors) – including function, date of birth and address.\n- Shareholders (Beneficial owners) – including share count, share percentage and ID information.\n- Ultimate Beneficial Owners – where filed in structured form.\n","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml post /companies/{kyckrId}/enhanced","href":"/api-reference/companies/request-enhanced-profile"},{"title":"Documents","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml get /companies/{kyckrId}/documents","href":"/api-reference/companies/documents"}]},{"group":"Orders","pages":[{"title":"Get List of Orders","description":"List all orders","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml get /orders","href":"/api-reference/orders/get-list-of-orders"},{"title":"Create Order","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml post /orders","href":"/api-reference/orders/create-order"},{"title":"Get Single Order","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml get /orders/{orderId}","href":"/api-reference/orders/get-single-order"},{"title":"Download Order Payload","deprecated":null,"version":null,"openapi":"/openapi/company_v2.yaml get /orders/{orderId}/download","href":"/api-reference/orders/download-order-payload"}]}]},{"group":"UBO Register API","pages":[{"title":"Changelog","href":"/bo-v2/changelog"},{"group":"Data Model","pages":[{"title":"UBO Register Profile","href":"/bo-v2/schemas/bo-profile"}]},{"group":"Operations","pages":[{"title":"Order a UBO Register Profile","deprecated":null,"version":null,"openapi":"/openapi/bo_v2.yaml post /companies/{kyckrId}/uboregister","href":"/api-reference/operations/order-a-ubo-register-profile"}]}]}]},{"tab":"Developer News","pages":[{"title":"Developer News","href":"/company-v2/developer-news"}]},{"tab":"Country Guides","pages":[{"title":"Country Guides","href":"/country-guides/austria"}]},{"tab":"UBO Verify V2 (Preview)","hidden":true,"pages":[{"title":"UBO Verify V2 (Preview)","href":"/ubo-v2/guides/getting-started"}]}]},{"version":"Company V1","pages":[{"title":"Company V1","href":"/Introduction"}]}]},"basePath":"","title":"Documents - Kyckr Developer Portal","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}