Skip to main content
POST
/
v1
/
downstream-entity-associations
/
invite
cURL
curl --request POST \
  --url https://public.api.live.turrisfi.com/v1/downstream-entity-associations/invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "useInviteUrl": false,
  "isNpnRequired": true,
  "downstreamEntityName": "ABC Insurance Agency",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "category": "agency",
  "producerCode": "PROD-001",
  "externalId": "EXT-12345",
  "producerAgreementId": "507f1f77bcf86cd799439011",
  "parentProducerCode": "PARENT-001",
  "customFields": {
    "customField1": "value1",
    "customField2": 123
  }
}
'
{
  "data": {
    "url": "<string>"
  },
  "requestId": "dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8",
  "timestamp": "2025-11-12T20:49:03.293Z"
}
Sends an email invitation to a downstream entity to join your network. The invited entity will receive instructions to complete their onboarding.

Headers

ā€‹
idempotency-key
string

UUID to ensure idempotent request processing

ā€‹
x-idempotency-key
string

Alternative UUID header for idempotent request processing

Body

application/json
ā€‹
useInviteUrl
boolean
required

If true, returns an invite URL instead of sending an email

Example:

false

ā€‹
isNpnRequired
boolean
required

Whether NPN is required for this downstream entity

Example:

true

ā€‹
downstreamEntityName
string
required

Name of the downstream entity

Example:

"ABC Insurance Agency"

ā€‹
firstName
string
required

First name of the primary contact

Example:

"John"

ā€‹
lastName
string
required

Last name of the primary contact

Example:

"Doe"

ā€‹
email
string
required

Email address of the primary contact

Example:

"john.doe@example.com"

ā€‹
category
enum<string>
required

Category of the downstream entity

Available options:
agency,
agency network,
wholesale brokerage,
third party administrator
Example:

"agency"

ā€‹
producerCode
string

Producer code for this downstream entity

Example:

"PROD-001"

ā€‹
externalId
string

External identifier for integration purposes

Example:

"EXT-12345"

ā€‹
producerAgreementId
string

Producer agreement ID to associate with this invitation

Example:

"507f1f77bcf86cd799439011"

ā€‹
onboardingSettings
object

Onboarding settings to customize the onboarding flow

ā€‹
parentProducerCode
string

Producer code of the parent entity (for branch relationships)

Example:

"PARENT-001"

ā€‹
customFields
object

Custom fields for additional data

Example:
{
  "customField1": "value1",
  "customField2": 123
}

Response

Downstream entity invitation sent

ā€‹
data
object
required
ā€‹
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"