Sends the named person at one of your agencies the state diligent-effort (declination) form to sign, and returns the request with its live DocuSign envelope.upstreamDownstreamAssociationId must name one of your own agency relationships. Anything else returns 404, the same answer you get for an id that does not exist at all.
Quote ID and Type
quoteId is your own identifier for the quote this form is being raised against: whatever your system calls it, such as control number, prospect number, or quote number. Within your organisation, a quoteId can have only one open or signed request per state. Sending a quoteId and stateCode that already have an open or signed request returns 409. Once that request is declined or voided, the same quoteId and stateCode can be requested again. A signed form is final for its quoteId and stateCode: no new request can be raised for that pair afterwards.quoteType says whether the quote is new business or a renewal.Both fields are required and both are echoed back on the response, unchanged.
The document is ours, not yours
The form is Turris’s published diligent-effort form for the state you name, and its exact version is frozen onto the request the moment it is sent. Republishing the state’s form later never reshapes a request already in flight, so a signed document always matches what its signer saw.You cannot select a document, and there is no field to pass one.
When a state’s form is not ready
A 422 means Turris cannot send that state’s form right now. details.refusalCode says which of four reasons applies and the message says what happens next:
STATE_FORM_NOT_FOUND
Turris holds no form for that state yet.
STATE_FORM_FILE_MISSING
The state has a record but no uploaded form to build from.
STATE_FORM_NOT_PUBLISHED
The form exists but is not published for sending.
STATE_FORM_BEING_EDITED
Somebody is editing the form right now. Try again shortly.
Branch on the code, show the message. The two are both in every 422 body for exactly that split.
How the recipient is identified
Name them by email.If Turris already holds a contact for that address at that agency, it is used. Otherwise send recipientFirstName and recipientLastName and a contact is created; omit either one in that case and you get a 400.The address is checked before anything is created. One email is the only notification the signer ever gets, so an address whose mailbox does not exist is refused with a 400 carrying errorType: invalid_email rather than producing a request nobody will answer.
The name on the signed document may not be the name you sent
Where Turris already holds a name for an address, that stored name is what appears on the signed document, and the name in your response is an echo of what you sent.So a request naming “Bob Smith” for an address Turris holds as “Robert Smith” comes back saying “Bob Smith” while the signed form says “Robert Smith”. The response is authoritative for your own request, not a read of our records: we do not return names we hold for addresses you have not registered yourself.
What the recipient receives
One email from Turris with a link to sign in and sign.Nothing is sent to them from DocuSign. The signature is taken inside Turris against their own authenticated session, which is what stops whoever opens their mailbox from signing on their behalf. If they are not a Turris user yet, the link enrols them.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
upstreamDownstreamAssociationId
string
required
The carrier-agency relationship to raise the request under. Must be one of your own associations; anything else is treated as not found.
Example:
"6610b3d2c2e0a51b8c0d1f02"
stateCode
enum<string>
required
The state or territory whose diligent-effort form to send. Turris must have a published form 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"
quoteId
string
required
Your own identifier for the quote this form is being raised against. Whatever your system calls it: control number, prospect number, or quote number. A quoteId can have only one open or signed request per state; once it is declined or voided, the same quoteId and stateCode can be requested again. A signed form is final for that pair.
Maximum string length: 100
Example:
"Q-10045"
quoteType
enum<string>
required
Whether the quote is new business or a renewal.
Available options:
new quote,
renewal quote
Example:
"new quote"
recipientEmail
string
required
Who at the agency should sign. If Turris already holds a contact for this address at that agency it is used; otherwise a contact is created, which is when the name fields below are required.
Example:
"casey.rivera@example-agency.com"
recipientFirstName
string
The recipient's first name. Required when Turris holds no contact for this address at the agency. When it does, the stored name is what appears on the signed document, and this value is echoed back to you unchanged.
Example:
"Casey"
recipientLastName
string
The recipient's last name. Required when Turris holds no contact for this address at the agency. When it does, the stored name is what appears on the signed document, and this value is echoed back to you unchanged.
Example:
"Rivera"
Response
The request, with its live DocuSign envelope
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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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/diligent-effort-requests/request-signature","slug":"/api-reference/v2/diligent-effort-requests/request-signature","pageMetadata":{"title":"Request a Diligent-Effort Signature","description":"Send a state's diligent-effort form to somebody at one of your agencies","openapi":"openapi/v2.json POST /v2/upstream/diligent-effort-requests","href":"/api-reference/v2/diligent-effort-requests/request-signature"},"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: \"Send a state’s diligent-effort form to somebody at one of your 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:`Sends the named person at one of your agencies the state diligent-effort (declination) form to sign, and returns the request with its live DocuSign envelope.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`upstreamDownstreamAssociationId`}),` must name one of your own agency relationships. Anything else returns `,_jsx(_components.strong,{children:`404`}),`, the same answer you get for an id that does not exist at all.`]}),`\n`,_jsx(Heading,{level:`2`,id:`quote-id-and-type`,children:`Quote ID and Type`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`quoteId`}),` is your own identifier for the quote this form is being raised against: whatever your system calls it, such as control number, prospect number, or quote number. `,_jsxs(_components.strong,{children:[`Within your organisation, a `,_jsx(_components.code,{children:`quoteId`}),` can have only one open or signed request per state.`]}),` Sending a `,_jsx(_components.code,{children:`quoteId`}),` and `,_jsx(_components.code,{children:`stateCode`}),` that already have an open or signed request returns `,_jsx(_components.strong,{children:`409`}),`. Once that request is declined or voided, the same `,_jsx(_components.code,{children:`quoteId`}),` and `,_jsx(_components.code,{children:`stateCode`}),` can be requested again. A `,_jsx(_components.code,{children:`signed`}),` form is final for its `,_jsx(_components.code,{children:`quoteId`}),` and `,_jsx(_components.code,{children:`stateCode`}),`: no new request can be raised for that pair afterwards.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`quoteType`}),` says whether the quote is new business or a renewal.`]}),`\n`,_jsx(_components.p,{children:`Both fields are required and both are echoed back on the response, unchanged.`}),`\n`,_jsx(Heading,{level:`2`,id:`the-document-is-ours-not-yours`,children:`The document is ours, not yours`}),`\n`,_jsx(_components.p,{children:`The form is Turris’s published diligent-effort form for the state you name, and its exact version is frozen onto the request the moment it is sent. Republishing the state’s form later never reshapes a request already in flight, so a signed document always matches what its signer saw.`}),`\n`,_jsx(_components.p,{children:`You cannot select a document, and there is no field to pass one.`}),`\n`,_jsx(Heading,{level:`2`,id:`when-a-state’s-form-is-not-ready`,children:`When a state’s form is not ready`}),`\n`,_jsxs(_components.p,{children:[`A `,_jsx(_components.strong,{children:`422`}),` means Turris cannot send that state’s form right now. `,_jsx(_components.code,{children:`details.refusalCode`}),` says which of four reasons applies and the message says what happens next:`]}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`STATE_FORM_NOT_FOUND`,id:`state-form-not-found`,children:_jsx(_components.p,{children:`Turris holds no form for that state yet.`})}),_jsx(Accordion,{title:`STATE_FORM_FILE_MISSING`,id:`state-form-file-missing`,children:_jsx(_components.p,{children:`The state has a record but no uploaded form to build from.`})}),_jsx(Accordion,{title:`STATE_FORM_NOT_PUBLISHED`,id:`state-form-not-published`,children:_jsx(_components.p,{children:`The form exists but is not published for sending.`})}),_jsx(Accordion,{title:`STATE_FORM_BEING_EDITED`,id:`state-form-being-edited`,children:_jsx(_components.p,{children:`Somebody is editing the form right now. Try again shortly.`})})]}),`\n`,_jsx(_components.p,{children:`Branch on the code, show the message. The two are both in every 422 body for exactly that split.`}),`\n`,_jsx(Heading,{level:`2`,id:`how-the-recipient-is-identified`,children:`How the recipient is identified`}),`\n`,_jsx(_components.p,{children:`Name them by email.`}),`\n`,_jsxs(_components.p,{children:[`If Turris already holds a contact for that address at that agency, it is used. Otherwise send `,_jsx(_components.code,{children:`recipientFirstName`}),` and `,_jsx(_components.code,{children:`recipientLastName`}),` and a contact is created; omit either one in that case and you get a `,_jsx(_components.strong,{children:`400`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The address is checked before anything is created. One email is the only notification the signer ever gets, so an address whose mailbox does not exist is refused with a `,_jsx(_components.strong,{children:`400`}),` carrying `,_jsx(_components.code,{children:`errorType: invalid_email`}),` rather than producing a request nobody will answer.`]}),`\n`,_jsx(Heading,{level:`2`,id:`the-name-on-the-signed-document-may-not-be-the-name-you-sent`,children:`The name on the signed document may not be the name you sent`}),`\n`,_jsxs(_components.p,{children:[`Where Turris already holds a name for an address, `,_jsx(_components.strong,{children:`that stored name is what appears on the signed document`}),`, and the name in your response is an echo of what you sent.`]}),`\n`,_jsx(_components.p,{children:`So a request naming “Bob Smith” for an address Turris holds as “Robert Smith” comes back saying “Bob Smith” while the signed form says “Robert Smith”. The response is authoritative for your own request, not a read of our records: we do not return names we hold for addresses you have not registered yourself.`}),`\n`,_jsx(Heading,{level:`2`,id:`what-the-recipient-receives`,children:`What the recipient receives`}),`\n`,_jsx(_components.p,{children:`One email from Turris with a link to sign in and sign.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Nothing is sent to them from DocuSign.`}),` The signature is taken inside Turris against their own authenticated session, which is what stops whoever opens their mailbox from signing on their behalf. If they are not a Turris user yet, the link enrols them.`]}),`\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":"Request a Diligent-Effort Signature","description":"Send a state's diligent-effort form to somebody at one of your agencies","openapi":"openapi/v2.json POST /v2/upstream/diligent-effort-requests","href":"/api-reference/v2/diligent-effort-requests/request-signature"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Quote ID and Type","slug":"quote-id-and-type","depth":2,"children":[]},{"title":"The document is ours, not yours","slug":"the-document-is-ours-not-yours","depth":2,"children":[]},{"title":"When a state’s form is not ready","slug":"when-a-state’s-form-is-not-ready","depth":2,"children":[]},{"title":"How the recipient is identified","slug":"how-the-recipient-is-identified","depth":2,"children":[]},{"title":"The name on the signed document may not be the name you sent","slug":"the-name-on-the-signed-document-may-not-be-the-name-you-sent","depth":2,"children":[]},{"title":"What the recipient receives","slug":"what-the-recipient-receives","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/turris/0c051c093ff073c0/scripts/filter-openapi.js"],"openApiReferenceData":{"operation":{"description":"Send a state's diligent-effort form to somebody at one of your agencies","operationId":"DiligentEffortRequestsV2Controller_createDiligentEffortRequest_v2","parameters":["a93d20e9-a7b9-4da8-9601-3331dfb96a7b","e5ec26e1-a4aa-4706-8a3c-1c0364b3e645"],"requestBody":"1ce1a2e4-13f4-4c0d-aa52-1b6b9dca6743","responses":{"201":"56748dd4-2c0e-468d-8a9f-5d1b12b86398","400":"ea594c5c-a326-405c-bc66-25591d4d1846","401":"f0574c72-6082-4d2d-ace0-0254250b91b0","403":"18fd0ea6-8422-4a3e-b8b4-270ce93e04f8","404":"6a46e516-c1ef-46d2-9a3c-0405a2c0c45a","409":"1a47c6f9-d608-40e1-af01-6b7e36a5d828","422":"9da795db-ade5-4268-bfda-7c534fe0b077","429":"62c7ded2-c20f-46cc-9ab6-2471bb48ca74"},"summary":"Request a diligent-effort form signature","tags":["upstream/diligent-effort-requests"],"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/diligent-effort-requests","baseUrlOptions":["https://public.api.live.turrisfi.com","https://public.api.sandbox.turrisfi.com"],"title":"Request a diligent-effort form signature","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.upstreamDownstreamAssociationId":"6610b3d2c2e0a51b8c0d1f02","body.stateCode":"CA","body.quoteId":"Q-10045","body.quoteType":"new quote","body.recipientEmail":"casey.rivera@example-agency.com","body.recipientFirstName":"Casey","body.recipientLastName":"Rivera"}]},"dependencies":{"parameters":{"a93d20e9-a7b9-4da8-9601-3331dfb96a7b":{"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"}},"e5ec26e1-a4aa-4706-8a3c-1c0364b3e645":{"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":{"upstreamDownstreamAssociationId":{"type":"string","description":"The carrier-agency relationship to raise the request under. Must be one of your own associations; anything else is treated as not found.","example":"6610b3d2c2e0a51b8c0d1f02","isRequired":true,"uniqueKey":"upstreamDownstreamAssociationId","typeLabel":"string"},"stateCode":{"type":"string","description":"The state or territory whose diligent-effort form to send. Turris must have a published form 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>"},"quoteId":{"type":"string","description":"Your own identifier for the quote this form is being raised against. Whatever your system calls it: control number, prospect number, or quote number. A quoteId can have only one open or signed request per state; once it is declined or voided, the same quoteId and stateCode can be requested again. A signed form is final for that pair.","example":"Q-10045","maxLength":100,"isRequired":true,"uniqueKey":"quoteId","typeLabel":"string"},"quoteType":{"type":"string","description":"Whether the quote is new business or a renewal.","enum":["new quote","renewal quote"],"example":"new quote","isRequired":true,"uniqueKey":"quoteType","typeLabel":"enum\u003cstring>"},"recipientEmail":{"type":"string","description":"Who at the agency should sign. If Turris already holds a contact for this address at that agency it is used; otherwise a contact is created, which is when the name fields below are required.","example":"casey.rivera@example-agency.com","isRequired":true,"uniqueKey":"recipientEmail","typeLabel":"string"},"recipientFirstName":{"type":"string","description":"The recipient's first name. Required when Turris holds no contact for this address at the agency. When it does, the stored name is what appears on the signed document, and this value is echoed back to you unchanged.","example":"Casey","uniqueKey":"recipientFirstName","typeLabel":"string"},"recipientLastName":{"type":"string","description":"The recipient's last name. Required when Turris holds no contact for this address at the agency. When it does, the stored name is what appears on the signed document, and this value is echoed back to you unchanged.","example":"Rivera","uniqueKey":"recipientLastName","typeLabel":"string"}},"required":["upstreamDownstreamAssociationId","stateCode","quoteId","quoteType","recipientEmail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"upstreamDownstreamAssociationId":"6610b3d2c2e0a51b8c0d1f02","stateCode":"CA","quoteId":"Q-10045","quoteType":"new quote","recipientEmail":"casey.rivera@example-agency.com","recipientFirstName":"Casey","recipientLastName":"Rivera"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"56748dd4-2c0e-468d-8a9f-5d1b12b86398":{"description":"The request, with its live DocuSign envelope","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"_id":{"type":"string","description":"Unique identifier of the diligent-effort request","example":"6650a1b2c3d4e5f6a7b8c9d0","isRequired":true,"uniqueKey":"data._id","typeLabel":"string"},"upstreamDownstreamAssociationId":{"type":"string","description":"The carrier-agency relationship the request was raised under","example":"6610b3d2c2e0a51b8c0d1f02","isRequired":true,"uniqueKey":"data.upstreamDownstreamAssociationId","typeLabel":"string"},"downstreamEntityId":{"type":"string","description":"The agency asked to sign, resolved from the association","example":"6610b3d2c2e0a51b8c0d1f03","isRequired":true,"uniqueKey":"data.downstreamEntityId","typeLabel":"string"},"stateCode":{"type":"string","description":"US state or territory whose diligent-effort form was sent","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>"},"quoteId":{"type":"string","description":"Your own identifier for the quote this form was raised against, echoed back","example":"Q-10045","isRequired":true,"uniqueKey":"data.quoteId","typeLabel":"string"},"quoteType":{"type":"string","description":"Whether the quote is new business or a renewal","enum":["new quote","renewal quote"],"example":"new quote","isRequired":true,"uniqueKey":"data.quoteType","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Lifecycle status. Always `sent` on a successful create","enum":["draft","sent","signed","declined","voided"],"example":"sent","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"recipientEmail":{"type":"string","description":"The address the form was sent to, normalized as stored","example":"casey.rivera@example-agency.com","isRequired":true,"uniqueKey":"data.recipientEmail","typeLabel":"string"},"createdAt":{"type":"string","description":"ISO 8601 creation timestamp","example":"2026-09-14T10:15:00.000Z","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string"},"recipientFirstName":{"oneOf":[{"type":"string","description":"Echo of the first name you sent, or null when you sent none. Not a read of the stored contact: where Turris already held a name for this address, that stored name is what appears on the signed document.","example":"Casey","uniqueKey":"data.recipientFirstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Echo of the first name you sent, or null when you sent none. Not a read of the stored contact: where Turris already held a name for this address, that stored name is what appears on the signed document.","example":"Casey","uniqueKey":"data.recipientFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recipientFirstName","typeLabel":"string | null"},"recipientLastName":{"oneOf":[{"type":"string","description":"Echo of the last name you sent, or null when you sent none. Not a read of the stored contact: where Turris already held a name for this address, that stored name is what appears on the signed document.","example":"Rivera","uniqueKey":"data.recipientLastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Echo of the last name you sent, or null when you sent none. Not a read of the stored contact: where Turris already held a name for this address, that stored name is what appears on the signed document.","example":"Rivera","uniqueKey":"data.recipientLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recipientLastName","typeLabel":"string | null"},"docusignEnvelopeId":{"oneOf":[{"type":"string","description":"The live DocuSign envelope. Always present on a successful create","example":"3f2a1c9e-8b7d-4e5f-9a0b-1c2d3e4f5a6b","uniqueKey":"data.docusignEnvelopeId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The live DocuSign envelope. Always present on a successful create","example":"3f2a1c9e-8b7d-4e5f-9a0b-1c2d3e4f5a6b","uniqueKey":"data.docusignEnvelopeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.docusignEnvelopeId","typeLabel":"string | null"}},"required":["_id","upstreamDownstreamAssociationId","downstreamEntityId","stateCode","quoteId","quoteType","status","recipientEmail","createdAt"],"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","upstreamDownstreamAssociationId":"6610b3d2c2e0a51b8c0d1f02","downstreamEntityId":"6610b3d2c2e0a51b8c0d1f03","stateCode":"CA","quoteId":"Q-10045","quoteType":"new quote","status":"sent","recipientEmail":"casey.rivera@example-agency.com","createdAt":"2026-09-14T10:15:00.000Z","recipientFirstName":"Casey","recipientLastName":"Rivera","docusignEnvelopeId":"3f2a1c9e-8b7d-4e5f-9a0b-1c2d3e4f5a6b"},"requestId":"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8","timestamp":"2025-11-12T20:49:03.293Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"ea594c5c-a326-405c-bc66-25591d4d1846":{"description":"Invalid request body, a recipient name is missing for an address you have no contact for at that agency, or the recipient address is not a real mailbox (`errorType: invalid_email`)","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"},"f0574c72-6082-4d2d-ace0-0254250b91b0":{"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"},"18fd0ea6-8422-4a3e-b8b4-270ce93e04f8":{"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"},"6a46e516-c1ef-46d2-9a3c-0405a2c0c45a":{"description":"No such association for your organization","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"requestId":{"type":"string","description":"Unique request identifier for debugging","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"errorType":{"type":"string","description":"Machine-readable error classification. Branch on this rather than on `errorMessage`, which is prose and may change. Authentication failures returned by our identity provider are forwarded verbatim, so a 401 can carry a code outside this list; treat an unrecognised value as a generic failure of its HTTP status.","enum":["conflict","contact_not_authorized","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"},"1a47c6f9-d608-40e1-af01-6b7e36a5d828":{"description":"An open or signed diligent effort request already exists for this quoteId and stateCode within your organisation, or this request stopped being sendable between validation and send (most commonly a duplicate delivery of this same call arriving while the first was still in flight)","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"},"9da795db-ade5-4268-bfda-7c534fe0b077":{"description":"Turris's diligent-effort form for that state is not ready to send. `details.refusalCode` says which of the four reasons applies and the message says what happens next.","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":"Why the state's diligent-effort form cannot be sent against right now.","required":["refusalCode"],"properties":{"refusalCode":{"type":"string","description":"Which of the four reasons the state form cannot be sent against. Branch on this; show errorMessage to a person.","enum":["STATE_FORM_NOT_FOUND","STATE_FORM_FILE_MISSING","STATE_FORM_NOT_PUBLISHED","STATE_FORM_BEING_EDITED"],"example":"STATE_FORM_NOT_PUBLISHED","isRequired":true,"uniqueKey":"details.refusalCode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"details","typeLabel":"object"}},"required":["statusCode","requestId","errorType","errorMessage","timestamp","details"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"requestId":"\u003cstring>","errorType":"validation_error","errorMessage":["\u003cstring>"],"timestamp":"\u003cstring>","details":{"refusalCode":"STATE_FORM_NOT_PUBLISHED"}}}},"exampleType":"generated"}},"exampleType":"generated"},"62c7ded2-c20f-46cc-9ab6-2471bb48ca74":{"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":"Request a Diligent-Effort Signature - Turris Public API","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/v2/diligent-effort-requests/request-signature","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-10-20T12:45:52.441Z","originalFileLocation":"api-reference/v2/diligent-effort-requests/request-signature.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=\"Send a state\u0026#x27;s diligent-effort form to somebody at one of your 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=\"Request a Diligent-Effort Signature - Turris Public API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Send a state\u0026#x27;s diligent-effort form to somebody at one of your 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/diligent-effort-requests/request-signature\">\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=Diligent+Effort\u0026amp;title=Request+a+Diligent-Effort+Signature\u0026amp;description=Send+a+state%27s+diligent-effort+form+to+somebody+at+one+of+your+agencies\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=0c43c0ae68d0c1f62f0f4103f32ffb735bd5ff36a28cb74b027a6e48354102a7\">\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=\"Request a Diligent-Effort Signature - Turris Public API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Send a state\u0026#x27;s diligent-effort form to somebody at one of your agencies\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://turris.mintlify.site/_mintlify/api/og/v2?division=Diligent+Effort\u0026amp;title=Request+a+Diligent-Effort+Signature\u0026amp;description=Send+a+state%27s+diligent-effort+form+to+somebody+at+one+of+your+agencies\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=0c43c0ae68d0c1f62f0f4103f32ffb735bd5ff36a28cb74b027a6e48354102a7\">\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/diligent-effort-requests/request-signature\">\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/diligent-effort-requests/request-signature.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/diligent-effort-requests/request-signature#webpage\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/diligent-effort-requests/request-signature\",\"name\":\"Request a Diligent-Effort Signature\",\"description\":\"Send a state's diligent-effort form to somebody at one of your agencies\",\"dateModified\":\"2026-10-20T12:45:52.441Z\",\"isPartOf\":{\"@id\":\"https://docs.turrisfi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/diligent-effort-requests/request-signature#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.turrisfi.com/api-reference/v2/diligent-effort-requests/request-signature#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Turris Public API\",\"item\":\"https://docs.turrisfi.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Request a Diligent-Effort Signature\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/diligent-effort-requests/request-signature\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.turrisfi.com/api-reference/v2/diligent-effort-requests/request-signature#apireference\",\"headline\":\"Request a Diligent-Effort Signature\",\"name\":\"Request a Diligent-Effort Signature\",\"description\":\"Send a state's diligent-effort form to somebody at one of your agencies\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/diligent-effort-requests/request-signature\",\"mainEntityOfPage\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/diligent-effort-requests/request-signature#webpage\"},\"dateModified\":\"2026-10-20T12:45:52.441Z\",\"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/diligent-effort-requests/request-signature.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","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-filings/{filingId}","href":"/api-reference/v2/surplus-lines-filings/get-filing"},{"title":"Open a Surplus-Lines Filing","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings","href":"/api-reference/v2/surplus-lines-filings/open-filing"},{"title":"Attach Uploaded Files to a Checklist Item","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings/{filingId}/checklist-item/file-documents","href":"/api-reference/v2/surplus-lines-filings/attach-checklist-item-file-documents"},{"title":"Set the Policy Document","openapi":"openapi/v2.json PUT /v2/upstream/surplus-lines-filings/{filingId}/policy-document","href":"/api-reference/v2/surplus-lines-filings/set-policy-document"},{"title":"Reply to a Checklist Item Escalation","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings/{filingId}/escalation/messages","href":"/api-reference/v2/surplus-lines-filings/reply-to-escalation"}]},{"group":"States","expanded":true,"pages":[{"title":"List Surplus Lines States","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states","href":"/api-reference/v2/surplus-lines-states/list-states"},{"title":"Get State Requirements","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states/{stateCode}/requirements","href":"/api-reference/v2/surplus-lines-states/get-requirements"},{"title":"Get State Taxes and Fees","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states/{stateCode}/tax-and-fees","href":"/api-reference/v2/surplus-lines-states/get-tax-and-fees"},{"title":"Get a Download URL for a State Template File","description":"Mint short-lived links to download or view one blank form","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","description":"Receive automated notifications for compliance events","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":"Request a Diligent-Effort Signature - 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"]}