Search
K
Contracting & Hierarchies API

ContractAssignmentUpdatedData

object

Payload for the contract.assignment.updated event.

contractAssignmentIdstring(uuid)required

The unique identifier of the contract assignment.

Example:550e8400-e29b-41d4-a716-446655440000

contractIdstring(uuid)required

The unique identifier of the contract the assignment belongs to.

Example:660e8400-e29b-41d4-a716-446655440001

agencyOrganizationIdstring(uuid)required

The unique identifier of the agency organization which the contract is sent from.

Example:770e8400-e29b-41d4-a716-446655440002

agencyOrganizationNamestringrequired

The name of the agency organization which the contract is sent from.

Example:Acme Insurance Agency

carrierOrganizationIdstring(uuid)required

The unique identifier of the carrier organization which the contract is sent to.

Example:880e8400-e29b-41d4-a716-446655440003

carrierOrganizationNamestringrequired

The name of the carrier organization which the contract is sent to.

Example:Big Carrier Inc.

personIdstring(uuid)required

The unique identifier of the individual producer which the contract is sent on behalf of.

Example:990e8400-e29b-41d4-a716-446655440004

personNpnstring | null

The National Producer Number of the individual producer.

Example:1234567

firmIdstring | null(uuid)

The unique identifier of the firm which the contract is sent on behalf of.

firmNpnstring | null

The National Producer Number of the firm.

productIdstring(uuid)required

The unique identifier of the carrier product assigned to this contract with the agency.

Example:aa0e8400-e29b-41d4-a716-446655440005

productNamestringrequired

The name of the carrier product assigned to this contract with the agency.

Example:Term Life

statesarray[string]required

The list of states the contract assignment will be covering.

Example:CA, TX

commissionLevelIdstring(uuid)required

The unique identifier of the product’s commission level assigned to this contract.

Example:bb0e8400-e29b-41d4-a716-446655440006

commissionLevelNamestringrequired

The name of the product’s commission level assigned to this contract.

Example:Standard

assignmentStatusstringrequired

The status of the contract assignment.

Example:Active

effectiveDatestring | null(date)

The effective date of the contract assignment. Format: yyyy-MM-dd

Example:2023-01-15

requestedEffectiveDatestring | null(date)

The requested effective date of the contract assignment. Format: yyyy-MM-dd

submittedDatestring | null(date)

The date which the contract assignment was submitted. Format: yyyy-MM-dd

referralCodesarray | null[string]

The list of referral codes used by the agency admin to assign the contract assignment if it is for portal/carrier website submission.

Example:[]

annualizationnumber | null

The annualization of the contract assignment.

uplineNpnstring | null

The National Producer Number of the upline producer for this contract assignment.

uplineIdstring | null(uuid)

The unique identifier of the upline producer for this contract assignment.

writingNumberstring | null

The writing number of the contract assignment.

Example:WN-12345

displayNumberstringrequired

The display number of the contract assignment.

Example:CA-00001

contractDisplayNumberstring | null

The display number of the contract the assignment belongs to.

Example:C-00042

contractAssignmentChangeIdsarray[string](uuid)

The unique identifiers of the contract assignment’s non-terminal (open) contract assignment changes.

Example:dd0e8400-e29b-41d4-a716-446655440007

uplineContractAssignmentOne Of

The upline contract assignment for this contract assignment, if any.

UplineContractAssignmentEventDataobject

Curated, single-level identity of a contract assignment’s upline. The upline is part of the recipient’s own hierarchy; firmName/personName may be null.

Show Child Parameters
responsiblePartyIdstring | null(uuid)

The unique identifier of the producer responsible for this contract assignment.

responsibleUplineFirmIdstring | null(uuid)

The unique identifier of the upline firm responsible for this contract assignment.

responsibleUplineFirmNpnstring | null

The National Producer Number of the upline firm responsible for this contract assignment.

responsiblePartyStartDatestring | null(date)

The start date of the producer responsible for this contract assignment. Format: yyyy-MM-dd

responsiblePartyEndDatestring | null(date)

The end date of the producer responsible for this contract assignment. Format: yyyy-MM-dd

createdAtstring | null(date-time)

The date and time the contract assignment was created. Format: RFC3339 UTC.

Example:2024-06-20T14:45:00Z

updatedAtstring | null(date-time)

The date and time the contract assignment was last updated. Format: RFC3339 UTC.

Example:2024-06-20T14:45:00Z

externalNotesstring | null

The external notes of the contract assignment.

debitBalancenumber | null

The debit balance of the contract assignment. Can be up to 12 digits and 2 decimal places.

expirationDatestring | null(date)

The expiration date of the contract assignment. Format: yyyy-MM-dd

userDefined1string | null

A user defined field of the contract.

userDefined2string | null

A user defined field of the contract.

userDefined3string | null

A user defined field of the contract.

userDefined4string | null

A user defined field of the contract.

userDefined5string | null

A user defined field of the contract.

userDefined6string | null

A user defined field of the contract.

userDefined7string | null

A user defined field of the contract.

userDefined8string | null

A user defined field of the contract.

userDefined9string | null

A user defined field of the contract.

userDefined10string | null

A user defined field of the contract.

Example

ContractAssignmentUpdatedWebhookEvent

idstringrequired

Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.

Example:whe_01j8e4k2abc123def456

typestringrequired

Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.

Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated

Example:contract.assignment.updated

dataobjectrequired

Payload for the contract.assignment.updated event.

Show Child Parameters
Example

ContractAssignmentDeletedData

object

Payload for the contract.assignment.deleted event.

contractAssignmentIdstring(uuid)required

The unique identifier of the contract assignment.

Example:550e8400-e29b-41d4-a716-446655440000

displayNumberstringrequired

The display number of the contract assignment.

Example:CA-00001

Example

ContractAssignmentDeletedWebhookEvent

idstringrequired

Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.

Example:whe_01j8e4k2abc123def456

typestringrequired

Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.

Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated

Example:contract.assignment.updated

dataobjectrequired

Payload for the contract.assignment.deleted event.

Show Child Parameters
Example

UplineContractAssignmentChangeEventData

object

Curated, single-level identity of a contract assignment change’s upline change. The upline is part of the recipient’s own hierarchy; firmName/personName may be null.

idstring(uuid)

The unique identifier of the upline contract assignment change.

Example:cc0e8400-e29b-41d4-a716-446655440008

displayNumberstring | null

The display number of the upline contract assignment change.

Example:CAC-00009

firmNamestring | null

The firm name of the upline contract assignment change.

Example:Upline Agency LLC

personNamestring | null

The person name of the upline contract assignment change.

Example:Jane Doe

Example