Contracting & Hierarchies API

ContractV2Page

object

A token-paginated page of contracts (plain envelope, no HAL wrappers).

itemsarray[object]required

A contract sent from an agency to a carrier on behalf of a producer.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
Example

UplineContractAssignmentV2

object

Identity of the assignment’s upline, surfaced as part of the caller’s own hierarchy.

idstring(uuid)required

The upline contract assignment id.

displayNumberstring

The upline assignment’s human-readable number.

firmNamestring

The upline’s firm name, if the upline is a firm.

personNamestring

The upline’s person name, if the upline is an individual producer.

Example

AvailableUplineV2

object

A currently-approved contract assignment eligible to be selected as an upline.

contractAssignmentIdstring(uuid)required
firstNamestring
lastNamestring
suffixstring
firmIdstring(uuid)
firmNamestring

The candidate’s firm name, if the candidate is a firm.

personIdstring(uuid)
npnstring
writingNumberstring
levelOfCommissionnumber
annualizationProportionnumber
productIdstring(uuid)
testAccountboolean
commissionLevelNamestring
Example

AvailableUplineV2Page

object

A token-paginated page of available upline candidates (plain envelope, no HAL wrappers).

itemsarray[object]required

A currently-approved contract assignment eligible to be selected as an upline.

Show Child Parameters
pageobjectrequired

Pagination metadata for a V2 list response.

Show Child Parameters
Example

AvailableUplineChangeV2

object

A contract-assignment change eligible to be selected as an upline, scoped to a
contract-assignment or contract-assignment-change.

contractAssignmentChangeIdstring(uuid)required
contractAssignmentIdstring(uuid)
firstNamestring
lastNamestring
suffixstring
firmIdstring(uuid)
firmNamestring

The candidate’s firm name, if the candidate is a firm.

personIdstring(uuid)
fromOrganizationIdstring(uuid)
npnstring
writingNumberstring
levelOfCommissionnumber
annualizationProportionnumber
productIdstring(uuid)
testAccountboolean
startDatestring(date)
endDatestring(date)
commissionLevelNamestring
contractAssignmentChangeDisplayNumberstring
Example