Opens a filing from the live state template for the named agency and returns it with the checklist and tax detail Turris will work through.downstreamEntityId must name an agency your organization is associated with. An agency outside that set returns 400.carrierId is required and names the carrier writing the policy. Take it from List Carriers, Turris’s approved carrier list. A carrier Turris does not have returns 400, and so does a body that sends carrier or carrierNaicCode, which are no longer accepted. The filing’s carrier is returned as { _id, name, companyCode }, read from the carrier record.
What is decided for you
Status is always not started
A filing is a workflow Turris runs. The statuses past the first are our operational vocabulary, not yours to declare, so the field is not accepted.
The checklist and tax rates are snapshotted, not referenced
Frozen at the moment the filing opens. Later template edits never reshape a filing that already exists.
brokerFee and otherTaxableFees default to 0
Omit either one and it is treated as 0 for the initial tax calculation. No endpoint changes a filing’s fees after it opens, so send them now if you know them. Turris fills in a fee you left out later and the tax recomputes automatically.
externalReference is a correlation id, not an idempotency key
Store your own reference on the filing and it is echoed back on every read. It does not deduplicate: sending the same value twice opens two filings. Use the idempotency-key header below for that.
One open filing per agency, state, policy number and transaction type
A second filing matching all four is refused with 409 while the first is still active. A soft-deleted filing does not block a new one.
States without a template
Turris maintains a filing template per state. A state we have not templated yet returns 404 naming the state. List Surplus Lines States returns every state you can open a filing in, and Get State Requirements what a filing there will ask for.Send an Idempotency-Key header. See Idempotency.
Authorizations
bearerrestricted-access-token
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
idempotency-key
string
UUID to ensure idempotent request processing
Example:
"550e8400-e29b-41d4-a716-446655440000"
x-idempotency-key
string
Alternative UUID header for idempotent request processing
Example:
"550e8400-e29b-41d4-a716-446655440000"
Body
application/json
downstreamEntityId
string
required
Which of your eligible agencies the filing is for. For the carrier persona, any agency you are associated with. For the agency persona, your own entity or one of its child branches.
Example:
"6610b3d2c2e0a51b8c0d1f02"
stateCode
enum<string>
required
The state or territory to file in. Turris must have a surplus-lines template for it.
Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY,
GU,
PR,
VI,
DC
Example:
"CA"
policyNumber
string
required
The policy number
Example:
"POL-2026-001"
policyTransactionType
enum<string>
required
What kind of policy transaction this filing records
Available options:
bind,
endorsement,
renewal,
cancellation
Example:
"bind"
namedInsured
string
required
The named insured on the policy
Example:
"Example Corp"
carrierId
string
required
Id of the carrier writing the policy. Take it from the List Carriers endpoint, which both the Carrier & MGA API and the Agency API serve. A carrier id Turris does not have returns 400.
Example:
"6610b3d2c2e0a51b8c0d1f09"
bindDate
string
required
Policy bind date, date-only (YYYY-MM-DD)
Example:
"2026-01-01"
effectiveDate
string
required
Policy effective date, date-only (YYYY-MM-DD)
Example:
"2026-01-01"
expirationDate
string
required
Policy expiration date, date-only (YYYY-MM-DD)
Example:
"2027-01-01"
grossPremium
number
required
Gross premium, in dollars
Example:
25000
endorsementNumber
number
Required when policyTransactionType is endorsement (enforced server-side)
Example:
1
riskAddress
string
The risk address
Example:
"123 Main St, San Francisco, CA"
nonTaxablePremium
number
Informational premium portion that is NOT taxed. Never enters the tax calculation.
Example:
0
brokerFee
number
The broker fee. Omit to let Turris fill it in later; the tax recomputes automatically.
Example:
0
otherTaxableFees
number
Other taxable fees. Omit to let Turris fill it in later; the tax recomputes automatically.
Example:
0
externalReference
string
Your own reference for this filing, echoed back on every read. A correlation id, not an idempotency key: it does not deduplicate, so a retry with the same value opens a second filing.
Example:
"REF-2026-0001"
Response
The newly-created filing
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":"6b00f57f441f0452337b1ea4","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Carrier \u0026 MGA API","count":156},{"language":"default","tag":"Agency API","count":56},{"language":"default","tag":"Webhooks","count":26},{"language":"default","tag":"Surplus Lines","count":24},{"language":"default","tag":"Webhook Events","count":21},{"language":"default","tag":"Agencies You Appoint","count":15},{"language":"default","tag":"Appointments","count":14},{"language":"default","tag":"Policy Ingestion","count":14},{"language":"default","tag":"Licenses","count":13},{"language":"default","tag":"Documentation","count":13}],"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","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/surplus-lines-filings/open-filing","slug":"/api-reference/v2/surplus-lines-filings/open-filing","pageMetadata":{"title":"Open a Surplus-Lines Filing","description":"Start a filing for one of your associated agencies","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings","href":"/api-reference/v2/surplus-lines-filings/open-filing"},"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: \"Start a filing for one of your associated agencies\"\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},{Accordion,AccordionGroup,Heading}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Opens a filing from the live state template for the named agency and returns it with the checklist and tax detail Turris will work through.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`downstreamEntityId`}),` must name an agency your organization is associated with. An agency outside that set returns `,_jsx(_components.strong,{children:`400`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`carrierId`}),` is required and names the carrier writing the policy. Take it from `,_jsx(_components.a,{href:`/api-reference/v2/carriers/list-carriers`,children:`List Carriers`}),`, Turris’s approved carrier list. A carrier Turris does not have returns `,_jsx(_components.strong,{children:`400`}),`, and so does a body that sends `,_jsx(_components.code,{children:`carrier`}),` or `,_jsx(_components.code,{children:`carrierNaicCode`}),`, which are no longer accepted. The filing’s `,_jsx(_components.code,{children:`carrier`}),` is returned as `,_jsx(_components.code,{children:`{ _id, name, companyCode }`}),`, read from the carrier record.`]}),`\n`,_jsx(Heading,{level:`2`,id:`what-is-decided-for-you`,children:`What is decided for you`}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`Status is always not started`,id:`status-is-always-not-started`,children:_jsx(_components.p,{children:`A filing is a workflow Turris runs. The statuses past the first are our operational vocabulary, not yours to declare, so the field is not accepted.`})}),_jsx(Accordion,{title:`The checklist and tax rates are snapshotted, not referenced`,id:`the-checklist-and-tax-rates-are-snapshotted-not-referenced`,children:_jsx(_components.p,{children:`Frozen at the moment the filing opens. Later template edits never reshape a filing that already exists.`})}),_jsx(Accordion,{title:`brokerFee and otherTaxableFees default to 0`,id:`brokerfee-and-othertaxablefees-default-to-0`,children:_jsxs(_components.p,{children:[`Omit either one and it is treated as `,_jsx(_components.code,{children:`0`}),` for the initial tax calculation. No endpoint changes a filing’s fees after it opens, so send them now if you know them. Turris fills in a fee you left out later and the tax recomputes automatically.`]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`externalreference-is-a-correlation-id-not-an-idempotency-key`,children:`externalReference is a correlation id, not an idempotency key`}),`\n`,_jsxs(_components.p,{children:[`Store your own reference on the filing and it is echoed back on every read. It does `,_jsx(_components.strong,{children:`not`}),` deduplicate: sending the same value twice opens two filings. Use the `,_jsx(_components.code,{children:`idempotency-key`}),` header below for that.`]}),`\n`,_jsx(Heading,{level:`2`,id:`one-open-filing-per-agency-state-policy-number-and-transaction-type`,children:`One open filing per agency, state, policy number and transaction type`}),`\n`,_jsxs(_components.p,{children:[`A second filing matching all four is refused with `,_jsx(_components.strong,{children:`409`}),` while the first is still active. A soft-deleted filing does not block a new one.`]}),`\n`,_jsx(Heading,{level:`2`,id:`states-without-a-template`,children:`States without a template`}),`\n`,_jsxs(_components.p,{children:[`Turris maintains a filing template per state. A state we have not templated yet returns `,_jsx(_components.strong,{children:`404`}),` naming the state. `,_jsx(_components.a,{href:`/api-reference/v2/surplus-lines-states/list-states`,children:`List Surplus Lines States`}),` returns every state you can open a filing in, and `,_jsx(_components.a,{href:`/api-reference/v2/surplus-lines-states/get-requirements`,children:`Get State Requirements`}),` what a filing there will ask for.`]}),`\n`,_jsxs(_components.p,{children:[`Send an `,_jsx(_components.code,{children:`Idempotency-Key`}),` header. See `,_jsx(_components.a,{href:`/guides/idempotency`,children:`Idempotency`}),`.`]})]})}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":"Open a Surplus-Lines Filing","description":"Start a filing for one of your associated agencies","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings","href":"/api-reference/v2/surplus-lines-filings/open-filing"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What is decided for you","slug":"what-is-decided-for-you","depth":2,"children":[]},{"title":"externalReference is a correlation id, not an idempotency key","slug":"externalreference-is-a-correlation-id-not-an-idempotency-key","depth":2,"children":[]},{"title":"One open filing per agency, state, policy number and transaction type","slug":"one-open-filing-per-agency-state-policy-number-and-transaction-type","depth":2,"children":[]},{"title":"States without a template","slug":"states-without-a-template","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/turris/0c051c093ff073c0/scripts/filter-openapi.js"],"openApiReferenceData":{"operation":{"description":"Start a filing for one of your associated agencies","operationId":"SurplusLinesFilingsV2Controller_createFiling_v2","parameters":["51f71f16-97b2-4ff0-969b-5109012e6219","6b1c09c7-44dc-4105-bcd0-229d4fc5da9f"],"requestBody":"35730a26-540b-43a8-9b74-11d45637d532","responses":{"201":"7fb31e8a-3656-4d94-a7f0-cf0366419067","400":"a0c6da41-6cc3-4c96-9edc-a33568012772","401":"ee32211c-ce6e-4b30-a425-182ab782a0e4","403":"7e56bf29-fc0c-4eff-9931-0b9fca2fa2db","404":"ae6db76c-aed0-4746-9d08-986b669084be","409":"6e490e10-4d05-4c67-ad62-17ab2afac75a","429":"43651b88-db3e-4dfc-99d7-ca02b8a8b487"},"summary":"Open a surplus-lines filing","tags":["upstream/surplus-lines-filings"],"method":"post","type":"path","servers":["b5db2bd0-a1cd-4527-96a0-902f1a8e1045","ad5a490d-7aa4-4717-91cf-176b7ea56114"],"security":["2a0e56fe-47b7-4cb7-bbac-a3ff39495e3e","5d1abac5-b23d-402f-b973-8d8ce38800e4"],"path":"/v2/upstream/surplus-lines-filings","baseUrlOptions":["https://public.api.live.turrisfi.com","https://public.api.sandbox.turrisfi.com"],"title":"Open a surplus-lines filing","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.downstreamEntityId":"6610b3d2c2e0a51b8c0d1f02","body.stateCode":"CA","body.policyNumber":"POL-2026-001","body.policyTransactionType":"bind","body.namedInsured":"Example Corp","body.carrierId":"6610b3d2c2e0a51b8c0d1f09","body.bindDate":"2026-01-01","body.effectiveDate":"2026-01-01","body.expirationDate":"2027-01-01","body.grossPremium":25000,"body.endorsementNumber":1,"body.riskAddress":"123 Main St, San Francisco, CA","body.nonTaxablePremium":0,"body.brokerFee":0,"body.otherTaxableFees":0,"body.externalReference":"REF-2026-0001"}]},"dependencies":{"parameters":{"51f71f16-97b2-4ff0-969b-5109012e6219":{"name":"idempotency-key","in":"header","description":"UUID to ensure idempotent request processing","required":false,"schema":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":false,"description":"UUID to ensure idempotent request processing","uniqueKey":"","typeLabel":"string"}},"6b1c09c7-44dc-4105-bcd0-229d4fc5da9f":{"name":"x-idempotency-key","in":"header","description":"Alternative UUID header for idempotent request processing","required":false,"schema":{"type":"string","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":false,"description":"Alternative UUID header for idempotent request processing","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"downstreamEntityId":{"type":"string","description":"Which of your eligible agencies the filing is for. For the carrier persona, any agency you are associated with. For the agency persona, your own entity or one of its child branches.","example":"6610b3d2c2e0a51b8c0d1f02","isRequired":true,"uniqueKey":"downstreamEntityId","typeLabel":"string"},"stateCode":{"type":"string","description":"The state or territory to file in. Turris must have a surplus-lines template for it.","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","GU","PR","VI","DC"],"example":"CA","isRequired":true,"uniqueKey":"stateCode","typeLabel":"enum\u003cstring>"},"policyNumber":{"type":"string","description":"The policy number","example":"POL-2026-001","isRequired":true,"uniqueKey":"policyNumber","typeLabel":"string"},"policyTransactionType":{"type":"string","description":"What kind of policy transaction this filing records","enum":["bind","endorsement","renewal","cancellation"],"example":"bind","isRequired":true,"uniqueKey":"policyTransactionType","typeLabel":"enum\u003cstring>"},"namedInsured":{"type":"string","description":"The named insured on the policy","example":"Example Corp","isRequired":true,"uniqueKey":"namedInsured","typeLabel":"string"},"carrierId":{"type":"string","description":"Id of the carrier writing the policy. Take it from the List Carriers endpoint, which both the Carrier \u0026 MGA API and the Agency API serve. A carrier id Turris does not have returns 400.","example":"6610b3d2c2e0a51b8c0d1f09","isRequired":true,"uniqueKey":"carrierId","typeLabel":"string"},"bindDate":{"type":"string","description":"Policy bind date, date-only (YYYY-MM-DD)","example":"2026-01-01","isRequired":true,"uniqueKey":"bindDate","typeLabel":"string"},"effectiveDate":{"type":"string","description":"Policy effective date, date-only (YYYY-MM-DD)","example":"2026-01-01","isRequired":true,"uniqueKey":"effectiveDate","typeLabel":"string"},"expirationDate":{"type":"string","description":"Policy expiration date, date-only (YYYY-MM-DD)","example":"2027-01-01","isRequired":true,"uniqueKey":"expirationDate","typeLabel":"string"},"grossPremium":{"type":"number","description":"Gross premium, in dollars","example":25000,"isRequired":true,"uniqueKey":"grossPremium","typeLabel":"number"},"endorsementNumber":{"type":"number","description":"Required when policyTransactionType is endorsement (enforced server-side)","example":1,"uniqueKey":"endorsementNumber","typeLabel":"number"},"riskAddress":{"type":"string","description":"The risk address","example":"123 Main St, San Francisco, CA","uniqueKey":"riskAddress","typeLabel":"string"},"nonTaxablePremium":{"type":"number","description":"Informational premium portion that is NOT taxed. Never enters the tax calculation.","example":0,"uniqueKey":"nonTaxablePremium","typeLabel":"number"},"brokerFee":{"type":"number","description":"The broker fee. Omit to let Turris fill it in later; the tax recomputes automatically.","example":0,"uniqueKey":"brokerFee","typeLabel":"number"},"otherTaxableFees":{"type":"number","description":"Other taxable fees. Omit to let Turris fill it in later; the tax recomputes automatically.","example":0,"uniqueKey":"otherTaxableFees","typeLabel":"number"},"externalReference":{"type":"string","description":"Your own reference for this filing, echoed back on every read. A correlation id, not an idempotency key: it does not deduplicate, so a retry with the same value opens a second filing.","example":"REF-2026-0001","uniqueKey":"externalReference","typeLabel":"string"}},"required":["downstreamEntityId","stateCode","policyNumber","policyTransactionType","namedInsured","carrierId","bindDate","effectiveDate","expirationDate","grossPremium"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"downstreamEntityId":"6610b3d2c2e0a51b8c0d1f02","stateCode":"CA","policyNumber":"POL-2026-001","policyTransactionType":"bind","namedInsured":"Example Corp","carrierId":"6610b3d2c2e0a51b8c0d1f09","bindDate":"2026-01-01","effectiveDate":"2026-01-01","expirationDate":"2027-01-01","grossPremium":25000,"endorsementNumber":1,"riskAddress":"123 Main St, San Francisco, CA","nonTaxablePremium":0,"brokerFee":0,"otherTaxableFees":0,"externalReference":"REF-2026-0001"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7fb31e8a-3656-4d94-a7f0-cf0366419067":{"description":"The newly-created filing","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier of the filing","example":"6650a1b2c3d4e5f6a7b8c9d0","isRequired":true,"uniqueKey":"data._id","typeLabel":"string"},"policyNumber":{"type":"string","description":"Policy number","example":"POL-2025-001","isRequired":true,"uniqueKey":"data.policyNumber","typeLabel":"string"},"stateCode":{"type":"string","description":"US state or territory code where the risk is located","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","GU","PR","VI","DC"],"example":"CA","isRequired":true,"uniqueKey":"data.stateCode","typeLabel":"enum\u003cstring>"},"policyTransactionType":{"type":"string","description":"Type of policy transaction","enum":["bind","endorsement","renewal","cancellation"],"example":"bind","isRequired":true,"uniqueKey":"data.policyTransactionType","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Current status of the filing","enum":["not started","in progress","ready to file","filed","completed","on hold","canceled"],"example":"in progress","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"actionRequired":{"type":"boolean","description":"True when at least one public-category escalation is waiting for the customer","isRequired":true,"uniqueKey":"data.actionRequired","typeLabel":"boolean"},"updatedAt":{"type":"string","description":"ISO 8601 timestamp of the last update","example":"2025-06-15T12:00:00.000Z","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string"},"namedInsured":{"type":"string","description":"Named insured on the policy","example":"Example Corp","isRequired":true,"uniqueKey":"data.namedInsured","typeLabel":"string"},"carrier":{"oneOf":[{"type":"object","description":"The carrier the filing is written with, read from the carrier record. Null only if that carrier record no longer exists.","required":["_id","name","companyCode"],"properties":{"_id":{"type":"string","description":"Carrier id. The value you sent as carrierId when the filing was opened","example":"6610b3d2c2e0a51b8c0d1f09","isRequired":true,"uniqueKey":"data.carrier.oneOf.0._id","typeLabel":"string"},"name":{"type":"string","description":"Carrier name","example":"Lloyds of London","isRequired":true,"uniqueKey":"data.carrier.oneOf.0.name","typeLabel":"string"},"companyCode":{"type":"string","description":"NAIC company code","example":"12345","isRequired":true,"uniqueKey":"data.carrier.oneOf.0.companyCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.carrier.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.carrier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.carrier","typeLabel":"object | null"},"grossPremium":{"type":"number","description":"Gross premium amount in USD","example":5000,"isRequired":true,"uniqueKey":"data.grossPremium","typeLabel":"number"},"escalations":{"description":"Public-category escalations for this filing (open or resolved)","type":"array","items":{"type":"object","properties":{"checklistItemLabel":{"type":"string","description":"The checklist item label this escalation is attached to","isRequired":true,"uniqueKey":"data.escalations.items.[INDEX].checklistItemLabel","typeLabel":"string"},"status":{"type":"string","description":"Current status of the escalation","enum":["waiting turris input","waiting customer input","resolved"],"example":"waiting customer input","isRequired":true,"uniqueKey":"data.escalations.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"messages":{"description":"Chronological list of messages on this escalation","type":"array","items":{"type":"object","properties":{"authorLabel":{"type":"string","description":"Display label for the message author (Turris or Agency)","example":"Turris","isRequired":true,"uniqueKey":"data.escalations.items.[INDEX].messages.items.[INDEX].authorLabel","typeLabel":"string"},"body":{"type":"string","description":"Message body text","isRequired":true,"uniqueKey":"data.escalations.items.[INDEX].messages.items.[INDEX].body","typeLabel":"string"},"createdAt":{"type":"string","description":"ISO 8601 timestamp when the message was created","example":"2025-06-01T12:00:00.000Z","isRequired":true,"uniqueKey":"data.escalations.items.[INDEX].messages.items.[INDEX].createdAt","typeLabel":"string"}},"required":["authorLabel","body","createdAt"],"uniqueKey":"data.escalations.items.[INDEX].messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.escalations.items.[INDEX].messages","typeLabel":"object[]"},"openedAt":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp when the escalation was opened","uniqueKey":"data.escalations.items.[INDEX].openedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp when the escalation was opened","uniqueKey":"data.escalations.items.[INDEX].openedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.escalations.items.[INDEX].openedAt","typeLabel":"string | null"},"resolvedAt":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp when the escalation was resolved","uniqueKey":"data.escalations.items.[INDEX].resolvedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp when the escalation was resolved","uniqueKey":"data.escalations.items.[INDEX].resolvedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.escalations.items.[INDEX].resolvedAt","typeLabel":"string | null"}},"required":["checklistItemLabel","status","messages"],"uniqueKey":"data.escalations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.escalations","typeLabel":"object[]"},"completionArtifacts":{"description":"Completion artifacts uploaded when the filing reached Completed status","type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of completion artifact","enum":["accepted stamped","receipt","confirmation","tax remittance proof"],"example":"accepted stamped","isRequired":true,"uniqueKey":"data.completionArtifacts.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"fileDocumentId":{"type":"string","description":"The document id to pass to Get a Download URL for a Document","example":"6650a1b2c3d4e5f6a7b8c9d1","isRequired":true,"uniqueKey":"data.completionArtifacts.items.[INDEX].fileDocumentId","typeLabel":"string"},"fileName":{"type":"string","description":"Original file name of the artifact","example":"stamped-filing.pdf","isRequired":true,"uniqueKey":"data.completionArtifacts.items.[INDEX].fileName","typeLabel":"string"},"uploadedAt":{"type":"string","description":"ISO 8601 timestamp when the artifact was uploaded","example":"2025-06-15T09:00:00.000Z","isRequired":true,"uniqueKey":"data.completionArtifacts.items.[INDEX].uploadedAt","typeLabel":"string"},"downloadUrl":{"type":"string","description":"Short-lived presigned URL to download the artifact file","isRequired":true,"uniqueKey":"data.completionArtifacts.items.[INDEX].downloadUrl","typeLabel":"string"},"viewUrl":{"type":"string","description":"Short-lived presigned URL to view the artifact inline in the browser","isRequired":true,"uniqueKey":"data.completionArtifacts.items.[INDEX].viewUrl","typeLabel":"string"}},"required":["type","fileDocumentId","fileName","uploadedAt","downloadUrl","viewUrl"],"uniqueKey":"data.completionArtifacts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.completionArtifacts","typeLabel":"object[]"},"checklist":{"description":"Customer-visible checklist for this filing. Internal categories are never included, so this is the outstanding work you can act on. Each item nests its own escalation; the flat escalations[] above is the same set of threads, kept for backward compatibility.","type":"array","items":{"type":"object","properties":{"sourceCategoryId":{"type":"string","description":"Identifier of the category","example":"6650a1b2c3d4e5f6a7b8c9d0","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].sourceCategoryId","typeLabel":"string"},"name":{"type":"string","description":"Category name","example":"Documents we need from you","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].name","typeLabel":"string"},"tone":{"type":"string","description":"Display tone for the category","enum":["primary","secondary","neutral","green","red","yellow"],"example":"primary","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].tone","typeLabel":"enum\u003cstring>"},"order":{"type":"number","description":"Display order of the category within the checklist","example":0,"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].order","typeLabel":"number"},"items":{"description":"Items in this category","type":"array","items":{"type":"object","properties":{"sourceCategoryId":{"type":"string","description":"Identifier of the category this item belongs to. Repeated on the item as well as on its parent category so that the (sourceCategoryId, sourceTaskId) pair survives flattening: checklist.flatMap((category) => category.items) is how you find outstanding items, and it discards the parent.","example":"6650a1b2c3d4e5f6a7b8c9d0","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].sourceCategoryId","typeLabel":"string"},"sourceTaskId":{"type":"string","description":"Identifier of this item. Together with sourceCategoryId it identifies the item within THIS filing, which is what lets you match an item to the same item on a later poll. The pair is unique within one filing only: both ids come from the state template, so they are identical across every filing in the same state and across tenants. Key any client-side cache by filing id as well, or two filings in one state will collide.","example":"6650a1b2c3d4e5f6a7b8c9d1","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].sourceTaskId","typeLabel":"string"},"label":{"type":"string","description":"What the item asks for","example":"Signed diligent search affidavit","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].label","typeLabel":"string"},"required":{"type":"boolean","description":"True when the filing cannot complete without this item","example":true,"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].required","typeLabel":"boolean"},"order":{"type":"number","description":"Display order of the item within its category","example":0,"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].order","typeLabel":"number"},"checked":{"type":"boolean","description":"True once Turris has satisfied the item","example":false,"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].checked","typeLabel":"boolean"},"referenceFields":{"description":"Reference values captured against this item","type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"Field label as configured on the state template","example":"Policy limit","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].referenceFields.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","description":"Value captured for this field; empty string when not yet filled in","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].referenceFields.items.[INDEX].value","typeLabel":"string"}},"required":["label","value"],"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].referenceFields.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].referenceFields","typeLabel":"object[]"},"templateFiles":{"description":"Blank forms supplied for this item, each with short-lived presigned links","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the template file","example":"6650a1b2c3d4e5f6a7b8c9d0","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].templateFiles.items.[INDEX].id","typeLabel":"string"},"fileName":{"type":"string","description":"Original file name","example":"diligent-search-form.pdf","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].templateFiles.items.[INDEX].fileName","typeLabel":"string"},"mimeType":{"type":"string","description":"MIME type of the file","example":"application/pdf","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].templateFiles.items.[INDEX].mimeType","typeLabel":"string"},"fileSize":{"type":"number","description":"File size in bytes","example":248310,"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].templateFiles.items.[INDEX].fileSize","typeLabel":"number"},"description":{"type":"string","description":"Description of what the file is for; empty string when none was set","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].templateFiles.items.[INDEX].description","typeLabel":"string"},"downloadUrl":{"type":"string","description":"Short-lived presigned URL to download the file","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].templateFiles.items.[INDEX].downloadUrl","typeLabel":"string"},"viewUrl":{"type":"string","description":"Short-lived presigned URL to view the file inline in the browser","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].templateFiles.items.[INDEX].viewUrl","typeLabel":"string"}},"required":["id","fileName","mimeType","fileSize","description","downloadUrl","viewUrl"],"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].templateFiles.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].templateFiles","typeLabel":"object[]"},"attachments":{"description":"Files attached to this item, each with short-lived presigned links","type":"array","items":{"type":"object","properties":{"_id":{"type":"string","description":"Identifies the attachment record on the checklist item. This is NOT a file document id: to download the file, pass fileDocumentId to Get a Download URL for a Document.","example":"6650a1b2c3d4e5f6a7b8c9d0","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments.items.[INDEX]._id","typeLabel":"string"},"fileDocumentId":{"type":"string","description":"The document id to pass to Get a Download URL for a Document","example":"6650a1b2c3d4e5f6a7b8c9d1","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments.items.[INDEX].fileDocumentId","typeLabel":"string"},"fileName":{"type":"string","description":"Original file name","example":"signed-form.pdf","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments.items.[INDEX].fileName","typeLabel":"string"},"uploadedByType":{"type":"string","description":"Who uploaded the file","enum":["admin","customer"],"example":"customer","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments.items.[INDEX].uploadedByType","typeLabel":"enum\u003cstring>"},"uploadedAt":{"type":"string","description":"ISO 8601 timestamp when the file was uploaded","example":"2026-06-01T12:00:00.000Z","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments.items.[INDEX].uploadedAt","typeLabel":"string"},"authorLabel":{"type":"string","description":"Who uploaded the file, as a display label: 'Turris' for a Turris upload, otherwise the name of the entity the filing belongs to. Uploader ids are never returned.","example":"Turris","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments.items.[INDEX].authorLabel","typeLabel":"string"},"downloadUrl":{"type":"string","description":"Short-lived presigned URL to download the file","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments.items.[INDEX].downloadUrl","typeLabel":"string"},"viewUrl":{"type":"string","description":"Short-lived presigned URL to view the file inline in the browser","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments.items.[INDEX].viewUrl","typeLabel":"string"}},"required":["_id","fileDocumentId","fileName","uploadedByType","uploadedAt","authorLabel","downloadUrl","viewUrl"],"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].attachments","typeLabel":"object[]"},"checkedAt":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp when the item was checked off; null while outstanding","example":"2026-06-01T12:00:00.000Z","uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].checkedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp when the item was checked off; null while outstanding","example":"2026-06-01T12:00:00.000Z","uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].checkedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].checkedAt","typeLabel":"string | null"},"escalation":{"oneOf":[{"type":"object","description":"Escalation raised on this item; null when none was raised. Also listed on the filing escalations[].","required":["checklistItemLabel","status","messages"],"properties":{"checklistItemLabel":{"type":"string","description":"The checklist item label this escalation is attached to","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.checklistItemLabel","typeLabel":"string"},"status":{"type":"string","description":"Current status of the escalation","enum":["waiting turris input","waiting customer input","resolved"],"example":"waiting customer input","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.status","typeLabel":"enum\u003cstring>"},"messages":{"description":"Chronological list of messages on this escalation","type":"array","items":{"type":"object","properties":{"authorLabel":{"type":"string","description":"Display label for the message author (Turris or Agency)","example":"Turris","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.messages.items.[INDEX].authorLabel","typeLabel":"string"},"body":{"type":"string","description":"Message body text","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.messages.items.[INDEX].body","typeLabel":"string"},"createdAt":{"type":"string","description":"ISO 8601 timestamp when the message was created","example":"2025-06-01T12:00:00.000Z","isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.messages.items.[INDEX].createdAt","typeLabel":"string"}},"required":["authorLabel","body","createdAt"],"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.messages.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.messages","typeLabel":"object[]"},"openedAt":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp when the escalation was opened","uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.openedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp when the escalation was opened","uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.openedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.openedAt","typeLabel":"string | null"},"resolvedAt":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp when the escalation was resolved","uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.resolvedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp when the escalation was resolved","uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.resolvedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0.resolvedAt","typeLabel":"string | null"}},"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX].escalation","typeLabel":"object | null"}},"required":["sourceCategoryId","sourceTaskId","label","required","order","checked","referenceFields","templateFiles","attachments"],"uniqueKey":"data.checklist.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.checklist.items.[INDEX].\\items","typeLabel":"object[]"}},"required":["sourceCategoryId","name","tone","order","items"],"uniqueKey":"data.checklist.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.checklist","typeLabel":"object[]"},"checklistProgress":{"type":"object","description":"Checked/total counts over the visible checklist items only","required":["checked","total"],"properties":{"checked":{"type":"number","description":"How many visible checklist items are done","example":3,"isRequired":true,"uniqueKey":"data.checklistProgress.checked","typeLabel":"number"},"total":{"type":"number","description":"How many visible checklist items there are in total","example":5,"isRequired":true,"uniqueKey":"data.checklistProgress.total","typeLabel":"number"}},"isRequired":true,"uniqueKey":"data.checklistProgress","typeLabel":"object"},"externalReference":{"oneOf":[{"type":"string","description":"External reference identifier assigned by the caller","example":"EXT-REF-12345","uniqueKey":"data.externalReference.oneOf.0","typeLabel":"string"},{"type":"null","description":"External reference identifier assigned by the caller","example":"EXT-REF-12345","uniqueKey":"data.externalReference.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.externalReference","typeLabel":"string | null"},"effectiveDate":{"oneOf":[{"type":"string","description":"ISO 8601 policy effective date","example":"2025-01-01T00:00:00.000Z","uniqueKey":"data.effectiveDate.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 policy effective date","example":"2025-01-01T00:00:00.000Z","uniqueKey":"data.effectiveDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.effectiveDate","typeLabel":"string | null"},"totalTaxDue":{"oneOf":[{"type":"number","description":"Total tax due in USD; null when no tax snapshot exists","uniqueKey":"data.totalTaxDue.oneOf.0","typeLabel":"number"},{"type":"null","description":"Total tax due in USD; null when no tax snapshot exists","uniqueKey":"data.totalTaxDue.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.totalTaxDue","typeLabel":"number | null"},"policyDocument":{"oneOf":[{"type":"object","description":"The policy document attached to this filing, or null if none has been uploaded yet","required":["fileDocumentId","fileName","uploadedByType","uploadedAt","downloadUrl","viewUrl"],"properties":{"fileDocumentId":{"type":"string","description":"The document id to pass to Get a Download URL for a Document","example":"6650a1b2c3d4e5f6a7b8c9d1","isRequired":true,"uniqueKey":"data.policyDocument.oneOf.0.fileDocumentId","typeLabel":"string"},"fileName":{"type":"string","description":"Original file name of the policy document","example":"policy-12345.pdf","isRequired":true,"uniqueKey":"data.policyDocument.oneOf.0.fileName","typeLabel":"string"},"uploadedByType":{"type":"string","description":"Who uploaded the policy document","enum":["admin","customer"],"example":"customer","isRequired":true,"uniqueKey":"data.policyDocument.oneOf.0.uploadedByType","typeLabel":"enum\u003cstring>"},"uploadedAt":{"type":"string","description":"ISO 8601 timestamp when the policy document was uploaded","example":"2025-06-15T09:00:00.000Z","isRequired":true,"uniqueKey":"data.policyDocument.oneOf.0.uploadedAt","typeLabel":"string"},"downloadUrl":{"type":"string","description":"Short-lived presigned URL to download the policy document","isRequired":true,"uniqueKey":"data.policyDocument.oneOf.0.downloadUrl","typeLabel":"string"},"viewUrl":{"type":"string","description":"Short-lived presigned URL to view the policy document inline in the browser","isRequired":true,"uniqueKey":"data.policyDocument.oneOf.0.viewUrl","typeLabel":"string"}},"uniqueKey":"data.policyDocument.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.policyDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.policyDocument","typeLabel":"object | null"}},"required":["_id","policyNumber","stateCode","policyTransactionType","status","actionRequired","updatedAt","namedInsured","carrier","grossPremium","escalations","completionArtifacts","checklist","checklistProgress"],"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":{"_id":"6650a1b2c3d4e5f6a7b8c9d0","policyNumber":"POL-2025-001","stateCode":"CA","policyTransactionType":"bind","status":"in progress","actionRequired":true,"updatedAt":"2025-06-15T12:00:00.000Z","namedInsured":"Example Corp","carrier":{"_id":"6610b3d2c2e0a51b8c0d1f09","name":"Lloyds of London","companyCode":"12345"},"grossPremium":5000,"escalations":[{"checklistItemLabel":"\u003cstring>","status":"waiting customer input","messages":[{"authorLabel":"Turris","body":"\u003cstring>","createdAt":"2025-06-01T12:00:00.000Z"}],"openedAt":"\u003cstring>","resolvedAt":"\u003cstring>"}],"completionArtifacts":[{"type":"accepted stamped","fileDocumentId":"6650a1b2c3d4e5f6a7b8c9d1","fileName":"stamped-filing.pdf","uploadedAt":"2025-06-15T09:00:00.000Z","downloadUrl":"\u003cstring>","viewUrl":"\u003cstring>"}],"checklist":[{"sourceCategoryId":"6650a1b2c3d4e5f6a7b8c9d0","name":"Documents we need from you","tone":"primary","order":0,"items":[{"sourceCategoryId":"6650a1b2c3d4e5f6a7b8c9d0","sourceTaskId":"6650a1b2c3d4e5f6a7b8c9d1","label":"Signed diligent search affidavit","required":true,"order":0,"checked":false,"referenceFields":[{"label":"Policy limit","value":"\u003cstring>"}],"templateFiles":[{"id":"6650a1b2c3d4e5f6a7b8c9d0","fileName":"diligent-search-form.pdf","mimeType":"application/pdf","fileSize":248310,"description":"\u003cstring>","downloadUrl":"\u003cstring>","viewUrl":"\u003cstring>"}],"attachments":[{"_id":"6650a1b2c3d4e5f6a7b8c9d0","fileDocumentId":"6650a1b2c3d4e5f6a7b8c9d1","fileName":"signed-form.pdf","uploadedByType":"customer","uploadedAt":"2026-06-01T12:00:00.000Z","authorLabel":"Turris","downloadUrl":"\u003cstring>","viewUrl":"\u003cstring>"}],"checkedAt":"2026-06-01T12:00:00.000Z","escalation":{"checklistItemLabel":"\u003cstring>","status":"waiting customer input","messages":[{"authorLabel":"Turris","body":"\u003cstring>","createdAt":"2025-06-01T12:00:00.000Z"}],"openedAt":"\u003cstring>","resolvedAt":"\u003cstring>"}}]}],"checklistProgress":{"checked":3,"total":5},"externalReference":"EXT-REF-12345","effectiveDate":"2025-01-01T00:00:00.000Z","totalTaxDue":123,"policyDocument":{"fileDocumentId":"6650a1b2c3d4e5f6a7b8c9d1","fileName":"policy-12345.pdf","uploadedByType":"customer","uploadedAt":"2025-06-15T09:00:00.000Z","downloadUrl":"\u003cstring>","viewUrl":"\u003cstring>"}},"requestId":"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8","timestamp":"2025-11-12T20:49:03.293Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"a0c6da41-6cc3-4c96-9edc-a33568012772":{"description":"Invalid request body, a missing endorsementNumber on an endorsement filing, or an agency your organization is not associated with","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","contract_already_signed","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","online_signing_in_progress","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"},"ee32211c-ce6e-4b30-a425-182ab782a0e4":{"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","contract_already_signed","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","online_signing_in_progress","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"},"7e56bf29-fc0c-4eff-9931-0b9fca2fa2db":{"description":"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","contract_already_signed","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","online_signing_in_progress","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"},"ae6db76c-aed0-4746-9d08-986b669084be":{"description":"Turris has no surplus-lines template for the given stateCode yet","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","contract_already_signed","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","online_signing_in_progress","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"},"6e490e10-4d05-4c67-ad62-17ab2afac75a":{"description":"A filing for this agency, state, policy number, and transaction type already exists","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","contract_already_signed","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","online_signing_in_progress","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"},"43651b88-db3e-4dfc-99d7-ca02b8a8b487":{"description":"Too many requests: this credential passed the API-wide limit of 1000 requests per 10 seconds, counted across every endpoint. The request was not processed. Wait the number of seconds in the Retry-After header, then retry.","headers":{"Retry-After":{"description":"Seconds to wait before retrying. Sent when a rate limit refused the request.","schema":{"type":"integer"}}},"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","contract_already_signed","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","online_signing_in_progress","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"}},"security":{"2a0e56fe-47b7-4cb7-bbac-a3ff39495e3e":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","scopes":[],"schemeName":"bearer"}},"5d1abac5-b23d-402f-b973-8d8ce38800e4":{"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":{"b5db2bd0-a1cd-4527-96a0-902f1a8e1045":{"url":"https://public.api.live.turrisfi.com","description":"Production"},"ad5a490d-7aa4-4717-91cf-176b7ea56114":{"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":"Open a Surplus-Lines Filing - Turris Public API","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/v2/surplus-lines-filings/open-filing","matchLevel":0},"v1":{"href":"/guides/carrier-api","matchLevel":3}},"firstHrefInLanguage":{},"searchTabScopes":[{"tab":"Documentation"},{"tab":"Carrier \u0026 MGA API","version":"v2"},{"tab":"Carrier \u0026 MGA API","version":"v1"},{"tab":"Agency API"},{"tab":"Changelog"}]},"lastModified":"2026-11-02T22:19:21.171Z","originalFileLocation":"api-reference/v2/surplus-lines-filings/open-filing.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=\"Start a filing for one of your associated agencies\">\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=\"Open a Surplus-Lines Filing - Turris Public API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start a filing for one of your associated agencies\">\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/surplus-lines-filings/open-filing\">\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=Filings\u0026amp;title=Open+a+Surplus-Lines+Filing\u0026amp;description=Start+a+filing+for+one+of+your+associated+agencies\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=a27f3d80857e3ce6cc416cd0bf7e5ddbc68ebf8d6bc3ce825383af407a12001c\">\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=\"Open a Surplus-Lines Filing - Turris Public API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start a filing for one of your associated agencies\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://turris.mintlify.site/_mintlify/api/og/v2?division=Filings\u0026amp;title=Open+a+Surplus-Lines+Filing\u0026amp;description=Start+a+filing+for+one+of+your+associated+agencies\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=a27f3d80857e3ce6cc416cd0bf7e5ddbc68ebf8d6bc3ce825383af407a12001c\">\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/surplus-lines-filings/open-filing\">\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/surplus-lines-filings/open-filing.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/surplus-lines-filings/open-filing#webpage\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/surplus-lines-filings/open-filing\",\"name\":\"Open a Surplus-Lines Filing\",\"description\":\"Start a filing for one of your associated agencies\",\"dateModified\":\"2026-11-02T22:19:21.171Z\",\"isPartOf\":{\"@id\":\"https://docs.turrisfi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/surplus-lines-filings/open-filing#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.turrisfi.com/api-reference/v2/surplus-lines-filings/open-filing#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Surplus Lines\",\"item\":\"https://docs.turrisfi.com/guides/surplus-lines-filing-walkthrough\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Filings\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/surplus-lines-filings/list-filings\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Open a Surplus-Lines Filing\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/surplus-lines-filings/open-filing\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.turrisfi.com/api-reference/v2/surplus-lines-filings/open-filing#apireference\",\"headline\":\"Open a Surplus-Lines Filing\",\"name\":\"Open a Surplus-Lines Filing\",\"description\":\"Start a filing for one of your associated agencies\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/surplus-lines-filings/open-filing\",\"mainEntityOfPage\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/surplus-lines-filings/open-filing#webpage\"},\"dateModified\":\"2026-11-02T22:19:21.171Z\",\"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/surplus-lines-filings/open-filing.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":"Add NPN","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/npn","href":"/api-reference/v2/downstream-entity-associations/add-npn"},{"title":"Record an Executed Producer Agreement","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/executed-producer-agreement","href":"/api-reference/v2/downstream-entity-associations/record-executed-producer-agreement"},{"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"},{"title":"Add Contact","openapi":"openapi/v2.json POST /v2/upstream/contacts","href":"/api-reference/v2/contacts/add-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":"Request an Appointment","openapi":"openapi/v2.json POST /v2/upstream/appointment-requests","href":"/api-reference/v2/appointments/create-appointment-request"},{"title":"Cancel an Appointment Request","openapi":"openapi/v2.json POST /v2/upstream/appointment-requests/{appointmentRequestId}/cancel","href":"/api-reference/v2/appointments/cancel-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"},{"title":"Request a Termination","openapi":"openapi/v2.json POST /v2/upstream/termination-requests","href":"/api-reference/v2/appointments/create-termination-request"},{"title":"Cancel a Termination Request","openapi":"openapi/v2.json POST /v2/upstream/termination-requests/{terminationRequestId}/cancel","href":"/api-reference/v2/appointments/cancel-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","description":"Retrieve a single surplus lines filing by ID","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","description":"Attach files you already uploaded to a public checklist item on a filing","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":"Document Extraction Completed","href":"/guides/webhooks/document-extraction-completed"},{"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":"Appointment Request Status Change","href":"/guides/webhooks/appointment-request-status-change"},{"title":"Termination Request Status Change","href":"/guides/webhooks/termination-request-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","pages":[{"title":"Agency API","href":"/guides/agency-api"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Open a Surplus-Lines Filing - Turris Public API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}