Adds an NPN to an agency you added with Add before you had its NPN. Turris looks the NPN up in NIPR, sets the agency’s legal name from NIPR, and sets up its compliance data subscription, the same as an Add with an NPN. The response is the full association, identical in shape to Get Association.
What happens next
If your organization has auto-sync on, the agency’s first sync is queued straight away, as it would be after an Add with an NPN. Otherwise call Sync Downstream Entity when you are ready. A first sync can wait for NIPR’s overnight update; that page explains when.If you already monitor this NPN through another of your agencies, the agency shares that subscription. When that subscription has already synced, the license data is already there and Sync Downstream Entity answers 409.
When it is refused
Every refusal happens before anything is written.
Status
When
400
The NPN is not 1 to 10 digits
404
The association is not one of yours, or is archived
404
NIPR has no agency with that NPN
409
The agency already has an NPN. Changing an NPN is not supported through the API
409
The agency manages its own Turris account
409
Your compliance data subscription for that NPN is paused. Contact support to restore it
503
The NIPR lookup failed. Try again shortly
Send an Idempotency-Key header to retry safely: a repeated request with the same key returns the original response instead of 409.
Sandbox: NPN data in sandbox is limited and scrambled. Turris looks the NPN up as an agency, so an NPN that sandbox data records as an individual returns 404, even when it is a real agency NPN.
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"
Path Parameters
downstreamEntityAssociationId
string
required
Downstream entity association ID
Example:
"507f1f77bcf86cd799439011"
Body
application/json
npn
string
required
The agency's National Producer Number (NPN), 1 to 10 digits. Leading zeros are dropped when it is stored.
Example:
"12345678"
Response
The association, now carrying the NPN, the legal name from NIPR and the compliance data subscription
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/downstream-entity-associations/add-npn","slug":"/api-reference/v2/downstream-entity-associations/add-npn","pageMetadata":{"title":"Add NPN","description":"Add an NPN to an agency that was added without one","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/npn","href":"/api-reference/v2/downstream-entity-associations/add-npn"},"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: \"Add an NPN to an agency that was added without one\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Adds an NPN to an agency you added with `,_jsx(_components.a,{href:`/api-reference/v2/downstream-entity-associations/add`,children:`Add`}),` before you had its NPN. Turris looks the NPN up in NIPR, sets the agency’s legal name from NIPR, and sets up its compliance data subscription, the same as an Add with an NPN. The response is the full association, identical in shape to `,_jsx(_components.a,{href:`/api-reference/v2/downstream-entity-associations/get-association`,children:`Get Association`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`what-happens-next`,children:`What happens next`}),`\n`,_jsxs(_components.p,{children:[`If your organization has auto-sync on, the agency’s first sync is queued straight away, as it would be after an Add with an NPN. Otherwise call `,_jsx(_components.a,{href:`/api-reference/v2/compliance-data-subscriptions/sync-downstream-entity`,children:`Sync Downstream Entity`}),` when you are ready. A first sync can wait for NIPR’s overnight update; that page explains when.`]}),`\n`,_jsxs(_components.p,{children:[`If you already monitor this NPN through another of your agencies, the agency shares that subscription. When that subscription has already synced, the license data is already there and Sync Downstream Entity answers `,_jsx(_components.code,{children:`409`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`when-it-is-refused`,children:`When it is refused`}),`\n`,_jsx(_components.p,{children:`Every refusal happens before anything is written.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`When`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`The NPN is not 1 to 10 digits`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`The association is not one of yours, or is archived`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`NIPR has no agency with that NPN`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`The agency already has an NPN. Changing an NPN is not supported through the API`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`The agency manages its own Turris account`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`Your compliance data subscription for that NPN is paused. Contact support to restore it`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`503`})}),_jsx(_components.td,{children:`The NIPR lookup failed. Try again shortly`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Send an `,_jsx(_components.code,{children:`Idempotency-Key`}),` header to retry safely: a repeated request with the same key returns the original response instead of `,_jsx(_components.code,{children:`409`}),`.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Sandbox:`}),` NPN data in sandbox is limited and scrambled. Turris looks the NPN up as an agency, so an NPN that sandbox data records as an individual returns `,_jsx(_components.code,{children:`404`}),`, even when it is a real agency NPN.`]})})]})}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":"Add NPN","description":"Add an NPN to an agency that was added without one","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/npn","href":"/api-reference/v2/downstream-entity-associations/add-npn"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What happens next","slug":"what-happens-next","depth":2,"children":[]},{"title":"When it is refused","slug":"when-it-is-refused","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/turris/0c051c093ff073c0/scripts/filter-openapi.js"],"openApiReferenceData":{"operation":{"description":"Add an NPN to an agency that was added without one","operationId":"AssociatedDownstreamEntitiesV2Controller_addDownstreamEntityNpn_v2","parameters":["a4deec28-f819-462f-b5cd-477362e44c03","760155cf-9d80-4794-8dfb-bcfacf81acfb","83bb2533-e413-4a81-9ff3-6d315641217f"],"requestBody":"5bfc47f1-7402-4d9d-98c2-c84eae7960b0","responses":{"200":"4334c85d-d09a-4642-9938-d6df067c38a5","400":"ffd6d81f-5132-4687-acc9-d8d6c5ee79dd","401":"58f9feae-cbcc-4541-afed-8449dabbfb70","403":"f90f9f42-fc9c-4b0b-a2a5-8f79e9453ea0","404":"cc053ba6-951e-4956-8461-8d9d86c421b2","409":"b870f25f-860a-4881-b482-6d57dd98e6b0","429":"b834349e-73ad-4418-980c-5b6390b35d83","503":"ca81ca2b-72fa-49ea-834a-e32874373da7"},"summary":"Add an NPN","tags":["upstream/downstream-entity-associations"],"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/downstream-entity-associations/{downstreamEntityAssociationId}/npn","baseUrlOptions":["https://public.api.live.turrisfi.com","https://public.api.sandbox.turrisfi.com"],"title":"Add an NPN","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.npn":"12345678"}]},"dependencies":{"parameters":{"a4deec28-f819-462f-b5cd-477362e44c03":{"name":"downstreamEntityAssociationId","required":true,"in":"path","description":"Downstream entity association ID","schema":{"example":"507f1f77bcf86cd799439011","type":"string","isRequired":true,"description":"Downstream entity association ID","uniqueKey":"","typeLabel":"string"}},"760155cf-9d80-4794-8dfb-bcfacf81acfb":{"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"}},"83bb2533-e413-4a81-9ff3-6d315641217f":{"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":{"npn":{"type":"string","description":"The agency's National Producer Number (NPN), 1 to 10 digits. Leading zeros are dropped when it is stored.","example":"12345678","isRequired":true,"uniqueKey":"npn","typeLabel":"string"}},"required":["npn"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"npn":"12345678"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4334c85d-d09a-4642-9938-d6df067c38a5":{"description":"The association, now carrying the NPN, the legal name from NIPR and the compliance data subscription","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"_id":{"type":"string","description":"Association ID","isRequired":true,"uniqueKey":"data._id","typeLabel":"string"},"isNpnRequired":{"type":"boolean","description":"Whether your organization requires this downstream entity's NPN for this relationship. You set it when you add or invite the entity; it decides whether compliance is evaluated on the entity's own licenses or on its producers'.","isRequired":true,"uniqueKey":"data.isNpnRequired","typeLabel":"boolean"},"downstreamEntity":{"type":"object","description":"Downstream entity details","required":["_id","isNpnRequired","legalName","category","npn","ein"],"properties":{"_id":{"type":"string","description":"Downstream entity ID","isRequired":true,"uniqueKey":"data.downstreamEntity._id","typeLabel":"string"},"isNpnRequired":{"type":"boolean","description":"Same value as the association's `isNpnRequired`, kept for compatibility. Read the top-level field.","isRequired":true,"uniqueKey":"data.downstreamEntity.isNpnRequired","typeLabel":"boolean"},"legalName":{"type":"string","description":"Legal name of the downstream entity","isRequired":true,"uniqueKey":"data.downstreamEntity.legalName","typeLabel":"string"},"category":{"type":"string","description":"Category of the downstream entity","isRequired":true,"uniqueKey":"data.downstreamEntity.category","typeLabel":"string"},"npn":{"type":"string","description":"National Producer Number","isRequired":true,"uniqueKey":"data.downstreamEntity.npn","typeLabel":"string"},"ein":{"type":"string","description":"Employer Identification Number","isRequired":true,"uniqueKey":"data.downstreamEntity.ein","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.downstreamEntity","typeLabel":"object"},"niprDataSubscription":{"type":"object","description":"NIPR data subscription for this association","required":["dataOwnerId","dataOwnerModel","entityModel","entityInfo"],"properties":{"dataOwnerId":{"type":"string","description":"Data owner ID","isRequired":true,"uniqueKey":"data.niprDataSubscription.dataOwnerId","typeLabel":"string"},"dataOwnerModel":{"type":"string","description":"Data owner model type","isRequired":true,"uniqueKey":"data.niprDataSubscription.dataOwnerModel","typeLabel":"string"},"entityModel":{"type":"string","description":"Entity model type","isRequired":true,"uniqueKey":"data.niprDataSubscription.entityModel","typeLabel":"string"},"entityInfo":{"type":"object","description":"NIPR entity info details","required":["status"],"properties":{"status":{"type":"string","description":"Status of the NIPR data subscription","isRequired":true,"uniqueKey":"data.niprDataSubscription.entityInfo.status","typeLabel":"string"},"jobId":{"type":"string","description":"Job ID for the NIPR entity info request","uniqueKey":"data.niprDataSubscription.entityInfo.jobId","typeLabel":"string"},"message":{"type":"string","description":"Message associated with the status","uniqueKey":"data.niprDataSubscription.entityInfo.message","typeLabel":"string"},"rawEntityInfoId":{"type":"string","description":"Raw entity info document ID","uniqueKey":"data.niprDataSubscription.entityInfo.rawEntityInfoId","typeLabel":"string"},"awaitingBusinessCopyDate":{"type":"string","description":"Set only while a sync is held for NIPR's nightly update (a first sync, or a sync after monitoring was paused): 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":"data.niprDataSubscription.entityInfo.awaitingBusinessCopyDate","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.niprDataSubscription.entityInfo","typeLabel":"object"},"npn":{"oneOf":[{"type":"string","description":"National Producer Number","uniqueKey":"data.niprDataSubscription.npn.oneOf.0","typeLabel":"string"},{"type":"null","description":"National Producer Number","uniqueKey":"data.niprDataSubscription.npn.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.niprDataSubscription.npn","typeLabel":"string | null"},"lastSynchronizationDate":{"format":"date-time","type":"string","description":"Last synchronization date","uniqueKey":"data.niprDataSubscription.lastSynchronizationDate","typeLabel":"string\u003cdate-time>"},"pdbAlertsSubscriptionStatus":{"type":"string","description":"PDB Alerts subscription status","uniqueKey":"data.niprDataSubscription.pdbAlertsSubscriptionStatus","typeLabel":"string"},"pdbAlertsPausedAt":{"format":"date-time","type":"string","description":"Date when PDB Alerts was paused","uniqueKey":"data.niprDataSubscription.pdbAlertsPausedAt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.niprDataSubscription","typeLabel":"object"},"path":{"type":"string","description":"Materialized ancestor chain, \"/rootId/parentId/currentId\". Segments are association ids, so each one can be looked up through this same endpoint. A top-level agency is \"/ownId\". Snapshot: moving an agency to a different parent rewrites it. In the rare case where an association has no stored path, this is synthesized as \"/ownId\" so the field is always present.","isRequired":true,"uniqueKey":"data.path","typeLabel":"string"},"level":{"type":"number","description":"Depth in the hierarchy. 0 is a top-level agency.","isRequired":true,"uniqueKey":"data.level","typeLabel":"number"},"parentAssociationId":{"oneOf":[{"type":"string","description":"Immediate parent association id. Null for a top-level agency, never absent.","isRequired":true,"uniqueKey":"data.parentAssociationId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Immediate parent association id. Null for a top-level agency, never absent.","isRequired":true,"uniqueKey":"data.parentAssociationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.parentAssociationId","typeLabel":"string | null"},"ultimateParentAssociationId":{"type":"string","description":"First segment of path. A top-level agency is its own ultimate parent.","isRequired":true,"uniqueKey":"data.ultimateParentAssociationId","typeLabel":"string"},"ultimateParentAgreementExecuted":{"type":"boolean","description":"Whether the ultimate parent has an executed producer agreement. Always refers to the ROOT of the chain, never to the nearest ancestor that happens to have signed; at depth two those coincide. Snapshot as of this response.","isRequired":true,"uniqueKey":"data.ultimateParentAgreementExecuted","typeLabel":"boolean"},"producerCode":{"type":"string","description":"Producer code","uniqueKey":"data.producerCode","typeLabel":"string"},"externalId":{"type":"string","description":"External ID","uniqueKey":"data.externalId","typeLabel":"string"},"branchName":{"type":"string","description":"Branch or office name for this association","uniqueKey":"data.branchName","typeLabel":"string"},"creationPath":{"type":"string","description":"How this association was created: invitation, addition, bulk-upload, market, or hubspot sync. Immutable once set.","uniqueKey":"data.creationPath","typeLabel":"string"},"entityType":{"type":"string","description":"Your record of the agency's legal structure. Absent when never set.","enum":["C-Corp","LLC","Partnership","S-Corp","Sole Proprietor"],"example":"LLC","uniqueKey":"data.entityType","typeLabel":"enum\u003cstring>"},"legalAddress":{"type":"object","description":"Your record of the agency's legal address. Absent when never set.","required":["country"],"properties":{"country":{"type":"string","description":"Country","example":"USA","isRequired":true,"uniqueKey":"data.legalAddress.country","typeLabel":"string"},"line1":{"type":"string","description":"Street address line 1","example":"1200 Market St","uniqueKey":"data.legalAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address line 2","example":"Suite 400","uniqueKey":"data.legalAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City","example":"Philadelphia","uniqueKey":"data.legalAddress.city","typeLabel":"string"},"zip":{"type":"string","description":"ZIP code","example":"19107","uniqueKey":"data.legalAddress.zip","typeLabel":"string"},"state":{"type":"string","description":"Two-letter state code","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"],"example":"PA","uniqueKey":"data.legalAddress.state","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.legalAddress","typeLabel":"object"},"mailingAddress":{"type":"object","description":"Your record of the agency's mailing address. Absent when never set.","required":["country"],"properties":{"country":{"type":"string","description":"Country","example":"USA","isRequired":true,"uniqueKey":"data.mailingAddress.country","typeLabel":"string"},"line1":{"type":"string","description":"Street address line 1","example":"1200 Market St","uniqueKey":"data.mailingAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address line 2","example":"Suite 400","uniqueKey":"data.mailingAddress.line2","typeLabel":"string"},"city":{"type":"string","description":"City","example":"Philadelphia","uniqueKey":"data.mailingAddress.city","typeLabel":"string"},"zip":{"type":"string","description":"ZIP code","example":"19107","uniqueKey":"data.mailingAddress.zip","typeLabel":"string"},"state":{"type":"string","description":"Two-letter state code","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"],"example":"PA","uniqueKey":"data.mailingAddress.state","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.mailingAddress","typeLabel":"object"},"doingBusinessAs":{"type":"string","description":"Your record of the agency's doing-business-as name. Absent when never set.","example":"Example Insurance Agency","uniqueKey":"data.doingBusinessAs","typeLabel":"string"},"website":{"type":"string","description":"Your record of the agency's website. Absent when never set.","example":"https://www.example-agency.com","uniqueKey":"data.website","typeLabel":"string"},"phoneNumber":{"type":"string","description":"Your record of the agency's phone number. Absent when never set. A number written through Update Association is in the form +1 (215) 555-0100; one entered elsewhere is returned as stored.","example":"+1 (215) 555-0100","uniqueKey":"data.phoneNumber","typeLabel":"string"},"faxNumber":{"type":"string","description":"Your record of the agency's fax number. Absent when never set. Same form as phoneNumber.","example":"+1 (215) 555-0101","uniqueKey":"data.faxNumber","typeLabel":"string"}},"required":["_id","isNpnRequired","downstreamEntity","niprDataSubscription","path","level","parentAssociationId","ultimateParentAssociationId","ultimateParentAgreementExecuted"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"requestId":{"type":"string","description":"Unique request identifier","example":"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","description":"Response timestamp","example":"2025-11-12T20:49:03.293Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"}},"required":["data","requestId","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"_id":"\u003cstring>","isNpnRequired":true,"downstreamEntity":{"_id":"\u003cstring>","isNpnRequired":true,"legalName":"\u003cstring>","category":"\u003cstring>","npn":"\u003cstring>","ein":"\u003cstring>"},"niprDataSubscription":{"dataOwnerId":"\u003cstring>","dataOwnerModel":"\u003cstring>","entityModel":"\u003cstring>","entityInfo":{"status":"\u003cstring>","jobId":"\u003cstring>","message":"\u003cstring>","rawEntityInfoId":"\u003cstring>","awaitingBusinessCopyDate":"2026-11-17"},"npn":"\u003cstring>","lastSynchronizationDate":"2023-11-07T05:31:56Z","pdbAlertsSubscriptionStatus":"\u003cstring>","pdbAlertsPausedAt":"2023-11-07T05:31:56Z"},"path":"\u003cstring>","level":123,"parentAssociationId":"\u003cstring>","ultimateParentAssociationId":"\u003cstring>","ultimateParentAgreementExecuted":true,"producerCode":"\u003cstring>","externalId":"\u003cstring>","branchName":"\u003cstring>","creationPath":"\u003cstring>","entityType":"LLC","legalAddress":{"country":"USA","line1":"1200 Market St","line2":"Suite 400","city":"Philadelphia","zip":"19107","state":"PA"},"mailingAddress":{"country":"USA","line1":"1200 Market St","line2":"Suite 400","city":"Philadelphia","zip":"19107","state":"PA"},"doingBusinessAs":"Example Insurance Agency","website":"https://www.example-agency.com","phoneNumber":"+1 (215) 555-0100","faxNumber":"+1 (215) 555-0101"},"requestId":"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8","timestamp":"2025-11-12T20:49:03.293Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"ffd6d81f-5132-4687-acc9-d8d6c5ee79dd":{"description":"The NPN is not 1 to 10 digits","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"},"58f9feae-cbcc-4541-afed-8449dabbfb70":{"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"},"f90f9f42-fc9c-4b0b-a2a5-8f79e9453ea0":{"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"},"cc053ba6-951e-4956-8461-8d9d86c421b2":{"description":"Downstream entity association not found, or NIPR has no agency with that NPN","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"},"b870f25f-860a-4881-b482-6d57dd98e6b0":{"description":"The agency already has an NPN, manages its own Turris account, or the NPN's compliance data subscription is paused","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"},"b834349e-73ad-4418-980c-5b6390b35d83":{"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"},"ca81ca2b-72fa-49ea-834a-e32874373da7":{"description":"The NIPR lookup failed; try again","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":"Add NPN - Turris Public API","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/v2/downstream-entity-associations/add-npn","matchLevel":0},"v1":{"href":"/api-reference/v1/downstream-entity-associations/list-associations","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-16T13:36:02.757Z","originalFileLocation":"api-reference/v2/downstream-entity-associations/add-npn.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=\"Add an NPN to an agency that was added without one\">\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=\"Add NPN - Turris Public API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add an NPN to an agency that was added without one\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Turris Public API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn\">\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=Agencies+You+Appoint\u0026amp;title=Add+NPN\u0026amp;description=Add+an+NPN+to+an+agency+that+was+added+without+one\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=d4864f3dafd8e6994af0bac724ef1be8e0a60aa98496b817eee414c8c23ad8a8\">\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=\"Add NPN - Turris Public API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add an NPN to an agency that was added without one\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://turris.mintlify.site/_mintlify/api/og/v2?division=Agencies+You+Appoint\u0026amp;title=Add+NPN\u0026amp;description=Add+an+NPN+to+an+agency+that+was+added+without+one\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=d4864f3dafd8e6994af0bac724ef1be8e0a60aa98496b817eee414c8c23ad8a8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/turris/UYm7mYboWneVSCYG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Turris Public API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006cff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/downstream-entity-associations/add-npn.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.turrisfi.com/#organization\",\"name\":\"Turris Public API\",\"url\":\"https://docs.turrisfi.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.turrisfi.com#website\",\"name\":\"Turris Public API\",\"url\":\"https://docs.turrisfi.com\",\"publisher\":{\"@id\":\"https://docs.turrisfi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn#webpage\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn\",\"name\":\"Add NPN\",\"description\":\"Add an NPN to an agency that was added without one\",\"dateModified\":\"2026-11-16T13:36:02.757Z\",\"isPartOf\":{\"@id\":\"https://docs.turrisfi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agencies You Appoint\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/list-associations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add NPN\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn#apireference\",\"headline\":\"Add NPN\",\"name\":\"Add NPN\",\"description\":\"Add an NPN to an agency that was added without one\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn\",\"mainEntityOfPage\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/downstream-entity-associations/add-npn#webpage\"},\"dateModified\":\"2026-11-16T13:36:02.757Z\",\"publisher\":{\"@id\":\"https://docs.turrisfi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.turrisfi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Turris Public API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Turris Public API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v2/downstream-entity-associations/add-npn.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","description":"Set or clear your identifiers and your record of the agency's profile on a downstream entity 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","description":"Record a signed producer agreement for an agency you appoint","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/executed-producer-agreement","href":"/api-reference/v2/downstream-entity-associations/record-executed-producer-agreement"},{"title":"Get Sign-In URL","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/sign-in-url","href":"/api-reference/v2/downstream-entity-associations/get-sign-in-url"},{"title":"Invite Downstream Entity","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/invite","href":"/api-reference/v2/downstream-entity-associations/invite"},{"title":"Add Downstream Entity","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/add","href":"/api-reference/v2/downstream-entity-associations/add"}]},{"group":"Contract Container Templates","icon":"file-contract","pages":[{"title":"List Contract Container Templates","openapi":"openapi/v2.json GET /v2/upstream/contract-container-templates","href":"/api-reference/v2/contract-container-templates/list"}]},{"group":"Agents","icon":"user","pages":[{"title":"List Agents","openapi":"openapi/v2.json GET /v2/upstream/agents","href":"/api-reference/v2/agents/list-agents"},{"title":"Get Agent","openapi":"openapi/v2.json GET /v2/upstream/agents/{agentId}","href":"/api-reference/v2/agents/get-agent"},{"title":"Create Agent","openapi":"openapi/v2.json POST /v2/upstream/agents","href":"/api-reference/v2/agents/create-agent"}]},{"group":"Contacts","icon":"address-book","pages":[{"title":"List Contacts","openapi":"openapi/v2.json GET /v2/upstream/contacts","href":"/api-reference/v2/contacts/list-contacts"},{"title":"Get Contact","openapi":"openapi/v2.json GET /v2/upstream/contacts/{contactId}","href":"/api-reference/v2/contacts/get-contact"},{"title":"Add Contact","openapi":"openapi/v2.json POST /v2/upstream/contacts","href":"/api-reference/v2/contacts/add-contact"}]},{"group":"Market Contacts","icon":"headset","pages":[{"title":"List Market Contacts","openapi":"openapi/v2.json GET /v2/upstream/market-contacts","href":"/api-reference/v2/market-contacts/list-market-contacts"}]},{"group":"Licenses","icon":"id-card","pages":[{"title":"Get Agent Licenses","openapi":"openapi/v2.json GET /v2/upstream/agents/{agentId}/licenses","href":"/api-reference/v2/licenses/agent-licenses"},{"title":"Get All Agent Licenses","openapi":"openapi/v2.json GET /v2/upstream/agents/licenses","href":"/api-reference/v2/licenses/all-agent-licenses"},{"title":"Get Downstream Entity Licenses","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/licenses","href":"/api-reference/v2/licenses/downstream-entity-licenses"},{"title":"Get All Downstream Entity Licenses","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/licenses","href":"/api-reference/v2/licenses/all-downstream-entity-licenses"},{"title":"Get Downstream Entity Surplus Lines Licenses","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/licenses/surplus-lines","href":"/api-reference/v2/licenses/surplus-lines"}]},{"group":"Appointments","icon":"calendar","pages":[{"title":"Get Agent Appointments","openapi":"openapi/v2.json GET /v2/upstream/agents/{agentId}/appointments","href":"/api-reference/v2/appointments/agent-appointments"},{"title":"Get Downstream Entity Appointments","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/appointments","href":"/api-reference/v2/appointments/downstream-entity-appointments"},{"title":"List Appointment Requests","openapi":"openapi/v2.json GET /v2/upstream/appointment-requests","href":"/api-reference/v2/appointments/list-appointment-requests"},{"title":"Get an Appointment Request","openapi":"openapi/v2.json GET /v2/upstream/appointment-requests/{appointmentRequestId}","href":"/api-reference/v2/appointments/get-appointment-request"},{"title":"Request an Appointment","openapi":"openapi/v2.json POST /v2/upstream/appointment-requests","href":"/api-reference/v2/appointments/create-appointment-request"},{"title":"Cancel an Appointment Request","openapi":"openapi/v2.json POST /v2/upstream/appointment-requests/{appointmentRequestId}/cancel","href":"/api-reference/v2/appointments/cancel-appointment-request"},{"title":"List Termination Requests","openapi":"openapi/v2.json GET /v2/upstream/termination-requests","href":"/api-reference/v2/appointments/list-termination-requests"},{"title":"Get a Termination Request","openapi":"openapi/v2.json GET /v2/upstream/termination-requests/{terminationRequestId}","href":"/api-reference/v2/appointments/get-termination-request"},{"title":"Request a Termination","openapi":"openapi/v2.json POST /v2/upstream/termination-requests","href":"/api-reference/v2/appointments/create-termination-request"},{"title":"Cancel a Termination Request","openapi":"openapi/v2.json POST /v2/upstream/termination-requests/{terminationRequestId}/cancel","href":"/api-reference/v2/appointments/cancel-termination-request"}]},{"group":"Compliance Data Subscriptions","icon":"database","pages":[{"title":"Get Subscription Status","openapi":"openapi/v2.json GET /v2/upstream/compliance-data-subscriptions/{niprDataSubscriptionId}","href":"/api-reference/v2/compliance-data-subscriptions/get-status"},{"title":"Sync Downstream Entity","openapi":"openapi/v2.json POST /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/sync","href":"/api-reference/v2/compliance-data-subscriptions/sync-downstream-entity"},{"title":"Sync Agent","openapi":"openapi/v2.json POST /v2/upstream/agents/{agentId}/sync","href":"/api-reference/v2/compliance-data-subscriptions/sync-agent"}]},{"group":"Compliance Status","icon":"circle-check","pages":[{"title":"Get Agent Compliance Status","openapi":"openapi/v2.json GET /v2/upstream/agents/{agentId}/license-compliance-statuses","href":"/api-reference/v2/compliance-status/agent-compliance"},{"title":"Get Downstream Entity Compliance Status","openapi":"openapi/v2.json GET /v2/upstream/downstream-entity-associations/{downstreamEntityAssociationId}/license-compliance-statuses","href":"/api-reference/v2/compliance-status/downstream-entity-compliance"}]},{"group":"File Documents","icon":"file","pages":[{"title":"List Documents","openapi":"openapi/v2.json GET /v2/upstream/file-documents","href":"/api-reference/v2/file-documents/list-documents"},{"title":"Get Producer Agreement Templates","openapi":"openapi/v2.json GET /v2/upstream/file-documents","href":"/api-reference/v2/file-documents/get-producer-agreement-templates"},{"title":"Upload a Document","openapi":"openapi/v2.json POST /v2/upstream/file-documents","href":"/api-reference/v2/file-documents/upload-document"},{"title":"Get a Download URL for a Document","openapi":"openapi/v2.json GET /v2/upstream/file-documents/{fileDocumentId}/download-url","href":"/api-reference/v2/file-documents/get-download-url"}]},{"group":"Policy Ingestion","icon":"file-lines","pages":[{"title":"Policies","openapi":"openapi/v2.json GET /v2/upstream/policies","href":"/api-reference/v2/policies/list-policies"},{"title":"Policy","openapi":"openapi/v2.json GET /v2/upstream/policies/{policyId}","href":"/api-reference/v2/policies/get-policy"},{"title":"Create Policy","openapi":"openapi/v2.json POST /v2/upstream/policies","href":"/api-reference/v2/policies/create-policy"},{"title":"Update Policy","openapi":"openapi/v2.json PATCH /v2/upstream/policies/{policyId}","href":"/api-reference/v2/policies/update-policy"},{"title":"Delete Policy","openapi":"openapi/v2.json DELETE /v2/upstream/policies/{policyId}","href":"/api-reference/v2/policies/delete-policy"},{"title":"Upload Policy File","openapi":"openapi/v2.json POST /v2/upstream/policies/upload","href":"/api-reference/v2/policies/upload-policy-file"},{"title":"Uploading Status","openapi":"openapi/v2.json GET /v2/upstream/policies/uploads/{uploadId}","href":"/api-reference/v2/policies/get-upload-status"}]},{"group":"Policy Transactions","icon":"arrow-right-arrow-left","pages":[{"title":"Create Transaction","openapi":"openapi/v2.json POST /v2/upstream/policies/{policyId}/transactions","href":"/api-reference/v2/policy-transactions/create-transaction"},{"title":"List Transactions","openapi":"openapi/v2.json GET /v2/upstream/policies/{policyId}/transactions","href":"/api-reference/v2/policy-transactions/list-transactions"},{"title":"Get Transaction","openapi":"openapi/v2.json GET /v2/upstream/policies/{policyId}/transactions/{transactionId}","href":"/api-reference/v2/policy-transactions/get-transaction"},{"title":"Update Transaction","openapi":"openapi/v2.json PATCH /v2/upstream/policies/{policyId}/transactions/{transactionId}","href":"/api-reference/v2/policy-transactions/update-transaction"},{"title":"Delete Transaction","openapi":"openapi/v2.json DELETE /v2/upstream/policies/{policyId}/transactions/{transactionId}","href":"/api-reference/v2/policy-transactions/delete-transaction"}]},{"group":"Surplus Lines","icon":"file-invoice-dollar","pages":[{"group":"Guides","expanded":true,"pages":[{"title":"Open a Surplus Lines Filing from Start to Finish","sidebarTitle":"Filing Walkthrough","href":"/guides/surplus-lines-filing-walkthrough"},{"title":"Files on a Surplus Lines Filing","sidebarTitle":"Files on a Filing","href":"/guides/surplus-lines-files"}]},{"group":"Filings","expanded":true,"pages":[{"title":"Surplus Lines Filings","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-filings","href":"/api-reference/v2/surplus-lines-filings/list-filings"},{"title":"Surplus Lines Filing","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-filings/{filingId}","href":"/api-reference/v2/surplus-lines-filings/get-filing"},{"title":"Open a Surplus-Lines Filing","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings","href":"/api-reference/v2/surplus-lines-filings/open-filing"},{"title":"Attach Uploaded Files to a Checklist Item","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings/{filingId}/checklist-item/file-documents","href":"/api-reference/v2/surplus-lines-filings/attach-checklist-item-file-documents"},{"title":"Set the Policy Document","openapi":"openapi/v2.json PUT /v2/upstream/surplus-lines-filings/{filingId}/policy-document","href":"/api-reference/v2/surplus-lines-filings/set-policy-document"},{"title":"Reply to a Checklist Item Escalation","openapi":"openapi/v2.json POST /v2/upstream/surplus-lines-filings/{filingId}/escalation/messages","href":"/api-reference/v2/surplus-lines-filings/reply-to-escalation"}]},{"group":"States","expanded":true,"pages":[{"title":"List Surplus Lines States","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states","href":"/api-reference/v2/surplus-lines-states/list-states"},{"title":"Get State Requirements","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states/{stateCode}/requirements","href":"/api-reference/v2/surplus-lines-states/get-requirements"},{"title":"Get State Taxes and Fees","openapi":"openapi/v2.json GET /v2/upstream/surplus-lines-states/{stateCode}/tax-and-fees","href":"/api-reference/v2/surplus-lines-states/get-tax-and-fees"},{"title":"Get a Download URL for a State Template File","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/downstream-entity-associations/list-associations"}]}]},{"tab":"Agency API","icon":"building-user","pages":[{"title":"Agency API","href":"/guides/agency-api"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Add NPN - 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"]}