Requests the appointment of one agent or one agency with the carrier of productId, in stateCode. The answer is the one the Turris dashboard would give: 201 with the new request, or the reason it was refused. Needs the Appointment product feature.
Request Body
Send exactly one of agentId and downstreamEntityAssociationId. Neither or both returns 400.For an agent:
Every request starts as pending with processingMethodmanual: Turris operations files it with the state, and its status moves from there. Follow it with Get an Appointment Request, which returns the same fields. See List Appointment Requests for the statuses.
The licence is checked on every request: the agent or agency must be licensed in the state for the product. If it is licensed but not yet authorized there, the request authorizes it. A refused request authorizes nothing, with two exceptions, described under Calling It Again.
An agency is authorized through the association you named.
An agent on exactly one of your agencies is authorized through that agency.
An agent on several of your agencies can be requested only in a state it is already authorized in, through any of them. Any other state is refused with NOT_AUTHORIZED, and the message asks you to authorize the state in Turris first.
One Request per Call
A request for an agent does not also request the agency’s appointment. If the carrier needs both, make a second call with the agency’s downstreamEntityAssociationId.
Calling It Again
Only one request can be open for the same NPN, state and carrier. NIPR appoints the NPN, so when two of your agencies have the same NPN, a request made for one of them is the open request for both. A second call answers 409, and the two 409 codes mean different things:
OPEN_REQUEST_EXISTS: a request is already open, for this agent or agency, for another of your agencies with the same NPN, or under another of your products with the same carrier. details.existingAppointmentRequestId is its id.
ALREADY_APPOINTED: the agent or agency already holds the appointment. No request was made, and there is no id.
Both codes carry details.isStateAuthorized: whether the state is authorized for the product you sent, after this call. Both can still authorize it. If the agent or agency is licensed in the state but not yet authorized there for the product, the call authorizes the state, as a created request would, when an open request covers it, or when the appointment it already holds with the carrier covers every line of authority the product needs there. The field is then true, and a repeat call answers the same. ALREADY_APPOINTED with isStateAuthorized: false means the appointment lacks a line of authority the product needs, so the call authorized nothing. So OPEN_REQUEST_EXISTS with isStateAuthorized: true means the request exists and the state is authorized, and you can call this endpoint on every bind.A request counts as open while it is pending, submitting or submitted. Once it reaches any other status, a new call creates a new request.Send an idempotency-key header to make a network retry safe. A successful create is replayed with 201 and the same body for one hour. A refusal or a 503 is not stored, so a retry with the same key runs again. See Idempotency.
Refusals
Every 409 and 422 carries details.refusalCode. Branch on the code; show errorMessage to a person.
Status
details.refusalCode
When
409
OPEN_REQUEST_EXISTS
An open request exists for the same NPN, state and carrier, including one made for another of your agencies with that NPN, under another of your products with that carrier, or in the Turris dashboard. Carries details.existingAppointmentRequestId and details.isStateAuthorized.
409
ALREADY_APPOINTED
The agent or agency already holds an active appointment with the carrier in the state. No request was made. When the appointment covers every line of authority the product needs, the call authorizes the state. Carries details.isStateAuthorized.
422
PRODUCT_NOT_IN_ORGANIZATION
The product does not exist or is not one of your products. This is a 422, not a 404.
422
PRODUCT_HAS_NO_CARRIER
The product has no carrier to appoint with.
422
STATE_NOT_SOLD
The product is not sold in the state.
422
APPOINTMENT_REQUIREMENT_NOT_SET_UP
The product’s setup for the state has no appointment requirement for this kind of entity (agent or agency).
422
APPOINTMENT_FILING_NOT_REQUIRED
The state takes no appointment filing for this kind of entity (Registry).
422
NOT_LICENSED
The agent or agency is not licensed in the state for the product, according to its NIPR data in Turris.
422
LICENSE_DATA_NOT_SYNCED
Turris has no license data for the agent or agency yet, because its compliance data has not synced from NIPR. Carries details.syncStatus and details.niprDataSubscriptionId, and details.awaitingBusinessCopyDate while the sync waits for NIPR’s overnight update. See License Data Not Synced Yet.
422
NOT_AUTHORIZED
The agent or agency is not authorized in the state, and this request cannot authorize it, for example because the agent is on several of your agencies.
422
NO_NIPR_DATA_SUBSCRIPTION
Turris has no NIPR data subscription for the agent or agency through this relationship, typically because it has no NPN.
422
AGENT_NOT_ACTIVE_ON_AGENCY
The agent is no longer active on the agency the request would go through.
400
Not exactly one of agentId and downstreamEntityAssociationId, an invalid stateCode or id, or an idempotency-key that is not a UUID.
404
The association is not one of yours or is archived, or the agent is not active on any of your agencies. Unlike List Appointment Requests, an archived association cannot be requested.
503
A concurrent change to the same agent or agency kept the request from settling, the request was created but could not be read back, or the call could not confirm that it authorized the state. Retry after the number of seconds in the Retry-After header. The retry answers as this call would have: if a request was made, 409OPEN_REQUEST_EXISTS with its id; if the state was authorized on an appointment already held, 409ALREADY_APPOINTED; either with details.isStateAuthorized.
When several refusals apply, which one you get follows the order Turris checks them in. That order is not part of the contract: branch on the code, not on the order.A 409 for an open request:
{ "statusCode": 409, "requestId": "abcd1234", "errorType": "conflict", "errorMessage": ["An appointment request for this NPN, state and carrier is already open."], "timestamp": "2026-11-13T15:04:05.000Z", "details": { "refusalCode": "OPEN_REQUEST_EXISTS", "existingAppointmentRequestId": "6672b1c2d3e4f5a6b7c8d9e0", "isStateAuthorized": true }}
A 422 has the same shape, with errorTypeunprocessable_entity and neither existingAppointmentRequestId nor isStateAuthorized.
License Data Not Synced Yet
The license check reads the agent’s or agency’s NIPR data in Turris. Until its compliance data subscription has synced, Turris has no license on record, so the request is refused with LICENSE_DATA_NOT_SYNCED rather than NOT_LICENSED. A newly added agent or agency can get this while its first sync runs, and a first sync requested after about 8:45 PM Central waits for NIPR’s next overnight update.details.syncStatus says where the sync is and what to do:
details.syncStatus
What to do
queued, processing
Wait for the sync to finish, then request again. The Compliance Data Synchronized webhook tells you when; match it on niprDataSubscriptionId. While the sync waits for NIPR’s overnight update, details.awaitingBusinessCopyDate is the date of that update (YYYY-MM-DD).
The last sync failed. A sync that Turris is still retrying can show this status for a short while, so request again a little later; if it stays, contact Turris support to have the sync retried, then request again after it finishes.
You can also follow the sync with Get Subscription Status, using details.niprDataSubscriptionId. If no webhook has arrived by the end of the next business day, contact Turris support.Once the sync has finished, an agent or agency that is not licensed in the state is refused with NOT_LICENSED.
{ "statusCode": 422, "requestId": "abcd1234", "errorType": "unprocessable_entity", "errorMessage": ["This entity's compliance data has not synced from NIPR yet, so Turris has no license data to check. Request again after the sync completes; the ENTITY_COMPLIANCE_DATA_SYNCHRONIZED webhook tells you when."], "timestamp": "2026-11-17T02:52:11.000Z", "details": { "refusalCode": "LICENSE_DATA_NOT_SYNCED", "syncStatus": "queued", "niprDataSubscriptionId": "507f1f77bcf86cd799439013", "awaitingBusinessCopyDate": "2026-11-17" }}
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
stateCode
enum<string>
required
The state or territory to be appointed in
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:
"TX"
productId
string
required
One of your products. Its carrier is the one the appointment is requested with.
Example:
"6600a1b2c3d4e5f6a7b8c9d0"
agentId
string
The producer to request the appointment for. Send this or downstreamEntityAssociationId, not both. If the agent is on exactly one of your agencies, a licensed state it is not yet authorized in is authorized through that agency in the same request.
Example:
"6650a1b2c3d4e5f6a7b8c9d0"
downstreamEntityAssociationId
string
The agency to request the appointment for, as one of your associations. Send this or agentId, not both.
Example:
"6651a1b2c3d4e5f6a7b8c9d0"
Response
The appointment request
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/appointments/create-appointment-request","slug":"/api-reference/v2/appointments/create-appointment-request","pageMetadata":{"title":"Request an Appointment","description":"Request one appointment, and get the request or the reason it was refused","openapi":"openapi/v2.json POST /v2/upstream/appointment-requests","href":"/api-reference/v2/appointments/create-appointment-request"},"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: \"Request one appointment, and get the request or the reason it was refused\"\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`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Requests the appointment of one agent or one agency with the carrier of `,_jsx(_components.code,{children:`productId`}),`, in `,_jsx(_components.code,{children:`stateCode`}),`. The answer is the one the Turris dashboard would give: `,_jsx(_components.code,{children:`201`}),` with the new request, or the reason it was refused. Needs the Appointment product feature.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request Body`}),`\n`,_jsxs(_components.p,{children:[`Send exactly one of `,_jsx(_components.code,{children:`agentId`}),` and `,_jsx(_components.code,{children:`downstreamEntityAssociationId`}),`. Neither or both returns `,_jsx(_components.code,{children:`400`}),`.`]}),`\n`,_jsx(_components.p,{children:`For an agent:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"agentId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6650a1b2c3d4e5f6a7b8c9d0\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"stateCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"TX\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"productId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6600a1b2c3d4e5f6a7b8c9d0\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`For an agency, name it by its association with you:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"downstreamEntityAssociationId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6651a1b2c3d4e5f6a7b8c9d0\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"stateCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"TX\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"productId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6600a1b2c3d4e5f6a7b8c9d0\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`what-you-get-back`,children:`What You Get Back`}),`\n`,_jsxs(_components.p,{children:[`Every request starts as `,_jsx(_components.code,{children:`pending`}),` with `,_jsx(_components.code,{children:`processingMethod`}),` `,_jsx(_components.code,{children:`manual`}),`: Turris operations files it with the state, and its `,_jsx(_components.code,{children:`status`}),` moves from there. Follow it with `,_jsx(_components.a,{href:`/api-reference/v2/appointments/get-appointment-request`,children:`Get an Appointment Request`}),`, which returns the same fields. See `,_jsx(_components.a,{href:`/api-reference/v2/appointments/list-appointment-requests`,children:`List Appointment Requests`}),` for the statuses.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`15`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"appointmentRequestId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6672b1c2d3e4f5a6b7c8d9e0\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"agentId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6650a1b2c3d4e5f6a7b8c9d0\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"stateCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"TX\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"productId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6600a1b2c3d4e5f6a7b8c9d0\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"carrier\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Example Mutual Insurance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"companyCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"12345\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"linesOfAuthority\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [{ `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"16\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Property\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pending\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"processingMethod\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"manual\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requestedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-13T15:04:05.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requestId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"abcd1234\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-13T15:04:05.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`authorization-in-the-same-request`,children:`Authorization in the Same Request`}),`\n`,_jsxs(_components.p,{children:[`The licence is checked on every request: the agent or agency must be licensed in the state for the product. If it is licensed but not yet authorized there, the request authorizes it. A refused request authorizes nothing, with two exceptions, described under `,_jsx(_components.a,{href:`#calling-it-again`,children:`Calling It Again`}),`.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`An agency`}),` is authorized through the association you named.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`An agent on exactly one of your agencies`}),` is authorized through that agency.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`An agent on several of your agencies`}),` can be requested only in a state it is already authorized in, through any of them. Any other state is refused with `,_jsx(_components.code,{children:`NOT_AUTHORIZED`}),`, and the message asks you to authorize the state in Turris first.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`one-request-per-call`,children:`One Request per Call`}),`\n`,_jsxs(_components.p,{children:[`A request for an agent does not also request the agency’s appointment. If the carrier needs both, make a second call with the agency’s `,_jsx(_components.code,{children:`downstreamEntityAssociationId`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`calling-it-again`,children:`Calling It Again`}),`\n`,_jsxs(_components.p,{children:[`Only one request can be open for the same NPN, state and carrier. NIPR appoints the NPN, so when two of your agencies have the same NPN, a request made for one of them is the open request for both. A second call answers `,_jsx(_components.code,{children:`409`}),`, and the two `,_jsx(_components.code,{children:`409`}),` codes mean different things:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`OPEN_REQUEST_EXISTS`})}),`: a request is already open, for this agent or agency, for another of your agencies with the same NPN, or under another of your products with the same carrier. `,_jsx(_components.code,{children:`details.existingAppointmentRequestId`}),` is its id.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`ALREADY_APPOINTED`})}),`: the agent or agency already holds the appointment. No request was made, and there is no id.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Both codes carry `,_jsx(_components.code,{children:`details.isStateAuthorized`}),`: whether the state is authorized for the product you sent, after this call. Both can still authorize it. If the agent or agency is licensed in the state but not yet authorized there for the product, the call authorizes the state, as a created request would, when an open request covers it, or when the appointment it already holds with the carrier covers every line of authority the product needs there. The field is then `,_jsx(_components.code,{children:`true`}),`, and a repeat call answers the same. `,_jsx(_components.code,{children:`ALREADY_APPOINTED`}),` with `,_jsx(_components.code,{children:`isStateAuthorized: false`}),` means the appointment lacks a line of authority the product needs, so the call authorized nothing. So `,_jsx(_components.code,{children:`OPEN_REQUEST_EXISTS`}),` with `,_jsx(_components.code,{children:`isStateAuthorized: true`}),` means the request exists and the state is authorized, and you can call this endpoint on every bind.`]}),`\n`,_jsxs(_components.p,{children:[`A request counts as open while it is `,_jsx(_components.code,{children:`pending`}),`, `,_jsx(_components.code,{children:`submitting`}),` or `,_jsx(_components.code,{children:`submitted`}),`. Once it reaches any other status, a new call creates a new request.`]}),`\n`,_jsxs(_components.p,{children:[`Send an `,_jsx(_components.code,{children:`idempotency-key`}),` header to make a network retry safe. A successful create is replayed with `,_jsx(_components.code,{children:`201`}),` and the same body for one hour. A refusal or a `,_jsx(_components.code,{children:`503`}),` is not stored, so a retry with the same key runs again. See `,_jsx(_components.a,{href:`/guides/idempotency`,children:`Idempotency`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`refusals`,children:`Refusals`}),`\n`,_jsxs(_components.p,{children:[`Every `,_jsx(_components.code,{children:`409`}),` and `,_jsx(_components.code,{children:`422`}),` carries `,_jsx(_components.code,{children:`details.refusalCode`}),`. Branch on the code; show `,_jsx(_components.code,{children:`errorMessage`}),` to a person.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:_jsx(_components.code,{children:`details.refusalCode`})}),_jsx(_components.th,{children:`When`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`OPEN_REQUEST_EXISTS`})}),_jsxs(_components.td,{children:[`An open request exists for the same NPN, state and carrier, including one made for another of your agencies with that NPN, under another of your products with that carrier, or in the Turris dashboard. Carries `,_jsx(_components.code,{children:`details.existingAppointmentRequestId`}),` and `,_jsx(_components.code,{children:`details.isStateAuthorized`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`ALREADY_APPOINTED`})}),_jsxs(_components.td,{children:[`The agent or agency already holds an active appointment with the carrier in the state. No request was made. When the appointment covers every line of authority the product needs, the call authorizes the state. Carries `,_jsx(_components.code,{children:`details.isStateAuthorized`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`PRODUCT_NOT_IN_ORGANIZATION`})}),_jsxs(_components.td,{children:[`The product does not exist or is not one of your products. This is a `,_jsx(_components.code,{children:`422`}),`, not a `,_jsx(_components.code,{children:`404`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`PRODUCT_HAS_NO_CARRIER`})}),_jsx(_components.td,{children:`The product has no carrier to appoint with.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`STATE_NOT_SOLD`})}),_jsx(_components.td,{children:`The product is not sold in the state.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`APPOINTMENT_REQUIREMENT_NOT_SET_UP`})}),_jsx(_components.td,{children:`The product’s setup for the state has no appointment requirement for this kind of entity (agent or agency).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`APPOINTMENT_FILING_NOT_REQUIRED`})}),_jsx(_components.td,{children:`The state takes no appointment filing for this kind of entity (Registry).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`NOT_LICENSED`})}),_jsx(_components.td,{children:`The agent or agency is not licensed in the state for the product, according to its NIPR data in Turris.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`LICENSE_DATA_NOT_SYNCED`})}),_jsxs(_components.td,{children:[`Turris has no license data for the agent or agency yet, because its compliance data has not synced from NIPR. Carries `,_jsx(_components.code,{children:`details.syncStatus`}),` and `,_jsx(_components.code,{children:`details.niprDataSubscriptionId`}),`, and `,_jsx(_components.code,{children:`details.awaitingBusinessCopyDate`}),` while the sync waits for NIPR’s overnight update. See `,_jsx(_components.a,{href:`#license-data-not-synced-yet`,children:`License Data Not Synced Yet`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`NOT_AUTHORIZED`})}),_jsx(_components.td,{children:`The agent or agency is not authorized in the state, and this request cannot authorize it, for example because the agent is on several of your agencies.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`NO_NIPR_DATA_SUBSCRIPTION`})}),_jsx(_components.td,{children:`Turris has no NIPR data subscription for the agent or agency through this relationship, typically because it has no NPN.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`AGENT_NOT_ACTIVE_ON_AGENCY`})}),_jsx(_components.td,{children:`The agent is no longer active on the agency the request would go through.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{}),_jsxs(_components.td,{children:[`Not exactly one of `,_jsx(_components.code,{children:`agentId`}),` and `,_jsx(_components.code,{children:`downstreamEntityAssociationId`}),`, an invalid `,_jsx(_components.code,{children:`stateCode`}),` or id, or an `,_jsx(_components.code,{children:`idempotency-key`}),` that is not a UUID.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{}),_jsx(_components.td,{children:`The association is not one of yours or is archived, or the agent is not active on any of your agencies. Unlike List Appointment Requests, an archived association cannot be requested.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{}),_jsxs(_components.td,{children:[`A concurrent change to the same agent or agency kept the request from settling, the request was created but could not be read back, or the call could not confirm that it authorized the state. Retry after the number of seconds in the `,_jsx(_components.code,{children:`Retry-After`}),` header. The retry answers as this call would have: if a request was made, `,_jsx(_components.code,{children:`409`}),` `,_jsx(_components.code,{children:`OPEN_REQUEST_EXISTS`}),` with its id; if the state was authorized on an appointment already held, `,_jsx(_components.code,{children:`409`}),` `,_jsx(_components.code,{children:`ALREADY_APPOINTED`}),`; either with `,_jsx(_components.code,{children:`details.isStateAuthorized`}),`.`]})]})]})]}),`\n`,_jsx(_components.p,{children:`When several refusals apply, which one you get follows the order Turris checks them in. That order is not part of the contract: branch on the code, not on the order.`}),`\n`,_jsxs(_components.p,{children:[`A `,_jsx(_components.code,{children:`409`}),` for an open request:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`12`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"statusCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`409`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requestId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"abcd1234\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errorType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"conflict\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errorMessage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"An appointment request for this NPN, state and carrier is already open.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-13T15:04:05.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"details\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"refusalCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"OPEN_REQUEST_EXISTS\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"existingAppointmentRequestId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6672b1c2d3e4f5a6b7c8d9e0\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isStateAuthorized\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`A `,_jsx(_components.code,{children:`422`}),` has the same shape, with `,_jsx(_components.code,{children:`errorType`}),` `,_jsx(_components.code,{children:`unprocessable_entity`}),` and neither `,_jsx(_components.code,{children:`existingAppointmentRequestId`}),` nor `,_jsx(_components.code,{children:`isStateAuthorized`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`license-data-not-synced-yet`,children:`License Data Not Synced Yet`}),`\n`,_jsxs(_components.p,{children:[`The license check reads the agent’s or agency’s NIPR data in Turris. Until its compliance data subscription has synced, Turris has no license on record, so the request is refused with `,_jsx(_components.code,{children:`LICENSE_DATA_NOT_SYNCED`}),` rather than `,_jsx(_components.code,{children:`NOT_LICENSED`}),`. A newly added agent or agency can get this while its first sync runs, and a first sync requested after about 8:45 PM Central waits for NIPR’s next overnight update.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`details.syncStatus`}),` says where the sync is and what to do:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.code,{children:`details.syncStatus`})}),_jsx(_components.th,{children:`What to do`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`queued`}),`, `,_jsx(_components.code,{children:`processing`})]}),_jsxs(_components.td,{children:[`Wait for the sync to finish, then request again. The `,_jsx(_components.a,{href:`/guides/webhooks/compliance-data-synchronized`,children:`Compliance Data Synchronized`}),` webhook tells you when; match it on `,_jsx(_components.code,{children:`niprDataSubscriptionId`}),`. While the sync waits for NIPR’s overnight update, `,_jsx(_components.code,{children:`details.awaitingBusinessCopyDate`}),` is the date of that update (YYYY-MM-DD).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`not started`})}),_jsxs(_components.td,{children:[`No sync has been requested. Start one with `,_jsx(_components.a,{href:`/api-reference/v2/compliance-data-subscriptions/sync-agent`,children:`Sync Agent`}),` or `,_jsx(_components.a,{href:`/api-reference/v2/compliance-data-subscriptions/sync-downstream-entity`,children:`Sync Downstream Entity`}),`, then request again after it finishes.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`processing error`}),`, `,_jsx(_components.code,{children:`NIPR error`})]}),_jsx(_components.td,{children:`The last sync failed. A sync that Turris is still retrying can show this status for a short while, so request again a little later; if it stays, contact Turris support to have the sync retried, then request again after it finishes.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`You can also follow the sync with `,_jsx(_components.a,{href:`/api-reference/v2/compliance-data-subscriptions/get-status`,children:`Get Subscription Status`}),`, using `,_jsx(_components.code,{children:`details.niprDataSubscriptionId`}),`. If no webhook has arrived by the end of the next business day, contact Turris support.`]}),`\n`,_jsxs(_components.p,{children:[`Once the sync has finished, an agent or agency that is not licensed in the state is refused with `,_jsx(_components.code,{children:`NOT_LICENSED`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"statusCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`422`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requestId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"abcd1234\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errorType\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"unprocessable_entity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"errorMessage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"This entity's compliance data has not synced from NIPR yet, so Turris has no license data to check. Request again after the sync completes; the ENTITY_COMPLIANCE_DATA_SYNCHRONIZED webhook tells you when.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timestamp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-17T02:52:11.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"details\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"refusalCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"LICENSE_DATA_NOT_SYNCED\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"syncStatus\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"queued\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"niprDataSubscriptionId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"507f1f77bcf86cd799439013\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"awaitingBusinessCopyDate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-11-17\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}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 an Appointment","description":"Request one appointment, and get the request or the reason it was refused","openapi":"openapi/v2.json POST /v2/upstream/appointment-requests","href":"/api-reference/v2/appointments/create-appointment-request"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request Body","slug":"request-body","depth":2,"children":[]},{"title":"What You Get Back","slug":"what-you-get-back","depth":2,"children":[]},{"title":"Authorization in the Same Request","slug":"authorization-in-the-same-request","depth":2,"children":[]},{"title":"One Request per Call","slug":"one-request-per-call","depth":2,"children":[]},{"title":"Calling It Again","slug":"calling-it-again","depth":2,"children":[]},{"title":"Refusals","slug":"refusals","depth":2,"children":[]},{"title":"License Data Not Synced Yet","slug":"license-data-not-synced-yet","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/turris/0c051c093ff073c0/scripts/filter-openapi.js"],"openApiReferenceData":{"operation":{"description":"Request one appointment, and get the request or the reason it was refused","operationId":"AppointmentRequestsV2Controller_createAppointmentRequest_v2","parameters":["4e443514-fab4-4917-8929-c30d997bef04","1aa3ba93-7a8d-4166-b6ca-bcb7607a25fc"],"requestBody":"abdeb288-b04c-4c03-97bc-33c04401211d","responses":{"201":"13b03421-2703-4264-b39a-7a450be0cd79","400":"65f869ae-d242-45ca-8f40-b8011f2fc428","401":"fdc51f14-762b-4010-9ec2-d3b83d62c4ff","403":"c179908b-7faf-4822-99ca-c3db6831a9e5","404":"7c4435ca-c4fa-4191-b167-d0d92e2ef126","409":"23b274b1-e137-4274-91e4-9e21358962ee","422":"4274a379-8ec5-4745-bdec-1ebcaea9c253","429":"4f736655-0d6e-47a5-b50d-d0fb3f05a0d2","503":"67a31528-e263-4b8e-819d-65d8d4a89f77"},"summary":"Request an appointment","tags":["upstream/appointment-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/appointment-requests","baseUrlOptions":["https://public.api.live.turrisfi.com","https://public.api.sandbox.turrisfi.com"],"title":"Request an appointment","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.stateCode":"TX","body.productId":"6600a1b2c3d4e5f6a7b8c9d0","body.agentId":"6650a1b2c3d4e5f6a7b8c9d0","body.downstreamEntityAssociationId":"6651a1b2c3d4e5f6a7b8c9d0"}]},"dependencies":{"parameters":{"4e443514-fab4-4917-8929-c30d997bef04":{"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"}},"1aa3ba93-7a8d-4166-b6ca-bcb7607a25fc":{"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":{"stateCode":{"type":"string","description":"The state or territory to be appointed in","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":"TX","isRequired":true,"uniqueKey":"stateCode","typeLabel":"enum\u003cstring>"},"productId":{"type":"string","description":"One of your products. Its carrier is the one the appointment is requested with.","example":"6600a1b2c3d4e5f6a7b8c9d0","isRequired":true,"uniqueKey":"productId","typeLabel":"string"},"agentId":{"type":"string","description":"The producer to request the appointment for. Send this or downstreamEntityAssociationId, not both. If the agent is on exactly one of your agencies, a licensed state it is not yet authorized in is authorized through that agency in the same request.","example":"6650a1b2c3d4e5f6a7b8c9d0","uniqueKey":"agentId","typeLabel":"string"},"downstreamEntityAssociationId":{"type":"string","description":"The agency to request the appointment for, as one of your associations. Send this or agentId, not both.","example":"6651a1b2c3d4e5f6a7b8c9d0","uniqueKey":"downstreamEntityAssociationId","typeLabel":"string"}},"required":["stateCode","productId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"stateCode":"TX","productId":"6600a1b2c3d4e5f6a7b8c9d0","agentId":"6650a1b2c3d4e5f6a7b8c9d0","downstreamEntityAssociationId":"6651a1b2c3d4e5f6a7b8c9d0"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"13b03421-2703-4264-b39a-7a450be0cd79":{"description":"The appointment request","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"stateCode":{"type":"string","description":"State or territory of the request","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":"TX","isRequired":true,"uniqueKey":"data.stateCode","typeLabel":"enum\u003cstring>"},"productId":{"type":"string","description":"The product the request was made under","example":"6600a1b2c3d4e5f6a7b8c9d0","isRequired":true,"uniqueKey":"data.productId","typeLabel":"string"},"carrier":{"type":"object","description":"The carrier, as it was when the request was made","required":["name"],"properties":{"name":{"type":"string","description":"Carrier name, as it was when the request was made","example":"Example Mutual Insurance","isRequired":true,"uniqueKey":"data.carrier.name","typeLabel":"string"},"companyCode":{"type":"string","description":"NAIC company code. Absent on older requests that never stored one.","example":"12345","uniqueKey":"data.carrier.companyCode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.carrier","typeLabel":"object"},"linesOfAuthority":{"description":"Lines of authority the request covers. Filled by Turris.","type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Line-of-authority code","example":"16","isRequired":true,"uniqueKey":"data.linesOfAuthority.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","description":"Line-of-authority name","example":"Property","isRequired":true,"uniqueKey":"data.linesOfAuthority.items.[INDEX].name","typeLabel":"string"}},"required":["code","name"],"uniqueKey":"data.linesOfAuthority.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.linesOfAuthority","typeLabel":"object[]"},"status":{"type":"string","description":"Where the request is. Today Turris operations move requests between statuses by hand; with filing automation they move on their own. Every value is listed so that change adds no new one.","enum":["pending","submitting","submitted","completed","failed","submission failed","rejected","canceled","archived"],"example":"pending","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"processingMethod":{"type":"string","description":"Whether the request is filed by hand or automatically. Every request is filed by hand today.","enum":["automated","manual"],"example":"manual","isRequired":true,"uniqueKey":"data.processingMethod","typeLabel":"enum\u003cstring>"},"requestedAt":{"type":"string","description":"When the request was made (ISO 8601)","example":"2026-11-10T15:04:05.000Z","isRequired":true,"uniqueKey":"data.requestedAt","typeLabel":"string"},"appointmentRequestId":{"type":"string","description":"Appointment request ID","example":"6672b1c2d3e4f5a6b7c8d9e0","isRequired":true,"uniqueKey":"data.appointmentRequestId","typeLabel":"string"},"agentId":{"type":"string","description":"Set when the request is for a producer. At most one of agentId and downstreamEntityAssociationId is set.","example":"6650a1b2c3d4e5f6a7b8c9d0","uniqueKey":"data.agentId","typeLabel":"string"},"downstreamEntityAssociationId":{"type":"string","description":"Set when the request is for an agency. At most one of agentId and downstreamEntityAssociationId is set. If the agency is no longer associated with you, this is the most recent association you had with it; when no association with the agency is left at all, neither field is set.","example":"6651a1b2c3d4e5f6a7b8c9d0","uniqueKey":"data.downstreamEntityAssociationId","typeLabel":"string"},"submittedAt":{"type":"string","description":"When the request was filed with the state (ISO 8601): the time of its most recent move to submitted. Kept when the request moves on, removed if it goes back to pending or submitting, and absent on a request that never reached submitted and on requests submitted before Turris started recording it.","example":"2026-11-11T09:30:00.000Z","uniqueKey":"data.submittedAt","typeLabel":"string"},"completedAt":{"type":"string","description":"When the request completed (ISO 8601). Absent until then, and on some requests completed before Turris recorded the date, so use status as the completion signal.","example":"2026-11-14T16:00:00.000Z","uniqueKey":"data.completedAt","typeLabel":"string"},"canceledAt":{"type":"string","description":"When the request was canceled (ISO 8601). Set only on a canceled request, and absent on requests canceled before Turris started recording it, so use status as the signal that a request is canceled.","example":"2026-11-16T10:00:00.000Z","uniqueKey":"data.canceledAt","typeLabel":"string"},"canceledBy":{"type":"object","description":"Who canceled the request, as the kind of actor only. Set only on a canceled request, together with canceledAt.","required":["type"],"properties":{"type":{"type":"string","description":"Who canceled the request: api_client for a call to the cancel endpoint with your API credentials, member for a person signed in to the Turris dashboard, admin for Turris operations, and system for Turris acting on its own with no person or API call behind it. Member ids and emails are not exposed.","enum":["member","api_client","admin","agent","system"],"example":"api_client","isRequired":true,"uniqueKey":"data.canceledBy.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.canceledBy","typeLabel":"object"}},"required":["stateCode","productId","carrier","linesOfAuthority","status","processingMethod","requestedAt","appointmentRequestId"],"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":{"stateCode":"TX","productId":"6600a1b2c3d4e5f6a7b8c9d0","carrier":{"name":"Example Mutual Insurance","companyCode":"12345"},"linesOfAuthority":[{"code":"16","name":"Property"}],"status":"pending","processingMethod":"manual","requestedAt":"2026-11-10T15:04:05.000Z","appointmentRequestId":"6672b1c2d3e4f5a6b7c8d9e0","agentId":"6650a1b2c3d4e5f6a7b8c9d0","downstreamEntityAssociationId":"6651a1b2c3d4e5f6a7b8c9d0","submittedAt":"2026-11-11T09:30:00.000Z","completedAt":"2026-11-14T16:00:00.000Z","canceledAt":"2026-11-16T10:00:00.000Z","canceledBy":{"type":"api_client"}},"requestId":"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8","timestamp":"2025-11-12T20:49:03.293Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"65f869ae-d242-45ca-8f40-b8011f2fc428":{"description":"Invalid body, or not exactly one of agentId and downstreamEntityAssociationId","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"},"fdc51f14-762b-4010-9ec2-d3b83d62c4ff":{"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"},"c179908b-7faf-4822-99ca-c3db6831a9e5":{"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"},"7c4435ca-c4fa-4191-b167-d0d92e2ef126":{"description":"The association is not one of yours or is archived, or the agent is not active on any of your agencies","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"},"23b274b1-e137-4274-91e4-9e21358962ee":{"description":"OPEN_REQUEST_EXISTS: an open request already exists for this NPN, state and carrier, made for this agent or agency, for another of your agencies with the same NPN, or under another of your products with the same carrier. details.existingAppointmentRequestId is its id. ALREADY_APPOINTED: the entity already holds the appointment, so no request was made and no id is returned. With either code, details.isStateAuthorized says whether the state is authorized for the product after the call: a licensed state is authorized by the call when an open request covers it, or when the held appointment covers every line of authority the product needs. ALREADY_APPOINTED with isStateAuthorized false means the appointment lacks such a line.","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":"Which rule refused the request, and the open request when one blocks it.","required":["refusalCode"],"properties":{"refusalCode":{"type":"string","description":"Why the request was refused. Branch on this; show errorMessage to a person.","enum":["OPEN_REQUEST_EXISTS","ALREADY_APPOINTED","PRODUCT_NOT_IN_ORGANIZATION","PRODUCT_HAS_NO_CARRIER","STATE_NOT_SOLD","APPOINTMENT_REQUIREMENT_NOT_SET_UP","APPOINTMENT_FILING_NOT_REQUIRED","NOT_LICENSED","LICENSE_DATA_NOT_SYNCED","NOT_AUTHORIZED","NO_NIPR_DATA_SUBSCRIPTION","AGENT_NOT_ACTIVE_ON_AGENCY"],"example":"NOT_LICENSED","isRequired":true,"uniqueKey":"details.refusalCode","typeLabel":"enum\u003cstring>"},"existingAppointmentRequestId":{"type":"string","description":"The open appointment request that blocks this one. Set whenever refusalCode is OPEN_REQUEST_EXISTS. It can belong to another of your agencies with the same NPN, or to another of your products with the same carrier.","example":"6672b1c2d3e4f5a6b7c8d9e0","uniqueKey":"details.existingAppointmentRequestId","typeLabel":"string"},"isStateAuthorized":{"type":"boolean","description":"Whether the state is authorized for the product you sent, after this call. Set whenever refusalCode is OPEN_REQUEST_EXISTS or ALREADY_APPOINTED. A licensed state is authorized by the call when an open request covers it, or when the appointment already held with the carrier covers every line of authority the product needs, so this is true, and it stays true on a repeat call. With ALREADY_APPOINTED, false means the appointment lacks a line of authority the product needs, so the call authorized nothing.","example":true,"uniqueKey":"details.isStateAuthorized","typeLabel":"boolean"}},"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":"NOT_LICENSED","existingAppointmentRequestId":"6672b1c2d3e4f5a6b7c8d9e0","isStateAuthorized":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"4274a379-8ec5-4745-bdec-1ebcaea9c253":{"description":"The request is not eligible. details.refusalCode says which rule refused it. LICENSE_DATA_NOT_SYNCED: Turris has no license data for the agent or agency yet; details.syncStatus says whether to wait for the sync, start one, or contact support.","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":"Which rule refused the request, and where the sync is when the license data has not synced yet.","required":["refusalCode"],"properties":{"refusalCode":{"type":"string","description":"Why the request was refused. Branch on this; show errorMessage to a person.","enum":["OPEN_REQUEST_EXISTS","ALREADY_APPOINTED","PRODUCT_NOT_IN_ORGANIZATION","PRODUCT_HAS_NO_CARRIER","STATE_NOT_SOLD","APPOINTMENT_REQUIREMENT_NOT_SET_UP","APPOINTMENT_FILING_NOT_REQUIRED","NOT_LICENSED","LICENSE_DATA_NOT_SYNCED","NOT_AUTHORIZED","NO_NIPR_DATA_SUBSCRIPTION","AGENT_NOT_ACTIVE_ON_AGENCY"],"example":"NOT_LICENSED","isRequired":true,"uniqueKey":"details.refusalCode","typeLabel":"enum\u003cstring>"},"syncStatus":{"type":"string","description":"Set only with LICENSE_DATA_NOT_SYNCED: the agent's or agency's compliance data sync status, the same value Get Subscription Status returns. queued or processing: the sync is running; request again after it completes. not started: start a sync first. processing error or NIPR error: the last sync failed.","enum":["not started","queued","processing","processing error","NIPR error"],"example":"queued","uniqueKey":"details.syncStatus","typeLabel":"enum\u003cstring>"},"niprDataSubscriptionId":{"type":"string","description":"Set only with LICENSE_DATA_NOT_SYNCED: the compliance data subscription whose sync is awaited. The Compliance Data Synchronized webhook carries the same niprDataSubscriptionId, and Get Subscription Status takes it.","example":"507f1f77bcf86cd799439013","uniqueKey":"details.niprDataSubscriptionId","typeLabel":"string"},"awaitingBusinessCopyDate":{"type":"string","description":"Set only with LICENSE_DATA_NOT_SYNCED while the sync is held for NIPR's nightly update: the date of the NIPR update it is waiting for (YYYY-MM-DD). The sync runs once that update is available, usually early on that date, Central time.","example":"2026-11-17","uniqueKey":"details.awaitingBusinessCopyDate","typeLabel":"string"}},"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":"NOT_LICENSED","syncStatus":"queued","niprDataSubscriptionId":"507f1f77bcf86cd799439013","awaitingBusinessCopyDate":"2026-11-17"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4f736655-0d6e-47a5-b50d-d0fb3f05a0d2":{"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"},"67a31528-e263-4b8e-819d-65d8d4a89f77":{"description":"A concurrent change to the same entity kept the request from settling, or the request was created but could not be read back. Retry after Retry-After; if a request exists, the retry answers 409 with its id.","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 an Appointment - Turris Public API","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/v2/appointments/create-appointment-request","matchLevel":0},"v1":{"href":"/api-reference/v1/appointments/agent-appointments","matchLevel":2}},"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-20T14:58:59.312Z","originalFileLocation":"api-reference/v2/appointments/create-appointment-request.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=\"Request one appointment, and get the request or the reason it was refused\">\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 an Appointment - Turris Public API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Request one appointment, and get the request or the reason it was refused\">\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/appointments/create-appointment-request\">\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=Appointments\u0026amp;title=Request+an+Appointment\u0026amp;description=Request+one+appointment%2C+and+get+the+request+or+the+reason+it+was+refused\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=6598c940e4d21ddfe1bd321ecd9125c9b0fd577cd2107b9a6ed67cb8ba65f99c\">\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 an Appointment - Turris Public API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Request one appointment, and get the request or the reason it was refused\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://turris.mintlify.site/_mintlify/api/og/v2?division=Appointments\u0026amp;title=Request+an+Appointment\u0026amp;description=Request+one+appointment%2C+and+get+the+request+or+the+reason+it+was+refused\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=6598c940e4d21ddfe1bd321ecd9125c9b0fd577cd2107b9a6ed67cb8ba65f99c\">\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/appointments/create-appointment-request\">\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/appointments/create-appointment-request.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/appointments/create-appointment-request#webpage\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/appointments/create-appointment-request\",\"name\":\"Request an Appointment\",\"description\":\"Request one appointment, and get the request or the reason it was refused\",\"dateModified\":\"2026-11-20T14:58:59.312Z\",\"isPartOf\":{\"@id\":\"https://docs.turrisfi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/appointments/create-appointment-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.turrisfi.com/api-reference/v2/appointments/create-appointment-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Appointments\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/appointments/agent-appointments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Request an Appointment\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/appointments/create-appointment-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.turrisfi.com/api-reference/v2/appointments/create-appointment-request#apireference\",\"headline\":\"Request an Appointment\",\"name\":\"Request an Appointment\",\"description\":\"Request one appointment, and get the request or the reason it was refused\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/appointments/create-appointment-request\",\"mainEntityOfPage\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/appointments/create-appointment-request#webpage\"},\"dateModified\":\"2026-11-20T14:58:59.312Z\",\"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/appointments/create-appointment-request.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","description":"One appointment request, to follow it until it completes","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","description":"Cancel an appointment request while it is still pending","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","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":"/api-reference/v1/appointments/agent-appointments"}]}]},{"tab":"Agency API","icon":"building-user","pages":[{"title":"Agency API","href":"/guides/agency-api"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Request an Appointment - 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"]}