Returns the documents your entities own, newest first: compliance policies, contracts and free-form files, with their version history.Deleted documents are excluded.
Metadata only. No download URL is returned here. s3VersionId identifies a version; it is not a link and cannot be fetched. To download a document, pass its id to Get a Download URL for a Document.
Narrowing
downstreamEntityId limits the list to one entity, category to one document category.
Authorizations
bearerrestricted-access-token
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
page
integer
default:1
1-based page number
Required range: x >= 1
Example:
1
limit
integer
default:50
Page size (max 100)
Required range: 1 <= x <= 100
Example:
50
downstreamEntityId
string
Narrow the results to a single entity in your organization. Defaults to your whole subtree (your entity plus every branch beneath it). Returns 404 if the id is not in your subtree.
Example:
"6610b3d2c2e0a51b8c0d1f02"
category
enum<string>
Return only documents in this category. Defaults to every category.
Available options:
W9,
E&O,
Cyber,
Producer Agreement,
Crime & Fidelity,
Other Contract,
Other Document,
Payment Details,
License PDF,
Contract Container Folder Document,
Surplus Lines,
Surplus Lines Tax Certification,
Surplus Lines Diligent Effort,
Surety Bond,
custom question upload,
market onboarding email attachment,
market application pack source
Example:
"E&O"
Response
A page of documents
data
object
required
Show child attributes
requestId
string
required
Unique request identifier
Example:
"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8"
timestamp
string
required
Response timestamp
Example:
"2025-11-12T20:49:03.293Z"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Turris Public API","description":"API documentation for the Turris Public API - programmatic access to compliance data for carrier and agency customers.","colors":{"primary":"#006cff","light":"#3389ff","dark":"#0a58c2"},"favicon":"https://mintcdn.com/turris/IfRLPQPmyFYwsFZX/favicon.png?fit=max\u0026auto=format\u0026n=IfRLPQPmyFYwsFZX\u0026q=85\u0026s=21d205b6e3e2b8abe477c8c7aed40817","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"],"prefill":true}},"navbar":{"links":[{"href":"mailto:support@turrisfi.com","label":"Support"}],"primary":{"type":"button","label":"Web App (Live)","href":"https://www.app.live.turrisfi.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/turrisfi"},"links":[{"header":"Resources","items":[{"label":"Website","href":"https://www.turrisfi.com"},{"label":"Web App (Live)","href":"https://www.app.live.turrisfi.com"},{"label":"Web App (Sandbox)","href":"https://www.app.sandbox.turrisfi.com"},{"label":"Support Articles","href":"https://help.turrisfi.com"}]}]},"contextual":{"options":["mcp","cursor","vscode","copy","claude","chatgpt"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"turris","hasAudioNarration":false,"actualSubdomain":"turris","customDomains":["docs.turrisfi.com"],"gitSource":{"type":"github","owner":"turrisfi","repo":"compliance","deployBranch":"prod","contentDirectory":"apps/public-api/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af746a0116b25a832ec7361","clientVersion":"0.0.4142","searchFilterCounts":[{"language":"default","tag":"Carrier \u0026 MGA API","count":146},{"language":"default","tag":"Agency API","count":56},{"language":"default","tag":"Surplus Lines","count":24},{"language":"default","tag":"Webhooks","count":23},{"language":"default","tag":"Webhook Events","count":18},{"language":"default","tag":"Policy Ingestion","count":14},{"language":"default","tag":"Agencies You Appoint","count":13},{"language":"default","tag":"Licenses","count":13},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Filings","count":12}],"searchSettings":{"isFiltersEnabled":true,"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@turrisfi.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"698de0cb27f1502f3265ea3b","deploymentId":"697d034dc7078c59853e519b","questionText":"How can I get my agencies' and agents' compliance status?","status":"active","generatedBy":"manual","createdAt":"2026-02-12T14:16:43.973Z","updatedAt":"2026-02-12T14:16:43.973Z","__v":0},{"_id":"698de0b027f1502f3265ea0c","deploymentId":"697d034dc7078c59853e519b","questionText":"How can I retrieve all my agencies and agents?","status":"active","generatedBy":"manual","createdAt":"2026-02-12T14:16:16.437Z","updatedAt":"2026-02-12T14:16:16.437Z","__v":0},{"_id":"698de08d27f1502f3265e9c4","deploymentId":"697d034dc7078c59853e519b","questionText":"How do I get authenticated?","status":"active","generatedBy":"manual","createdAt":"2026-02-12T14:15:41.708Z","updatedAt":"2026-02-12T14:15:41.708Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2/downstream/documents/list-documents","slug":"/api-reference/v2/downstream/documents/list-documents","pageMetadata":{"title":"List Documents","description":"The files your entities hold","openapi":"openapi/v2.json GET /v2/downstream/documents","href":"/api-reference/v2/downstream/documents/list-documents"},"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: \"The files your entities hold\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Returns the documents your entities own, newest first: compliance policies, contracts and free-form files, with their version history.`}),`\n`,_jsx(_components.p,{children:`Deleted documents are excluded.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Metadata only.`}),` No download URL is returned here. `,_jsx(_components.code,{children:`s3VersionId`}),` identifies a version; it is not a link and cannot be fetched. To download a document, pass its id to `,_jsx(_components.a,{href:`/api-reference/v2/downstream/documents/get-download-url`,children:`Get a Download URL for a Document`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`narrowing`,children:`Narrowing`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`downstreamEntityId`}),` limits the list to one entity, `,_jsx(_components.code,{children:`category`}),` to one document category.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Documents","description":"The files your entities hold","openapi":"openapi/v2.json GET /v2/downstream/documents","href":"/api-reference/v2/downstream/documents/list-documents"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Narrowing","slug":"narrowing","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/turris/0c051c093ff073c0/scripts/filter-openapi.js"],"openApiReferenceData":{"operation":{"description":"The files your entities hold","operationId":"DocumentsController_getDocuments_v2","parameters":["2c7b6f66-3517-43c2-8ef1-5790c206d750","b9083719-883b-445b-89e5-98aef08c1799","34028c0d-19be-4daa-9cc2-b01efc575651","8f89503c-706d-4558-9d8a-e9dd2da79c2e"],"responses":{"200":"abb2dcab-99f3-4c6f-84b0-2fac4c5abdcf","400":"116bde6f-bfbc-4fea-ae59-d52a5c5f6337","401":"dbaf3fc3-b58a-4aa7-bcad-32b62fff099d","403":"f5e3b569-c0f6-4055-ba40-cc00cb63d647","404":"703a4e1a-b33a-417c-b691-9370c3c7e795","429":"2b18ae0a-a5ae-45e6-abce-4532920abbbd"},"summary":"List documents","tags":["downstream/documents"],"method":"get","type":"path","servers":["a33906df-e90b-4f98-81da-a83fb62cf412","42b23b4d-da36-433a-b913-09118b1aa0c5"],"security":["04537f3b-6a17-4501-8e05-0cec15cbdb33","44169bb9-f377-4ba1-b6a8-1bfdfe9c846a"],"path":"/v2/downstream/documents","baseUrlOptions":["https://public.api.live.turrisfi.com","https://public.api.sandbox.turrisfi.com"],"title":"List documents","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"2c7b6f66-3517-43c2-8ef1-5790c206d750":{"name":"page","required":false,"in":"query","description":"1-based page number","schema":{"minimum":1,"default":1,"example":1,"type":"integer","isRequired":false,"description":"1-based page number","uniqueKey":"","typeLabel":"integer"}},"b9083719-883b-445b-89e5-98aef08c1799":{"name":"limit","required":false,"in":"query","description":"Page size (max 100)","schema":{"minimum":1,"maximum":100,"default":50,"example":50,"type":"integer","isRequired":false,"description":"Page size (max 100)","uniqueKey":"","typeLabel":"integer"}},"34028c0d-19be-4daa-9cc2-b01efc575651":{"name":"downstreamEntityId","required":false,"in":"query","description":"Narrow the results to a single entity in your organization. Defaults to your whole subtree (your entity plus every branch beneath it). Returns 404 if the id is not in your subtree.","schema":{"example":"6610b3d2c2e0a51b8c0d1f02","type":"string","isRequired":false,"description":"Narrow the results to a single entity in your organization. Defaults to your whole subtree (your entity plus every branch beneath it). Returns 404 if the id is not in your subtree.","uniqueKey":"","typeLabel":"string"}},"8f89503c-706d-4558-9d8a-e9dd2da79c2e":{"name":"category","required":false,"in":"query","description":"Return only documents in this category. Defaults to every category.","schema":{"example":"E\u0026O","type":"string","enum":["W9","E\u0026O","Cyber","Producer Agreement","Crime \u0026 Fidelity","Other Contract","Other Document","Payment Details","License PDF","Contract Container Folder Document","Surplus Lines","Surplus Lines Tax Certification","Surplus Lines Diligent Effort","Surety Bond","custom question upload","market onboarding email attachment","market application pack source"],"isRequired":false,"description":"Return only documents in this category. Defaults to every category.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"abb2dcab-99f3-4c6f-84b0-2fac4c5abdcf":{"description":"A page of documents","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"fileDocumentId":{"type":"string","description":"Unique identifier of the document","example":"66a1b2c3d4e5f6a7b8c9d0e3","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].fileDocumentId","typeLabel":"string"},"name":{"type":"string","description":"Display name","example":"E\u0026O Policy","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].name","typeLabel":"string"},"category":{"type":"string","description":"Document category","enum":["W9","E\u0026O","Cyber","Producer Agreement","Crime \u0026 Fidelity","Other Contract","Other Document","Payment Details","License PDF","Contract Container Folder Document","Surplus Lines","Surplus Lines Tax Certification","Surplus Lines Diligent Effort","Surety Bond","custom question upload","market onboarding email attachment","market application pack source"],"example":"E\u0026O","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].category","typeLabel":"enum\u003cstring>"},"versions":{"description":"Stored versions, newest last. No download URL is returned here; Get a Download URL for a Document mints one.","type":"array","items":{"type":"object","properties":{"s3VersionId":{"type":"string","description":"S3 object version identifier","example":"xN3TmQ8bJ0dY5fLpQ2rV9wK1sA6cE4hZ","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].versions.items.[INDEX].s3VersionId","typeLabel":"string"},"metadataModel":{"type":"string","description":"What kind of extracted metadata exists for this version. The values are not returned.","enum":["EAndOPolicy","CyberPolicy","CrimeFidelity","W9","ProducerAgreement","OtherContract","OtherDocument","PaymentDetails","LicensePdf","SurplusLinesTaxCertificationDocument","SurplusLinesDiligentEffortDocument","SuretyBond"],"example":"EAndOPolicy","uniqueKey":"data.\\items.items.[INDEX].versions.items.[INDEX].metadataModel","typeLabel":"enum\u003cstring>"},"size":{"type":"number","description":"Size in bytes","example":284913,"uniqueKey":"data.\\items.items.[INDEX].versions.items.[INDEX].size","typeLabel":"number"},"mimeType":{"type":"string","description":"MIME type","example":"application/pdf","uniqueKey":"data.\\items.items.[INDEX].versions.items.[INDEX].mimeType","typeLabel":"string"},"originalFileName":{"type":"string","description":"File name as uploaded","example":"example-eando-2026.pdf","uniqueKey":"data.\\items.items.[INDEX].versions.items.[INDEX].originalFileName","typeLabel":"string"}},"required":["s3VersionId"],"uniqueKey":"data.\\items.items.[INDEX].versions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].versions","typeLabel":"object[]"},"subCategory":{"type":"string","description":"Free-text refinement of the category","uniqueKey":"data.\\items.items.[INDEX].subCategory","typeLabel":"string"},"createdAt":{"type":"string","description":"ISO 8601 creation timestamp","example":"2025-01-15T10:30:00.000Z","uniqueKey":"data.\\items.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"ISO 8601 last-update timestamp","example":"2026-02-12T09:00:00.000Z","uniqueKey":"data.\\items.items.[INDEX].updatedAt","typeLabel":"string"}},"required":["fileDocumentId","name","category","versions"],"uniqueKey":"data.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.\\items","typeLabel":"object[]"},"total":{"type":"integer","description":"Total rows matching the query across all pages","example":137,"isRequired":true,"uniqueKey":"data.total","typeLabel":"integer"},"page":{"type":"integer","description":"1-based page number","example":1,"isRequired":true,"uniqueKey":"data.page","typeLabel":"integer"},"limit":{"type":"integer","description":"Page size","example":50,"isRequired":true,"uniqueKey":"data.limit","typeLabel":"integer"},"totalPages":{"type":"integer","description":"Number of pages, or 0 when there are no rows","example":3,"isRequired":true,"uniqueKey":"data.totalPages","typeLabel":"integer"}},"required":["items","total","page","limit","totalPages"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"requestId":{"type":"string","description":"Unique request identifier","example":"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","description":"Response timestamp","example":"2025-11-12T20:49:03.293Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"}},"required":["data","requestId","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"items":[{"fileDocumentId":"66a1b2c3d4e5f6a7b8c9d0e3","name":"E\u0026O Policy","category":"E\u0026O","versions":[{"s3VersionId":"xN3TmQ8bJ0dY5fLpQ2rV9wK1sA6cE4hZ","metadataModel":"EAndOPolicy","size":284913,"mimeType":"application/pdf","originalFileName":"example-eando-2026.pdf"}],"subCategory":"\u003cstring>","createdAt":"2025-01-15T10:30:00.000Z","updatedAt":"2026-02-12T09:00:00.000Z"}],"total":137,"page":1,"limit":50,"totalPages":3},"requestId":"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8","timestamp":"2025-11-12T20:49:03.293Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"116bde6f-bfbc-4fea-ae59-d52a5c5f6337":{"description":"Invalid query parameters","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"requestId":{"type":"string","description":"Unique request identifier for debugging","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"errorType":{"type":"string","description":"Machine-readable error classification. Branch on this rather than on `errorMessage`, which is prose and may change. Authentication failures returned by our identity provider are forwarded verbatim, so a 401 can carry a code outside this list; treat an unrecognised value as a generic failure of its HTTP status.","enum":["conflict","contact_not_authorized","document_exceeds_page_limit","downstream_entity_member_exists","duplicate_external_id_error","duplicate_member_email","duplicate_producer_code_error","forbidden","gateway_timeout","inactive_email","internal_server_error","invalid_email","invalid_email_for_invites","invalid_organization_category","invalid_organization_slug","invalid_phone_number","invalid_token","invite_limit_reached","jwt_invalid","m2m_client_not_found","not_found","organization_already_exists","organization_slug_already_used","payment_required","producer_agreement_required","product_feature_subscription_required","service_unavailable","session_authorization_error","some_custom_error_string","throttled","too_many_requests","unauthorized","unauthorized_client","unexpected_400_stytch_error","unexpected_403_stytch_error","unexpected_404_stytch_error","unexpected_error","unexpected_stytch_error","unprocessable_entity","validation_error"],"example":"validation_error","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"Array of error messages","type":"array","items":{"type":"string","uniqueKey":"errorMessage.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string[]"},"timestamp":{"type":"string","description":"ISO timestamp when the error occurred","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"type":"object","description":"Additional error context","uniqueKey":"details","typeLabel":"object"}},"required":["statusCode","requestId","errorType","errorMessage","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"requestId":"\u003cstring>","errorType":"validation_error","errorMessage":["\u003cstring>"],"timestamp":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"dbaf3fc3-b58a-4aa7-bcad-32b62fff099d":{"description":"Invalid or missing auth token","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"requestId":{"type":"string","description":"Unique request identifier for debugging","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"errorType":{"type":"string","description":"Machine-readable error classification. Branch on this rather than on `errorMessage`, which is prose and may change. Authentication failures returned by our identity provider are forwarded verbatim, so a 401 can carry a code outside this list; treat an unrecognised value as a generic failure of its HTTP status.","enum":["conflict","contact_not_authorized","document_exceeds_page_limit","downstream_entity_member_exists","duplicate_external_id_error","duplicate_member_email","duplicate_producer_code_error","forbidden","gateway_timeout","inactive_email","internal_server_error","invalid_email","invalid_email_for_invites","invalid_organization_category","invalid_organization_slug","invalid_phone_number","invalid_token","invite_limit_reached","jwt_invalid","m2m_client_not_found","not_found","organization_already_exists","organization_slug_already_used","payment_required","producer_agreement_required","product_feature_subscription_required","service_unavailable","session_authorization_error","some_custom_error_string","throttled","too_many_requests","unauthorized","unauthorized_client","unexpected_400_stytch_error","unexpected_403_stytch_error","unexpected_404_stytch_error","unexpected_error","unexpected_stytch_error","unprocessable_entity","validation_error"],"example":"validation_error","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"Array of error messages","type":"array","items":{"type":"string","uniqueKey":"errorMessage.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string[]"},"timestamp":{"type":"string","description":"ISO timestamp when the error occurred","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"type":"object","description":"Additional error context","uniqueKey":"details","typeLabel":"object"}},"required":["statusCode","requestId","errorType","errorMessage","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"requestId":"\u003cstring>","errorType":"validation_error","errorMessage":["\u003cstring>"],"timestamp":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"f5e3b569-c0f6-4055-ba40-cc00cb63d647":{"description":"Your organization is not entitled to the public API. Also returned with `errorType` `invalid_organization_category` when your credential's organization category does not match the one this endpoint serves; `details` names the expected and actual category. This endpoint can return 403 for other reasons too, so branch on `errorType`; the Error Handling guide lists them.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"requestId":{"type":"string","description":"Unique request identifier for debugging","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"errorType":{"type":"string","description":"Machine-readable error classification. Branch on this rather than on `errorMessage`, which is prose and may change. Authentication failures returned by our identity provider are forwarded verbatim, so a 401 can carry a code outside this list; treat an unrecognised value as a generic failure of its HTTP status.","enum":["conflict","contact_not_authorized","document_exceeds_page_limit","downstream_entity_member_exists","duplicate_external_id_error","duplicate_member_email","duplicate_producer_code_error","forbidden","gateway_timeout","inactive_email","internal_server_error","invalid_email","invalid_email_for_invites","invalid_organization_category","invalid_organization_slug","invalid_phone_number","invalid_token","invite_limit_reached","jwt_invalid","m2m_client_not_found","not_found","organization_already_exists","organization_slug_already_used","payment_required","producer_agreement_required","product_feature_subscription_required","service_unavailable","session_authorization_error","some_custom_error_string","throttled","too_many_requests","unauthorized","unauthorized_client","unexpected_400_stytch_error","unexpected_403_stytch_error","unexpected_404_stytch_error","unexpected_error","unexpected_stytch_error","unprocessable_entity","validation_error"],"example":"validation_error","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"Array of error messages","type":"array","items":{"type":"string","uniqueKey":"errorMessage.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string[]"},"timestamp":{"type":"string","description":"ISO timestamp when the error occurred","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"type":"object","description":"Additional error context","uniqueKey":"details","typeLabel":"object"}},"required":["statusCode","requestId","errorType","errorMessage","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"requestId":"\u003cstring>","errorType":"validation_error","errorMessage":["\u003cstring>"],"timestamp":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"703a4e1a-b33a-417c-b691-9370c3c7e795":{"description":"downstreamEntityId is not in your organization","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"requestId":{"type":"string","description":"Unique request identifier for debugging","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"errorType":{"type":"string","description":"Machine-readable error classification. Branch on this rather than on `errorMessage`, which is prose and may change. Authentication failures returned by our identity provider are forwarded verbatim, so a 401 can carry a code outside this list; treat an unrecognised value as a generic failure of its HTTP status.","enum":["conflict","contact_not_authorized","document_exceeds_page_limit","downstream_entity_member_exists","duplicate_external_id_error","duplicate_member_email","duplicate_producer_code_error","forbidden","gateway_timeout","inactive_email","internal_server_error","invalid_email","invalid_email_for_invites","invalid_organization_category","invalid_organization_slug","invalid_phone_number","invalid_token","invite_limit_reached","jwt_invalid","m2m_client_not_found","not_found","organization_already_exists","organization_slug_already_used","payment_required","producer_agreement_required","product_feature_subscription_required","service_unavailable","session_authorization_error","some_custom_error_string","throttled","too_many_requests","unauthorized","unauthorized_client","unexpected_400_stytch_error","unexpected_403_stytch_error","unexpected_404_stytch_error","unexpected_error","unexpected_stytch_error","unprocessable_entity","validation_error"],"example":"validation_error","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"Array of error messages","type":"array","items":{"type":"string","uniqueKey":"errorMessage.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string[]"},"timestamp":{"type":"string","description":"ISO timestamp when the error occurred","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"type":"object","description":"Additional error context","uniqueKey":"details","typeLabel":"object"}},"required":["statusCode","requestId","errorType","errorMessage","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"requestId":"\u003cstring>","errorType":"validation_error","errorMessage":["\u003cstring>"],"timestamp":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"2b18ae0a-a5ae-45e6-abce-4532920abbbd":{"description":"Rate limit exceeded. Like every read on the Agency API, this endpoint allows 120 requests per 60 seconds per organization. Wait the number of seconds in the Retry-After header, then retry. Also returned when this credential passes the API-wide limit of 1000 requests per 10 seconds, counted across every endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"requestId":{"type":"string","description":"Unique request identifier for debugging","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"errorType":{"type":"string","description":"Machine-readable error classification. Branch on this rather than on `errorMessage`, which is prose and may change. Authentication failures returned by our identity provider are forwarded verbatim, so a 401 can carry a code outside this list; treat an unrecognised value as a generic failure of its HTTP status.","enum":["conflict","contact_not_authorized","document_exceeds_page_limit","downstream_entity_member_exists","duplicate_external_id_error","duplicate_member_email","duplicate_producer_code_error","forbidden","gateway_timeout","inactive_email","internal_server_error","invalid_email","invalid_email_for_invites","invalid_organization_category","invalid_organization_slug","invalid_phone_number","invalid_token","invite_limit_reached","jwt_invalid","m2m_client_not_found","not_found","organization_already_exists","organization_slug_already_used","payment_required","producer_agreement_required","product_feature_subscription_required","service_unavailable","session_authorization_error","some_custom_error_string","throttled","too_many_requests","unauthorized","unauthorized_client","unexpected_400_stytch_error","unexpected_403_stytch_error","unexpected_404_stytch_error","unexpected_error","unexpected_stytch_error","unprocessable_entity","validation_error"],"example":"validation_error","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"Array of error messages","type":"array","items":{"type":"string","uniqueKey":"errorMessage.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string[]"},"timestamp":{"type":"string","description":"ISO timestamp when the error occurred","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"type":"object","description":"Additional error context","uniqueKey":"details","typeLabel":"object"}},"required":["statusCode","requestId","errorType","errorMessage","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"requestId":"\u003cstring>","errorType":"validation_error","errorMessage":["\u003cstring>"],"timestamp":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying. Sent when a rate limit refused the request.","schema":{"type":"integer"}}},"exampleType":"generated"}},"security":{"04537f3b-6a17-4501-8e05-0cec15cbdb33":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[],"schemeName":"bearer"}},"44169bb9-f377-4ba1-b6a8-1bfdfe9c846a":{"restricted-access-token":{"type":"apiKey","in":"header","name":"x-restricted-access-token","description":"Alternative authentication: Restricted access token (if not using Bearer token)","scopes":[],"schemeName":"restricted-access-token"}}},"servers":{"a33906df-e90b-4f98-81da-a83fb62cf412":{"url":"https://public.api.live.turrisfi.com","description":"Production"},"42b23b4d-da36-433a-b913-09118b1aa0c5":{"url":"https://public.api.sandbox.turrisfi.com","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[],"schemeName":"bearer"},"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":"bearer","name":"Authorization"}],"title":"bearer"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-restricted-access-token","description":"Alternative authentication: Restricted access token (if not using Bearer token)","scopes":[],"schemeName":"restricted-access-token"},"schema":{"title":"x-restricted-access-token","type":"string","description":"Alternative authentication: Restricted access token (if not using Bearer token)","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"restricted-access-token","name":"x-restricted-access-token"}],"title":"restricted-access-token"}]},"originalFileLocation":"openapi/v2.json"},"subdomain":"turris","siteName":"Turris Public API","title":"List Documents - Turris Public API","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-06T14:07:54.612Z","originalFileLocation":"api-reference/v2/downstream/documents/list-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=\"The files your entities hold\">\u003cmeta data-mint-head name=\"application-name\" content=\"Turris Public API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/turris/UYm7mYboWneVSCYG/_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/turris/UYm7mYboWneVSCYG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/turris/UYm7mYboWneVSCYG/_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/turris/UYm7mYboWneVSCYG/_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/turris/UYm7mYboWneVSCYG/_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/turris/UYm7mYboWneVSCYG/_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/turris/UYm7mYboWneVSCYG/_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/turris/UYm7mYboWneVSCYG/_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/turris/UYm7mYboWneVSCYG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Documents - Turris Public API\">\u003cmeta data-mint-head property=\"og:description\" content=\"The files your entities hold\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Turris Public API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-documents\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://turris.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=List+Documents\u0026amp;description=The+files+your+entities+hold\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=c9f08281c715a0568ffbb98fdddc75038dbd4801201cbd410a1a3d90cad378da\">\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=\"List Documents - Turris Public API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The files your entities hold\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://turris.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=List+Documents\u0026amp;description=The+files+your+entities+hold\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=c9f08281c715a0568ffbb98fdddc75038dbd4801201cbd410a1a3d90cad378da\">\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/turris/UYm7mYboWneVSCYG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Turris Public API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006cff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-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/v2/downstream/documents/list-documents.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.turrisfi.com/#organization\",\"name\":\"Turris Public API\",\"url\":\"https://docs.turrisfi.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.turrisfi.com#website\",\"name\":\"Turris Public API\",\"url\":\"https://docs.turrisfi.com\",\"publisher\":{\"@id\":\"https://docs.turrisfi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-documents#webpage\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-documents\",\"name\":\"List Documents\",\"description\":\"The files your entities hold\",\"dateModified\":\"2026-10-06T14:07:54.612Z\",\"isPartOf\":{\"@id\":\"https://docs.turrisfi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-documents#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-documents#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Turris Public API\",\"item\":\"https://docs.turrisfi.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Documents\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-documents\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-documents#apireference\",\"headline\":\"List Documents\",\"name\":\"List Documents\",\"description\":\"The files your entities hold\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-documents\",\"mainEntityOfPage\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream/documents/list-documents#webpage\"},\"dateModified\":\"2026-10-06T14:07:54.612Z\",\"publisher\":{\"@id\":\"https://docs.turrisfi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.turrisfi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Turris Public API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Turris Public API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v2/downstream/documents/list-documents.md","siteName":"Turris Public API","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Carrier \u0026 MGA API","icon":"building-columns","versions":[{"version":"v2","default":true,"groups":[{"group":"Start Here","icon":"rocket","pages":[{"title":"The Carrier \u0026 MGA API","icon":"building-columns","href":"/guides/carrier-api"},{"title":"Getting Started for Carriers \u0026 MGAs","sidebarTitle":"Getting Started","href":"/guides/getting-started"},{"title":"Entity \u0026 Resource Definitions","href":"/guides/entity-definitions"},{"title":"Migrating from v1 to v2","href":"/guides/migration-v1-to-v2"}]},{"group":"Shared Endpoints","icon":"key","pages":[{"title":"Health Check","openapi":"openapi/v2.json GET /v2/heartbeat","href":"/api-reference/v2/heartbeat/health-check"},{"title":"Get OAuth Token","openapi":"openapi/v2.json POST /v2/auth/jwt","href":"/api-reference/v2/authentication/get-oauth-token"},{"title":"Test OAuth","openapi":"openapi/v2.json GET /v2/auth/test-oauth","href":"/api-reference/v2/authentication/test-oauth"},{"title":"Test Restricted Access Token","openapi":"openapi/v2.json GET /v2/auth/test-restricted-access-token","href":"/api-reference/v2/authentication/test-restricted-access-token"}]},{"group":"Products","icon":"box","pages":[{"title":"List Products","openapi":"openapi/v2.json GET /v2/upstream/products","href":"/api-reference/v2/products/list-products"},{"title":"Get Product","openapi":"openapi/v2.json GET /v2/upstream/products/{productId}","href":"/api-reference/v2/products/get-product"}]},{"group":"Carriers","icon":"list-check","pages":[{"title":"List Carriers","openapi":"openapi/v2.json GET /v2/upstream/carriers","href":"/api-reference/v2/carriers/list-carriers"}]},{"group":"Agencies You Appoint","icon":"building","pages":[{"title":"List Associations","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations","href":"/api-reference/v2/downstream-entity-associations/list-associations"},{"title":"Get Association","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}","href":"/api-reference/v2/downstream-entity-associations/get-association"},{"title":"Update Association","openapi":"openapi/v2.json PATCH /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}","href":"/api-reference/v2/downstream-entity-associations/update-association"},{"title":"Get Sign-In URL","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/sign-in-url","href":"/api-reference/v2/downstream-entity-associations/get-sign-in-url"},{"title":"Invite Downstream Entity","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/invite","href":"/api-reference/v2/downstream-entity-associations/invite"},{"title":"Add Downstream Entity","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/add","href":"/api-reference/v2/downstream-entity-associations/add"}]},{"group":"Contract Container Templates","icon":"file-contract","pages":[{"title":"List Contract Container Templates","openapi":"openapi/v2.json GET /v2/upstream/contract-container-templates","href":"/api-reference/v2/contract-container-templates/list"}]},{"group":"Agents","icon":"user","pages":[{"title":"List Agents","openapi":"openapi/v2.json GET /v2/upstream/agents","href":"/api-reference/v2/agents/list-agents"},{"title":"Get Agent","openapi":"openapi/v2.json GET /v2/upstream/agents/{agentId}","href":"/api-reference/v2/agents/get-agent"},{"title":"Create Agent","openapi":"openapi/v2.json POST /v2/upstream/agents","href":"/api-reference/v2/agents/create-agent"}]},{"group":"Contacts","icon":"address-book","pages":[{"title":"List Contacts","openapi":"openapi/v2.json GET /v2/upstream/contacts","href":"/api-reference/v2/contacts/list-contacts"},{"title":"Get Contact","openapi":"openapi/v2.json GET /v2/upstream/contacts/{contactId}","href":"/api-reference/v2/contacts/get-contact"}]},{"group":"Market Contacts","icon":"headset","pages":[{"title":"List Market Contacts","openapi":"openapi/v2.json GET /v2/upstream/market-contacts","href":"/api-reference/v2/market-contacts/list-market-contacts"}]},{"group":"Licenses","icon":"id-card","pages":[{"title":"Get Agent Licenses","openapi":"openapi/v2.json GET /v2/upstream/agents/{agentId}/licenses","href":"/api-reference/v2/licenses/agent-licenses"},{"title":"Get All Agent Licenses","openapi":"openapi/v2.json GET /v2/upstream/agents/licenses","href":"/api-reference/v2/licenses/all-agent-licenses"},{"title":"Get Downstream Entity Licenses","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/licenses","href":"/api-reference/v2/licenses/downstream-entity-licenses"},{"title":"Get All Downstream Entity Licenses","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/licenses","href":"/api-reference/v2/licenses/all-downstream-entity-licenses"},{"title":"Get Downstream Entity Surplus Lines Licenses","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/licenses/surplus-lines","href":"/api-reference/v2/licenses/surplus-lines"}]},{"group":"Appointments","icon":"calendar","pages":[{"title":"Get Agent Appointments","openapi":"openapi/v2.json GET /v2/upstream/agents/{agentId}/appointments","href":"/api-reference/v2/appointments/agent-appointments"},{"title":"Get Downstream Entity Appointments","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/appointments","href":"/api-reference/v2/appointments/downstream-entity-appointments"},{"title":"List Appointment Requests","openapi":"openapi/v2.json GET /v2/upstream/appointment-requests","href":"/api-reference/v2/appointments/list-appointment-requests"},{"title":"Get an Appointment Request","openapi":"openapi/v2.json GET /v2/upstream/appointment-requests/{appointmentRequestId}","href":"/api-reference/v2/appointments/get-appointment-request"},{"title":"List Termination Requests","openapi":"openapi/v2.json GET /v2/upstream/termination-requests","href":"/api-reference/v2/appointments/list-termination-requests"},{"title":"Get a Termination Request","openapi":"openapi/v2.json GET /v2/upstream/termination-requests/{terminationRequestId}","href":"/api-reference/v2/appointments/get-termination-request"}]},{"group":"Compliance Data Subscriptions","icon":"database","pages":[{"title":"Get Subscription Status","openapi":"openapi/v2.json GET /v2/upstream/compliance-data-subscriptions/{niprDataSubscriptionId}","href":"/api-reference/v2/compliance-data-subscriptions/get-status"},{"title":"Sync Downstream Entity","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/sync","href":"/api-reference/v2/compliance-data-subscriptions/sync-downstream-entity"},{"title":"Sync Agent","openapi":"openapi/v2.json POST /v2/upstream/agents/{agentId}/sync","href":"/api-reference/v2/compliance-data-subscriptions/sync-agent"}]},{"group":"Compliance Status","icon":"circle-check","pages":[{"title":"Get Agent Compliance Status","openapi":"openapi/v2.json GET /v2/upstream/agents/{agentId}/license-compliance-statuses","href":"/api-reference/v2/compliance-status/agent-compliance"},{"title":"Get Downstream Entity Compliance Status","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/license-compliance-statuses","href":"/api-reference/v2/compliance-status/downstream-entity-compliance"}]},{"group":"File Documents","icon":"file","pages":[{"title":"List Documents","openapi":"openapi/v2.json GET /v2/upstream/file-documents","href":"/api-reference/v2/file-documents/list-documents"},{"title":"Get Producer Agreement Templates","openapi":"openapi/v2.json GET /v2/upstream/file-documents","href":"/api-reference/v2/file-documents/get-producer-agreement-templates"},{"title":"Upload a Document","openapi":"openapi/v2.json POST /v2/upstream/file-documents","href":"/api-reference/v2/file-documents/upload-document"},{"title":"Get a Download URL for a Document","openapi":"openapi/v2.json GET /v2/upstream/file-documents/{fileDocumentId}/download-url","href":"/api-reference/v2/file-documents/get-download-url"}]},{"group":"Policy Ingestion","icon":"file-lines","pages":[{"title":"Policies","openapi":"openapi/v2.json GET /v2/upstream/policies","href":"/api-reference/v2/policies/list-policies"},{"title":"Policy","openapi":"openapi/v2.json GET /v2/upstream/policies/{policyId}","href":"/api-reference/v2/policies/get-policy"},{"title":"Create Policy","openapi":"openapi/v2.json POST /v2/upstream/policies","href":"/api-reference/v2/policies/create-policy"},{"title":"Update Policy","openapi":"openapi/v2.json PATCH /v2/upstream/policies/{policyId}","href":"/api-reference/v2/policies/update-policy"},{"title":"Delete Policy","openapi":"openapi/v2.json DELETE /v2/upstream/policies/{policyId}","href":"/api-reference/v2/policies/delete-policy"},{"title":"Upload Policy File","openapi":"openapi/v2.json POST /v2/upstream/policies/upload","href":"/api-reference/v2/policies/upload-policy-file"},{"title":"Uploading Status","openapi":"openapi/v2.json GET /v2/upstream/policies/uploads/{uploadId}","href":"/api-reference/v2/policies/get-upload-status"}]},{"group":"Policy Transactions","icon":"arrow-right-arrow-left","pages":[{"title":"Create Transaction","openapi":"openapi/v2.json POST /v2/upstream/policies/{policyId}/transactions","href":"/api-reference/v2/policy-transactions/create-transaction"},{"title":"List Transactions","openapi":"openapi/v2.json GET /v2/upstream/policies/{policyId}/transactions","href":"/api-reference/v2/policy-transactions/list-transactions"},{"title":"Get Transaction","openapi":"openapi/v2.json GET /v2/upstream/policies/{policyId}/transactions/{transactionId}","href":"/api-reference/v2/policy-transactions/get-transaction"},{"title":"Update Transaction","openapi":"openapi/v2.json PATCH /v2/upstream/policies/{policyId}/transactions/{transactionId}","href":"/api-reference/v2/policy-transactions/update-transaction"},{"title":"Delete Transaction","openapi":"openapi/v2.json DELETE /v2/upstream/policies/{policyId}/transactions/{transactionId}","href":"/api-reference/v2/policy-transactions/delete-transaction"}]},{"group":"Surplus Lines","icon":"file-invoice-dollar","pages":[{"group":"Guides","expanded":true,"pages":[{"title":"Open a Surplus Lines Filing from Start to Finish","sidebarTitle":"Filing Walkthrough","href":"/guides/surplus-lines-filing-walkthrough"},{"title":"Files on a Surplus Lines Filing","sidebarTitle":"Files on a Filing","href":"/guides/surplus-lines-files"}]},{"group":"Filings","expanded":true,"pages":[{"title":"Surplus Lines Filings","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-filings","href":"/api-reference/v2/surplus-lines-filings/list-filings"},{"title":"Surplus Lines Filing","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-filings/{filingId}","href":"/api-reference/v2/surplus-lines-filings/get-filing"},{"title":"Open a Surplus-Lines Filing","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings","href":"/api-reference/v2/surplus-lines-filings/open-filing"},{"title":"Attach Uploaded Files to a Checklist Item","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings/{filingId}/checklist-item/file-documents","href":"/api-reference/v2/surplus-lines-filings/attach-checklist-item-file-documents"},{"title":"Set the Policy Document","openapi":"openapi/v2.json PUT /v2/upstream/surplus-lines-filings/{filingId}/policy-document","href":"/api-reference/v2/surplus-lines-filings/set-policy-document"},{"title":"Reply to a Checklist Item Escalation","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings/{filingId}/escalation/messages","href":"/api-reference/v2/surplus-lines-filings/reply-to-escalation"}]},{"group":"States","expanded":true,"pages":[{"title":"List Surplus Lines States","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states","href":"/api-reference/v2/surplus-lines-states/list-states"},{"title":"Get State Requirements","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states/{stateCode}/requirements","href":"/api-reference/v2/surplus-lines-states/get-requirements"},{"title":"Get State Taxes and Fees","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states/{stateCode}/tax-and-fees","href":"/api-reference/v2/surplus-lines-states/get-tax-and-fees"},{"title":"Get a Download URL for a State Template File","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states/{stateCode}/template-files/{templateFileId}/download-url","href":"/api-reference/v2/surplus-lines-states/get-template-file-download-url"}]}]},{"group":"Diligent Effort","icon":"file-signature","pages":[{"title":"Request a Diligent-Effort Signature","openapi":"openapi/v2.json POST /v2/upstream/diligent-effort-requests","href":"/api-reference/v2/diligent-effort-requests/request-signature"}]},{"group":"Webhooks","icon":"bell","pages":[{"title":"Webhooks Overview","href":"/guides/webhooks"},{"group":"Webhook Events","icon":"bolt","pages":[{"title":"Agent Compliance Status Change","href":"/guides/webhooks/agent-compliance-status-change"},{"title":"Agency Compliance Status Change","href":"/guides/webhooks/downstream-entity-compliance-status-change"},{"title":"Agency Created","href":"/guides/webhooks/downstream-entity-created"},{"title":"Agency Deleted","href":"/guides/webhooks/downstream-entity-deleted"},{"title":"Agency Updated","href":"/guides/webhooks/downstream-entity-updated"},{"title":"Compliance Data Synchronized","href":"/guides/webhooks/compliance-data-synchronized"},{"title":"Producer Agreement Executed","href":"/guides/webhooks/producer-agreement-executed"},{"title":"Surplus Lines Filing Status Change","href":"/guides/webhooks/surplus-lines-filing-status-change"},{"title":"Surplus Lines Filing Action Required","href":"/guides/webhooks/surplus-lines-filing-action-required"},{"title":"Diligent Effort Form Status Change","href":"/guides/webhooks/diligent-effort-form-status-change"},{"title":"Agent Regulatory Action Added","href":"/guides/webhooks/agent-regulatory-action-added"},{"title":"Agency Regulatory Action Added","href":"/guides/webhooks/downstream-entity-regulatory-action-added"},{"title":"Agent Regulatory Action Updated","href":"/guides/webhooks/agent-regulatory-action-updated"},{"title":"Agency Regulatory Action Updated","href":"/guides/webhooks/downstream-entity-regulatory-action-updated"},{"title":"Agent License Expiring","href":"/guides/webhooks/agent-license-expiring"},{"title":"Agency License Expiring","href":"/guides/webhooks/downstream-entity-license-expiring"},{"title":"Agent License Expired","href":"/guides/webhooks/agent-license-expired"},{"title":"Agency License Expired","href":"/guides/webhooks/downstream-entity-license-expired"}]},{"title":"List Webhooks","openapi":"openapi/v2.json GET /v2/upstream/webhooks","href":"/api-reference/v2/webhooks/list-webhooks"},{"title":"Send Test Event","openapi":"openapi/v2.json POST /v2/upstream/webhooks/{webhookId}/test","href":"/api-reference/v2/webhooks/test-webhook"}]},{"group":"E\u0026O/Cyber Compliance","icon":"shield-check","pages":[{"title":"Get E\u0026O/Cyber Compliance","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/policy-compliance-statuses","href":"/api-reference/v2/eo-cyber-compliance/get-policy-compliance"}]},{"group":"Regulatory Actions","icon":"gavel","pages":[{"title":"Get Agent Regulatory Actions","openapi":"openapi/v2.json GET /v2/upstream/agents/{agentId}/regulatory-actions","href":"/api-reference/v2/regulatory-actions/agent-regulatory-actions"},{"title":"Get Downstream Entity Regulatory Actions","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/regulatory-actions","href":"/api-reference/v2/regulatory-actions/downstream-entity-regulatory-actions"}]},{"group":"Tools","icon":"wrench","pages":[{"title":"Validate NPNs","openapi":"openapi/v2.json POST /v2/upstream/npn-lookup","href":"/api-reference/v2/tools/validate-npns"}]}]},{"version":"v1","tag":"Legacy","pages":[{"title":"v1","href":"/guides/carrier-api"}]}]},{"tab":"Agency API","icon":"building-user","groups":[{"group":"Start Here","icon":"rocket","pages":[{"title":"The Agency API","icon":"building-user","href":"/guides/agency-api"},{"title":"Getting Started for Agencies","href":"/guides/downstream-getting-started"}]},{"group":"Shared Endpoints","icon":"key","pages":[{"title":"Health Check","openapi":"openapi/v2.json GET /v2/heartbeat","href":"/api-reference/v2/heartbeat/health-check"},{"title":"Get OAuth Token","openapi":"openapi/v2.json POST /v2/auth/jwt","href":"/api-reference/v2/authentication/get-oauth-token"},{"title":"Test OAuth","openapi":"openapi/v2.json GET /v2/auth/test-oauth","href":"/api-reference/v2/authentication/test-oauth"},{"title":"Test Restricted Access Token","openapi":"openapi/v2.json GET /v2/auth/test-restricted-access-token","href":"/api-reference/v2/authentication/test-restricted-access-token"}]},{"group":"Licensed Entities","icon":"sitemap","pages":[{"title":"List Licensed Entities","openapi":"openapi/v2.json GET /v2/downstream/entities","href":"/api-reference/v2/downstream/entities/list-entities"},{"title":"Get a Licensed Entity","openapi":"openapi/v2.json GET /v2/downstream/entities/{downstreamEntityId}","href":"/api-reference/v2/downstream/entities/get-entity"},{"title":"Add a Licensed Entity","openapi":"openapi/v2.json POST /v2/downstream/entities","href":"/api-reference/v2/downstream/entities/add-entity"}]},{"group":"Producers","icon":"user","pages":[{"title":"List Producers","openapi":"openapi/v2.json GET /v2/downstream/producers","href":"/api-reference/v2/downstream/producers/list-producers"},{"title":"Get a Producer","openapi":"openapi/v2.json GET /v2/downstream/producers/{producerId}","href":"/api-reference/v2/downstream/producers/get-producer"},{"title":"Add a Producer","openapi":"openapi/v2.json POST /v2/downstream/producers","href":"/api-reference/v2/downstream/producers/add-producer"},{"title":"Assign a Producer to Entities","openapi":"openapi/v2.json POST /v2/downstream/producers/{producerId}/entities","href":"/api-reference/v2/downstream/producers/assign-producer-entities"}]},{"group":"Contacts","icon":"address-book","pages":[{"title":"List Contacts","openapi":"openapi/v2.json GET /v2/downstream/contacts","href":"/api-reference/v2/downstream/contacts/list-contacts"},{"title":"Get a Contact","openapi":"openapi/v2.json GET /v2/downstream/contacts/{contactId}","href":"/api-reference/v2/downstream/contacts/get-contact"},{"title":"Look Up a Contact by Email","openapi":"openapi/v2.json GET /v2/downstream/contacts/by-email","href":"/api-reference/v2/downstream/contacts/contact-by-email"},{"title":"Add a Contact","openapi":"openapi/v2.json POST /v2/downstream/contacts","href":"/api-reference/v2/downstream/contacts/add-contact"}]},{"group":"Licenses","icon":"id-card","pages":[{"title":"List Entity Licenses","openapi":"openapi/v2.json GET /v2/downstream/entity-licenses","href":"/api-reference/v2/downstream/licenses/entity-licenses"},{"title":"List Producer Licenses","openapi":"openapi/v2.json GET /v2/downstream/producer-licenses","href":"/api-reference/v2/downstream/licenses/producer-licenses"}]},{"group":"Actions Required","icon":"bell","pages":[{"title":"Actions Required","openapi":"openapi/v2.json GET /v2/downstream/actions-required","href":"/api-reference/v2/downstream/actions-required"}]},{"group":"Licensing Overview","icon":"chart-simple","pages":[{"title":"Entity Licensing Summary","openapi":"openapi/v2.json GET /v2/downstream/entity-license-summary","href":"/api-reference/v2/downstream/license-overview/entity-license-summary"},{"title":"Entity Licensing Position by State","openapi":"openapi/v2.json GET /v2/downstream/entity-license-overview","href":"/api-reference/v2/downstream/license-overview/entity-license-overview"},{"title":"Producer Licensing Summary","openapi":"openapi/v2.json GET /v2/downstream/producer-license-summary","href":"/api-reference/v2/downstream/license-overview/producer-license-summary"},{"title":"Producer Licensing Position by State","openapi":"openapi/v2.json GET /v2/downstream/producer-license-overview","href":"/api-reference/v2/downstream/license-overview/producer-license-overview"}]},{"group":"Appointments","icon":"calendar","pages":[{"title":"List Entity Appointments","openapi":"openapi/v2.json GET /v2/downstream/entity-appointments","href":"/api-reference/v2/downstream/appointments/entity-appointments"},{"title":"List Producer Appointments","openapi":"openapi/v2.json GET /v2/downstream/producer-appointments","href":"/api-reference/v2/downstream/appointments/producer-appointments"}]},{"group":"License Requests","icon":"file-signature","pages":[{"title":"List License Requests","openapi":"openapi/v2.json GET /v2/downstream/license-requests","href":"/api-reference/v2/downstream/license-requests/list-license-requests"},{"title":"List License Renewal Batches","openapi":"openapi/v2.json GET /v2/downstream/license-request-groups","href":"/api-reference/v2/downstream/license-requests/license-request-groups"}]},{"group":"Compliance Configurations","icon":"sliders","pages":[{"title":"List Compliance Configurations","openapi":"openapi/v2.json GET /v2/downstream/compliance-configs","href":"/api-reference/v2/downstream/compliance-configs/list-compliance-configs"},{"title":"Add a Compliance Configuration","openapi":"openapi/v2.json POST /v2/downstream/compliance-configs","href":"/api-reference/v2/downstream/compliance-configs/add-compliance-config"}]},{"group":"Markets","icon":"handshake","pages":[{"title":"List Markets","openapi":"openapi/v2.json GET /v2/downstream/markets","href":"/api-reference/v2/downstream/markets/list-markets"},{"title":"Get a Market","openapi":"openapi/v2.json GET /v2/downstream/markets/{upstreamDownstreamAssociationId}","href":"/api-reference/v2/downstream/markets/get-market"},{"title":"List a Market's Contacts","openapi":"openapi/v2.json GET /v2/downstream/markets/{upstreamDownstreamAssociationId}/market-contacts","href":"/api-reference/v2/downstream/markets/market-contacts"},{"title":"List Your Own Contacts on a Market","openapi":"openapi/v2.json GET /v2/downstream/markets/{upstreamDownstreamAssociationId}/entity-contacts","href":"/api-reference/v2/downstream/markets/entity-contacts"},{"title":"List a Market's Documents","openapi":"openapi/v2.json GET /v2/downstream/markets/{upstreamDownstreamAssociationId}/documents","href":"/api-reference/v2/downstream/markets/market-documents"}]},{"group":"Corporate Registrations","icon":"stamp","pages":[{"title":"List Corporate Registration Filings","openapi":"openapi/v2.json GET /v2/downstream/corporate-registration-filings","href":"/api-reference/v2/downstream/corporate-registrations/list-filings"},{"title":"Get a Corporate Registration Filing","openapi":"openapi/v2.json GET /v2/downstream/corporate-registration-filings/{filingId}","href":"/api-reference/v2/downstream/corporate-registrations/get-filing"},{"title":"Open a Corporate Registration Filing","openapi":"openapi/v2.json POST /v2/downstream/corporate-registration-filings","href":"/api-reference/v2/downstream/corporate-registrations/open-filing"},{"title":"List Corporate Registration Profiles","description":"The standing corporate facts Turris files with","openapi":"openapi/v2.json GET /v2/downstream/corporate-registration-profiles","href":"/api-reference/v2/downstream/corporate-registrations/list-profiles"}]},{"group":"Documents","icon":"file","pages":[{"title":"List Documents","openapi":"openapi/v2.json GET /v2/downstream/documents","href":"/api-reference/v2/downstream/documents/list-documents"},{"title":"Compliance Document Status by Entity","description":"Whether each entity's four compliance slots are covered","openapi":"openapi/v2.json GET /v2/downstream/document-compliance","href":"/api-reference/v2/downstream/documents/document-compliance"},{"title":"Upload a Document","openapi":"openapi/v2.json POST /v2/downstream/documents","href":"/api-reference/v2/downstream/documents/upload-document"},{"title":"Get a Download URL for a Document","openapi":"openapi/v2.json GET /v2/downstream/documents/{fileDocumentId}/download-url","href":"/api-reference/v2/downstream/documents/get-download-url"}]},{"group":"Carriers","icon":"list-check","pages":[{"title":"List Carriers","openapi":"openapi/v2.json GET /v2/downstream/carriers","href":"/api-reference/v2/downstream/carriers/list-carriers"}]},{"group":"Surplus Lines","icon":"file-invoice-dollar","pages":[{"group":"Guides","expanded":true,"pages":[{"title":"Open a Surplus Lines Filing from Start to Finish","sidebarTitle":"Filing Walkthrough","href":"/guides/downstream-surplus-lines-filing-walkthrough"},{"title":"Files on a Surplus Lines Filing","sidebarTitle":"Files on a Filing","href":"/guides/downstream-surplus-lines-files"}]},{"group":"Filings","expanded":true,"pages":[{"title":"List Surplus-Lines Filings","openapi":"openapi/v2.json GET /v2/downstream/surplus-lines-filings","href":"/api-reference/v2/downstream/surplus-lines-filings/list-filings"},{"title":"Get a Surplus-Lines Filing","openapi":"openapi/v2.json GET /v2/downstream/surplus-lines-filings/{filingId}","href":"/api-reference/v2/downstream/surplus-lines-filings/get-filing"},{"title":"Open a Surplus-Lines Filing","openapi":"openapi/v2.json POST /v2/downstream/surplus-lines-filings","href":"/api-reference/v2/downstream/surplus-lines-filings/open-filing"},{"title":"Attach Uploaded Files to a Checklist Item","openapi":"openapi/v2.json POST /v2/downstream/surplus-lines-filings/{filingId}/checklist-item/file-documents","href":"/api-reference/v2/downstream/surplus-lines-filings/attach-checklist-item-file-documents"},{"title":"Set the Policy Document","openapi":"openapi/v2.json PUT /v2/downstream/surplus-lines-filings/{filingId}/policy-document","href":"/api-reference/v2/downstream/surplus-lines-filings/set-policy-document"},{"title":"Reply to a Checklist Item Escalation","openapi":"openapi/v2.json POST /v2/downstream/surplus-lines-filings/{filingId}/escalation/messages","href":"/api-reference/v2/downstream/surplus-lines-filings/reply-to-escalation"}]},{"group":"States","expanded":true,"pages":[{"title":"List Surplus Lines States","openapi":"openapi/v2.json GET /v2/downstream/surplus-lines-states","href":"/api-reference/v2/downstream/surplus-lines-states/list-states"},{"title":"Get State Requirements","openapi":"openapi/v2.json GET /v2/downstream/surplus-lines-states/{stateCode}/requirements","href":"/api-reference/v2/downstream/surplus-lines-states/get-requirements"},{"title":"Get State Taxes and Fees","openapi":"openapi/v2.json GET /v2/downstream/surplus-lines-states/{stateCode}/tax-and-fees","href":"/api-reference/v2/downstream/surplus-lines-states/get-tax-and-fees"},{"title":"Get a Download URL for a State Template File","openapi":"openapi/v2.json GET /v2/downstream/surplus-lines-states/{stateCode}/template-files/{templateFileId}/download-url","href":"/api-reference/v2/downstream/surplus-lines-states/get-template-file-download-url"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"List Documents - Turris Public API","buildId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","deploymentId":"dpl_G2Qd45vZZ7MkBiGF9yYx8ZsbbKXX","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-NXj-Rqjv.js","utils-m0thOP-_.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D13EKcfm.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema--XTdfsEb.js","snippetPresets-D3s4lmAH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-ChURybxL.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DL8CiXq2.js","shallow-DI2-YB2E.js","getApiPlaygroundDisplay-DxbW7b_y.js","CodeSnippet-CiNYS0pP.js","CodeSnippets-BT87bThu.js","Page-DSpdRuhM.js","getPastedJson-F_g_IrFQ.js","icon-CCIG5BAs.js","MethodPill-DY3E0jwx.js","DuplicateIcon-BN88xnEg.js","createIcon-VCCc5HO5.js","DynamicMarkdown-CaSwclgK.js","SectionHeading-DXV8nWhc.js","axios-vUo_bRtp.js","Markdown-CV32Re6G.js","clsx-5ydLOnhV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-pFDdfjRe.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BUGO5bPJ.js"]}