Adds a contact to one of your agency relationships, the downstreamEntityAssociationId that GET /v2/upstream/contacts filters on. The contact shows on that agency’s Contacts tab in Turris and in List Contacts straight away. The response has the same shape as Get Contact.
Email addresses are unique across Turris
Contact email is unique platform-wide, not per agency, so the address you send may belong to a contact the agency or another carrier added first. In that case this endpoint links that contact to your agency relationship instead of creating a second one. It keeps the stored firstName, lastName and phoneNumber, and the response shows the stored values, which can differ from what you sent.The response lists every business role you can see the contact hold at that agency, so it can include roles from the agency’s own record of the contact as well as the ones you sent.
Primary contact
Leave isPrimary out and the contact becomes the relationship’s primary contact only when it is the first contact on it. isPrimary: true on a relationship that already has a primary contact returns 409 and nothing is written. Change the primary contact in Turris, then add this contact without isPrimary.
Contract signatories receive an email
A contact with the Contract Signatory business role is given a Turris login so they can sign, and is emailed: the contract signing request when the agency’s onboarding has reached contract signing, otherwise the onboarding invitation when they are the primary contact. Send shouldSendEmail: false to add them without the email. Turris does not email an address it has found undeliverable.The email goes out after the contact is saved. If it cannot be sent, the contact is still added and the response is the same, so a 201 does not confirm the email was delivered.One case sends nothing: if the contact is already linked to the relationship but missing from its contact list, which older writes could leave behind, the request adds it back to the list and returns 201 without changing the contact, creating a login or sending an email.
Errors
Status
When
400
The body is invalid; the email is not a real mailbox (errorType: invalid_email); or the agency cannot receive Turris logins yet and the contact is a Contract Signatory or the primary contact
404
The downstreamEntityAssociationId is not one of your live agency relationships. Nothing is written
409
The contact is already on that relationship; isPrimary is true and the relationship already has a primary contact; or the contact changed while the request ran, in which case retry it
429
More than 10 requests in 60 seconds from your organization
Retries and limits
Send an idempotency-key header. A retry with the same key within an hour returns the first response. A retry without one, after the first request succeeded, returns 409 because the contact is already on the relationship. See Idempotency.This endpoint allows 10 requests per 60 seconds per organization. See Rate limiting.
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
downstreamEntityAssociationId
string
required
The agency relationship to add the contact to. This is the downstream entity association id, the same downstreamEntityAssociationId List Contacts filters on.
Example:
"6627f1a9c2e0a51b8c0d4e3a"
firstName
string
required
Given name. Stored only when this email is new to Turris; an address Turris already knows keeps its stored name.
Example:
"Jon"
lastName
string
required
Surname. Stored only when this email is new to Turris; an address Turris already knows keeps its stored name.
Example:
"Doe"
email
string
required
Email address. Unique across Turris and matched case-insensitively, so an address Turris already knows is linked to your agency relationship rather than duplicated.
Example:
"example@test.com"
phoneNumber
string
The contact's direct phone number. Stored only when this email is new to Turris; an address Turris already knows keeps its stored number.
Example:
"+1 555 010 0199"
businessRoles
enum<string>[]
Business roles this contact holds on this agency relationship.
Available options:
Compliance Officer,
Principal Owner,
Account Manager,
Finance Manager,
Support Staff,
Contract Signatory,
Accounts Payable,
Policy Maintenance
Example:
["Contract Signatory"]
isPrimary
boolean
Whether this is the primary contact for the agency relationship. Omit it and the contact is primary only when it is the first contact on the relationship. true is refused with 409 when the relationship already has a primary contact.
Example:
false
shouldSendEmail
boolean
Set to false to add a Contract Signatory without the onboarding email Turris sends them. Defaults to true.
Example:
true
Response
The contact, as Get Contact returns it
data
object
required
Show child attributes
requestId
string
required
Unique request identifier
Example:
"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8"
timestamp
string
required
Response timestamp
Example:
"2025-11-12T20:49:03.293Z"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Turris Public API","description":"API documentation for the Turris Public API - programmatic access to compliance data for carrier and agency customers.","colors":{"primary":"#006cff","light":"#3389ff","dark":"#0a58c2"},"favicon":"https://mintcdn.com/turris/IfRLPQPmyFYwsFZX/favicon.png?fit=max\u0026auto=format\u0026n=IfRLPQPmyFYwsFZX\u0026q=85\u0026s=21d205b6e3e2b8abe477c8c7aed40817","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"],"prefill":true}},"navbar":{"links":[{"href":"mailto:support@turrisfi.com","label":"Support"}],"primary":{"type":"button","label":"Web App (Live)","href":"https://www.app.live.turrisfi.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/turrisfi"},"links":[{"header":"Resources","items":[{"label":"Website","href":"https://www.turrisfi.com"},{"label":"Web App (Live)","href":"https://www.app.live.turrisfi.com"},{"label":"Web App (Sandbox)","href":"https://www.app.sandbox.turrisfi.com"},{"label":"Support Articles","href":"https://help.turrisfi.com"}]}]},"contextual":{"options":["mcp","cursor","vscode","copy","claude","chatgpt"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"turris","hasAudioNarration":false,"actualSubdomain":"turris","customDomains":["docs.turrisfi.com"],"gitSource":{"type":"github","owner":"turrisfi","repo":"compliance","deployBranch":"prod","contentDirectory":"apps/public-api/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00f57f441f0452337b1ea4","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Carrier \u0026 MGA API","count":156},{"language":"default","tag":"Agency API","count":56},{"language":"default","tag":"Webhooks","count":26},{"language":"default","tag":"Surplus Lines","count":24},{"language":"default","tag":"Webhook Events","count":21},{"language":"default","tag":"Agencies You Appoint","count":15},{"language":"default","tag":"Appointments","count":14},{"language":"default","tag":"Policy Ingestion","count":14},{"language":"default","tag":"Licenses","count":13},{"language":"default","tag":"Documentation","count":13}],"searchSettings":{"isFiltersEnabled":true,"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@turrisfi.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"698de0cb27f1502f3265ea3b","deploymentId":"697d034dc7078c59853e519b","questionText":"How can I get my agencies' and agents' compliance status?","status":"active","generatedBy":"manual","createdAt":"2026-02-12T14:16:43.973Z","updatedAt":"2026-02-12T14:16:43.973Z","__v":0},{"_id":"698de0b027f1502f3265ea0c","deploymentId":"697d034dc7078c59853e519b","questionText":"How can I retrieve all my agencies and agents?","status":"active","generatedBy":"manual","createdAt":"2026-02-12T14:16:16.437Z","updatedAt":"2026-02-12T14:16:16.437Z","__v":0},{"_id":"698de08d27f1502f3265e9c4","deploymentId":"697d034dc7078c59853e519b","questionText":"How do I get authenticated?","status":"active","generatedBy":"manual","createdAt":"2026-02-12T14:15:41.708Z","updatedAt":"2026-02-12T14:15:41.708Z","__v":0}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/v2/contacts/add-contact","slug":"/api-reference/v2/contacts/add-contact","pageMetadata":{"title":"Add Contact","description":"Add a contact to one of your agency relationships","openapi":"openapi/v2.json POST /v2/upstream/contacts","href":"/api-reference/v2/contacts/add-contact"},"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 a contact to one of your agency relationships\"\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`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Adds a contact to one of your agency relationships, the `,_jsx(_components.code,{children:`downstreamEntityAssociationId`}),` that `,_jsx(_components.a,{href:`/api-reference/v2/contacts/list-contacts`,children:_jsx(_components.code,{children:`GET /v2/upstream/contacts`})}),` filters on. The contact shows on that agency’s Contacts tab in Turris and in List Contacts straight away. The response has the same shape as `,_jsx(_components.a,{href:`/api-reference/v2/contacts/get-contact`,children:`Get Contact`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`email-addresses-are-unique-across-turris`,children:`Email addresses are unique across Turris`}),`\n`,_jsxs(_components.p,{children:[`Contact email is unique platform-wide, not per agency, so the address you send may belong to a contact the agency or another carrier added first. In that case this endpoint links that contact to your agency relationship instead of creating a second one. It keeps the stored `,_jsx(_components.code,{children:`firstName`}),`, `,_jsx(_components.code,{children:`lastName`}),` and `,_jsx(_components.code,{children:`phoneNumber`}),`, and the response shows the stored values, which can differ from what you sent.`]}),`\n`,_jsx(_components.p,{children:`The response lists every business role you can see the contact hold at that agency, so it can include roles from the agency’s own record of the contact as well as the ones you sent.`}),`\n`,_jsx(Heading,{level:`2`,id:`primary-contact`,children:`Primary contact`}),`\n`,_jsxs(_components.p,{children:[`Leave `,_jsx(_components.code,{children:`isPrimary`}),` out and the contact becomes the relationship’s primary contact only when it is the first contact on it. `,_jsx(_components.code,{children:`isPrimary: true`}),` on a relationship that already has a primary contact returns `,_jsx(_components.code,{children:`409`}),` and nothing is written. Change the primary contact in Turris, then add this contact without `,_jsx(_components.code,{children:`isPrimary`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`contract-signatories-receive-an-email`,children:`Contract signatories receive an email`}),`\n`,_jsxs(_components.p,{children:[`A contact with the `,_jsx(_components.code,{children:`Contract Signatory`}),` business role is given a Turris login so they can sign, and is emailed: the contract signing request when the agency’s onboarding has reached contract signing, otherwise the onboarding invitation when they are the primary contact. Send `,_jsx(_components.code,{children:`shouldSendEmail: false`}),` to add them without the email. Turris does not email an address it has found undeliverable.`]}),`\n`,_jsxs(_components.p,{children:[`The email goes out after the contact is saved. If it cannot be sent, the contact is still added and the response is the same, so a `,_jsx(_components.code,{children:`201`}),` does not confirm the email was delivered.`]}),`\n`,_jsxs(_components.p,{children:[`One case sends nothing: if the contact is already linked to the relationship but missing from its contact list, which older writes could leave behind, the request adds it back to the list and returns `,_jsx(_components.code,{children:`201`}),` without changing the contact, creating a login or sending an email.`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\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`})}),_jsxs(_components.td,{children:[`The body is invalid; the email is not a real mailbox (`,_jsx(_components.code,{children:`errorType: invalid_email`}),`); or the agency cannot receive Turris logins yet and the contact is a Contract Signatory or the primary contact`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`downstreamEntityAssociationId`}),` is not one of your live agency relationships. Nothing is written`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsxs(_components.td,{children:[`The contact is already on that relationship; `,_jsx(_components.code,{children:`isPrimary`}),` is `,_jsx(_components.code,{children:`true`}),` and the relationship already has a primary contact; or the contact changed while the request ran, in which case retry it`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`429`})}),_jsx(_components.td,{children:`More than 10 requests in 60 seconds from your organization`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`retries-and-limits`,children:`Retries and limits`}),`\n`,_jsxs(_components.p,{children:[`Send an `,_jsx(_components.code,{children:`idempotency-key`}),` header. A retry with the same key within an hour returns the first response. A retry without one, after the first request succeeded, returns `,_jsx(_components.code,{children:`409`}),` because the contact is already on the relationship. See `,_jsx(_components.a,{href:`/guides/idempotency`,children:`Idempotency`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`This endpoint allows 10 requests per 60 seconds per organization. See `,_jsx(_components.a,{href:`/guides/rate-limiting`,children:`Rate limiting`}),`.`]})]})}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 Contact","description":"Add a contact to one of your agency relationships","openapi":"openapi/v2.json POST /v2/upstream/contacts","href":"/api-reference/v2/contacts/add-contact"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Email addresses are unique across Turris","slug":"email-addresses-are-unique-across-turris","depth":2,"children":[]},{"title":"Primary contact","slug":"primary-contact","depth":2,"children":[]},{"title":"Contract signatories receive an email","slug":"contract-signatories-receive-an-email","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]},{"title":"Retries and limits","slug":"retries-and-limits","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/turris/0c051c093ff073c0/scripts/filter-openapi.js"],"openApiReferenceData":{"operation":{"description":"Add a contact to one of your agency relationships","operationId":"ContactFeatureV2Controller_createContact_v2","parameters":["74745d58-ad4c-4e1d-b985-20bedb722ee3","770f6185-d582-4af1-9ab2-bcc7dde907bb"],"requestBody":"8a0518f0-7fbd-464d-b060-aaef851b5f86","responses":{"201":"c34d0ea8-6690-4a5c-a878-7261af51e72a","400":"6b3f6cc4-91a7-41e1-b472-66f3f67dc164","401":"4f8e977d-dd18-42b8-b266-b41bd49e43c8","403":"6ae3abd2-f15e-4f65-987b-316a11d5a3d0","404":"06025496-a4df-4973-af89-dcaf57d315d8","409":"bec91ffa-9e24-47cc-aa56-8921966b1f06","429":"ce5083b3-c441-4b47-9b8b-fdad8f60256e"},"summary":"Add a contact","tags":["upstream/contacts"],"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/contacts","baseUrlOptions":["https://public.api.live.turrisfi.com","https://public.api.sandbox.turrisfi.com"],"title":"Add a contact","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.downstreamEntityAssociationId":"6627f1a9c2e0a51b8c0d4e3a","body.firstName":"Jon","body.lastName":"Doe","body.email":"example@test.com","body.phoneNumber":"+1 555 010 0199","body.businessRoles.items.0":"Contract Signatory","body.isPrimary":false,"body.shouldSendEmail":true}]},"dependencies":{"parameters":{"74745d58-ad4c-4e1d-b985-20bedb722ee3":{"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"}},"770f6185-d582-4af1-9ab2-bcc7dde907bb":{"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":{"downstreamEntityAssociationId":{"type":"string","description":"The agency relationship to add the contact to. This is the downstream entity association id, the same downstreamEntityAssociationId List Contacts filters on.","example":"6627f1a9c2e0a51b8c0d4e3a","isRequired":true,"uniqueKey":"downstreamEntityAssociationId","typeLabel":"string"},"firstName":{"type":"string","description":"Given name. Stored only when this email is new to Turris; an address Turris already knows keeps its stored name.","example":"Jon","isRequired":true,"uniqueKey":"firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Surname. Stored only when this email is new to Turris; an address Turris already knows keeps its stored name.","example":"Doe","isRequired":true,"uniqueKey":"lastName","typeLabel":"string"},"email":{"type":"string","description":"Email address. Unique across Turris and matched case-insensitively, so an address Turris already knows is linked to your agency relationship rather than duplicated.","example":"example@test.com","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"phoneNumber":{"type":"string","description":"The contact's direct phone number. Stored only when this email is new to Turris; an address Turris already knows keeps its stored number.","example":"+1 555 010 0199","uniqueKey":"phoneNumber","typeLabel":"string"},"businessRoles":{"type":"array","description":"Business roles this contact holds on this agency relationship.","example":["Contract Signatory"],"items":{"type":"string","enum":["Compliance Officer","Principal Owner","Account Manager","Finance Manager","Support Staff","Contract Signatory","Accounts Payable","Policy Maintenance"],"uniqueKey":"businessRoles.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"businessRoles","typeLabel":"enum\u003cstring>[]"},"isPrimary":{"type":"boolean","description":"Whether this is the primary contact for the agency relationship. Omit it and the contact is primary only when it is the first contact on the relationship. true is refused with 409 when the relationship already has a primary contact.","example":false,"uniqueKey":"isPrimary","typeLabel":"boolean"},"shouldSendEmail":{"type":"boolean","description":"Set to false to add a Contract Signatory without the onboarding email Turris sends them. Defaults to true.","example":true,"uniqueKey":"shouldSendEmail","typeLabel":"boolean"}},"required":["downstreamEntityAssociationId","firstName","lastName","email"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"downstreamEntityAssociationId":"6627f1a9c2e0a51b8c0d4e3a","firstName":"Jon","lastName":"Doe","email":"example@test.com","phoneNumber":"+1 555 010 0199","businessRoles":["Contract Signatory"],"isPrimary":false,"shouldSendEmail":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c34d0ea8-6690-4a5c-a878-7261af51e72a":{"description":"The contact, as Get Contact returns it","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"contactId":{"type":"string","description":"Unique identifier of the contact","example":"6627f2b5c2e0a51b8c0d4e7c","isRequired":true,"uniqueKey":"data.contactId","typeLabel":"string"},"firstName":{"type":"string","description":"Contact first name","example":"Jon","isRequired":true,"uniqueKey":"data.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"Contact last name","example":"Doe","isRequired":true,"uniqueKey":"data.lastName","typeLabel":"string"},"email":{"type":"string","description":"Contact email address","example":"example@test.com","isRequired":true,"uniqueKey":"data.email","typeLabel":"string"},"isDeliverable":{"type":"boolean","description":"Whether the contact email is deliverable","example":true,"isRequired":true,"uniqueKey":"data.isDeliverable","typeLabel":"boolean"},"associations":{"description":"Agencies where you can see this contact","type":"array","items":{"type":"object","properties":{"downstreamEntityId":{"type":"string","description":"The downstream entity (agency) id","example":"6610b3d2c2e0a51b8c0d1f02","isRequired":true,"uniqueKey":"data.associations.items.[INDEX].downstreamEntityId","typeLabel":"string"},"businessRoles":{"type":"array","description":"Business roles this contact holds at this agency (union of their visible scopes there)","example":["Finance Manager"],"items":{"type":"string","enum":["Compliance Officer","Principal Owner","Account Manager","Finance Manager","Support Staff","Contract Signatory","Accounts Payable","Policy Maintenance"],"uniqueKey":"data.associations.items.[INDEX].businessRoles.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"data.associations.items.[INDEX].businessRoles","typeLabel":"enum\u003cstring>[]"},"isPrimary":{"type":"boolean","description":"Whether this contact is a primary contact for this agency relationship","example":true,"isRequired":true,"uniqueKey":"data.associations.items.[INDEX].isPrimary","typeLabel":"boolean"},"downstreamEntityAssociationId":{"type":"string","description":"The market relationship (downstream entity association / UDA) id, when a market-specific scope exists","example":"6627f1a9c2e0a51b8c0d4e3a","uniqueKey":"data.associations.items.[INDEX].downstreamEntityAssociationId","typeLabel":"string"}},"required":["downstreamEntityId","businessRoles","isPrimary"],"uniqueKey":"data.associations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.associations","typeLabel":"object[]"},"phoneNumber":{"type":"string","description":"The contact's direct phone number, when Turris holds one","example":"+1 555 010 0199","uniqueKey":"data.phoneNumber","typeLabel":"string"}},"required":["contactId","firstName","lastName","email","isDeliverable","associations"],"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":{"contactId":"6627f2b5c2e0a51b8c0d4e7c","firstName":"Jon","lastName":"Doe","email":"example@test.com","isDeliverable":true,"associations":[{"downstreamEntityId":"6610b3d2c2e0a51b8c0d1f02","businessRoles":["Finance Manager"],"isPrimary":true,"downstreamEntityAssociationId":"6627f1a9c2e0a51b8c0d4e3a"}],"phoneNumber":"+1 555 010 0199"},"requestId":"dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8","timestamp":"2025-11-12T20:49:03.293Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"6b3f6cc4-91a7-41e1-b472-66f3f67dc164":{"description":"Invalid request body, an email address that is not a real mailbox (`errorType: invalid_email`), or an agency that cannot receive Turris logins yet when the contact is a Contract Signatory or the primary contact","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"},"4f8e977d-dd18-42b8-b266-b41bd49e43c8":{"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"},"6ae3abd2-f15e-4f65-987b-316a11d5a3d0":{"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"},"06025496-a4df-4973-af89-dcaf57d315d8":{"description":"No such downstream entity association for your organization","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"requestId":{"type":"string","description":"Unique request identifier for debugging","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"errorType":{"type":"string","description":"Machine-readable error classification. Branch on this rather than on `errorMessage`, which is prose and may change. Authentication failures returned by our identity provider are forwarded verbatim, so a 401 can carry a code outside this list; treat an unrecognised value as a generic failure of its HTTP status.","enum":["conflict","contact_not_authorized","contract_already_signed","document_exceeds_page_limit","downstream_entity_member_exists","duplicate_external_id_error","duplicate_member_email","duplicate_producer_code_error","forbidden","gateway_timeout","inactive_email","internal_server_error","invalid_email","invalid_email_for_invites","invalid_organization_category","invalid_organization_slug","invalid_phone_number","invalid_token","invite_limit_reached","jwt_invalid","m2m_client_not_found","not_found","online_signing_in_progress","organization_already_exists","organization_slug_already_used","payment_required","producer_agreement_required","product_feature_subscription_required","service_unavailable","session_authorization_error","some_custom_error_string","throttled","too_many_requests","unauthorized","unauthorized_client","unexpected_400_stytch_error","unexpected_403_stytch_error","unexpected_404_stytch_error","unexpected_error","unexpected_stytch_error","unprocessable_entity","validation_error"],"example":"validation_error","isRequired":true,"uniqueKey":"errorType","typeLabel":"enum\u003cstring>"},"errorMessage":{"description":"Array of error messages","type":"array","items":{"type":"string","uniqueKey":"errorMessage.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"errorMessage","typeLabel":"string[]"},"timestamp":{"type":"string","description":"ISO timestamp when the error occurred","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"details":{"type":"object","description":"Additional error context","uniqueKey":"details","typeLabel":"object"}},"required":["statusCode","requestId","errorType","errorMessage","timestamp"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"requestId":"\u003cstring>","errorType":"validation_error","errorMessage":["\u003cstring>"],"timestamp":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"bec91ffa-9e24-47cc-aa56-8921966b1f06":{"description":"The contact is already on that association, isPrimary is true and the association already has a primary contact, or the contact changed while the request ran (retry it)","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"},"ce5083b3-c441-4b47-9b8b-fdad8f60256e":{"description":"More than 10 requests in 60 seconds from your organization. Also returned when this credential passes the API-wide limit of 1000 requests per 10 seconds, counted across every endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"requestId":{"type":"string","description":"Unique request identifier for debugging","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"errorType":{"type":"string","description":"Machine-readable error classification. Branch on this rather than on `errorMessage`, which is prose and may change. Authentication failures returned by our identity provider are forwarded verbatim, so a 401 can carry a code outside this list; treat an unrecognised value as a generic failure of its HTTP status.","enum":["conflict","contact_not_authorized","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"}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying. Sent when a rate limit refused the request.","schema":{"type":"integer"}}},"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 Contact - Turris Public API","relatedPagesConfig":{"enabled":true,"limit":3,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/v2/contacts/add-contact","matchLevel":0},"v1":{"href":"/api-reference/v1/contacts/list-contacts","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/contacts/add-contact.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 a contact to one of your agency relationships\">\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 Contact - Turris Public API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add a contact to one of your agency relationships\">\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/contacts/add-contact\">\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=Contacts\u0026amp;title=Add+Contact\u0026amp;description=Add+a+contact+to+one+of+your+agency+relationships\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=412a3e53744592e10278c79ba91964e6f1d1116a07cb781a06430418797cccee\">\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 Contact - Turris Public API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add a contact to one of your agency relationships\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://turris.mintlify.site/_mintlify/api/og/v2?division=Contacts\u0026amp;title=Add+Contact\u0026amp;description=Add+a+contact+to+one+of+your+agency+relationships\u0026amp;theme=c46ece167b2fe61e15f5803d\u0026amp;signature=412a3e53744592e10278c79ba91964e6f1d1116a07cb781a06430418797cccee\">\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/contacts/add-contact\">\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/contacts/add-contact.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/contacts/add-contact#webpage\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/contacts/add-contact\",\"name\":\"Add Contact\",\"description\":\"Add a contact to one of your agency relationships\",\"dateModified\":\"2026-11-16T13:36:02.757Z\",\"isPartOf\":{\"@id\":\"https://docs.turrisfi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/contacts/add-contact#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.turrisfi.com/api-reference/v2/contacts/add-contact#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Contacts\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/contacts/list-contacts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add Contact\",\"item\":\"https://docs.turrisfi.com/api-reference/v2/contacts/add-contact\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.turrisfi.com/api-reference/v2/contacts/add-contact#apireference\",\"headline\":\"Add Contact\",\"name\":\"Add Contact\",\"description\":\"Add a contact to one of your agency relationships\",\"url\":\"https://docs.turrisfi.com/api-reference/v2/contacts/add-contact\",\"mainEntityOfPage\":{\"@id\":\"https://docs.turrisfi.com/api-reference/v2/contacts/add-contact#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/contacts/add-contact.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","description":"Fetch a single agency contact and their business roles","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","description":"List the market contacts you have published to your agency relationships","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/contacts/list-contacts"}]}]},{"tab":"Agency API","icon":"building-user","pages":[{"title":"Agency API","href":"/guides/agency-api"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Add Contact - 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"]}