ProducerSync API

LicensesV2Response

idinteger(int64)

Unique identifier for the license.

Example:1234567

npnstring

National Producer Number associated with the license.

Example:18551108

transactionIdstring(uuid)

Example:337f638b-b0dd-4d9f-80f5-29a9158d0286

forStatestring

State where the license applies.

>= 2 characters<= 2 characters

Example:AL

branchIdstring

Identifier for a related branch, if applicable.

niprDateUpdatedstring(date)

Last date NIPR reported an update to this license.

Example:2020-12-16

createdAtstring(date)

Date of the creation of this record in AgentSync.

Example:2021-04-04

updatedAtstring(date)

Date of the most recent update to this record in AgentSync.

Example:2024-12-02

licenseNumstring

License number associated with NPN.

Example:897579550

originalIssueDatestring(date)

The date the license was originally issued

Example:2016-04-22

expirationDatestring(date)

The date the license is set to expire.

Example:2022-04-22

licenseClassstring

The classification or type of license issued

Example:Insurance Producer

licenseClassCodestring

The code representing the license class

Example:3

residencyStatusstring

Indicates whether the license holder is a resident (“R”) or non-resident (“NR”)

Example:R

activeboolean

Indicates whether the license is currently active

licenseLoasarray[object]

Container for a list of license records in version 2

Show Child Parameters
agentTypesarray[string]

Example:Producer

niprDeletedboolean

Indicates if the license was marked deleted by NIPR.

linksobject
Show Child Parameters
renewalPeriodsobject

Contains calculated renewal windows and classification

Show Child Parameters
Example

LicenseLoaV1

idinteger

unique identifier for the license line of authority (loa) record

Example:1234567

licenseIdinteger

unique identifier for the associated license

Example:967373

transactionIdstring(uuid)

Example:ae51f10b-8b5e-40ba-98a9-8f860392b344

loastring

The line of authority associated with the license (e.g., Property, Casualty)

Example:Property

loaCodestring

A code representing the line of authority

Example:12

issueDatestring(date)

The date the line of authority was issued

Example:2004-01-21

createdAtstring(date)

Date of the creation of this record in AgentSync

Example:2021-04-04

updatedAtstring(date)

Date of the most recent update to this record in AgentSync

Example:2024-12-02

statusstring

Current status of the line of authority. One of Active, Cancelled, or Inactive

Allowed values:ActiveCancelledInactive

Example:Active

statusReasonDatestring(date)

The date the current status reason became effective

Example:2020-12-26

ceCompliancestring

Continuing education (CE) compliance status. One of EXEMPT, IN COMPLIANCE, N/A, NOT IN COMPLIANCE or NULL

Example:IN COMPLIANCE

ceCreditsNeededinteger

Number of continuing education credits required for compliance

loaMappingobject
Show Child Parameters
niprDeletedboolean

Indicates if the license was marked deleted by NIPR

linksobject
Show Child Parameters
Example

LicensesV1

idinteger(int64)

Unique identifier for the license.

Example:1234567

npnstring

National Producer Number associated with the license.

Example:18551108

transactionIdstring(uuid)

Example:337f638b-b0dd-4d9f-80f5-29a9158d0286

forStatestring

State where the license applies.

>= 2 characters<= 2 characters

Example:AL

branchIdstring

Identifier for a related branch, if applicable.

niprDateUpdatedstring(date)

Last date NIPR reported an update to this license.

Example:2020-12-16

createdAtstring(date)

Date of the creation of this record in AgentSync.

Example:2021-04-04

updatedAtstring(date)

Date of the most recent update to this record in AgentSync.

Example:2024-12-02

licenseNumstring

License number associated with NPN.

Example:897579550

originalIssueDatestring(date)

The date the license was originally issued

Example:2016-04-22

expirationDatestring(date)

The date the license is set to expire.

Example:2022-04-22

licenseClassstring

The classification or type of license issued

Example:Insurance Producer

licenseClassCodestring

The code representing the license class

Example:3

residencyStatusstring

Indicates whether the license holder is a resident (“R”) or non-resident (“NR”)

Example:R

activeboolean

Indicates whether the license is currently active

licenseLoasarray[object]
Show Child Parameters
agentTypesarray[string]

Example:Producer

niprDeletedboolean

Indicates if the license was marked deleted by NIPR.

linksobject
Show Child Parameters
renewalPeriodsobject

Contains calculated renewal windows and classification

Show Child Parameters
Example

OtherNamesBaseResponse

object

Common other names fields shared across versions.

idinteger(int64)

Unique identifier for the contact information.

Example:1234567

npnstring

National Producer Number associated with the contact information.

Example:18551108

transactionIdstring(uuid)

Example:ae51f10b-8b5e-40ba-98a9-8f860392b344

typestring

Type of other name. One of ALIAS, FIRM_BRANCH, PREVIOUS

Allowed values:ALIASFIRM_BRANCHPREVIOUS

Example:ALIAS

forStatestring

State where the other name applies.

>= 2 characters<= 2 characters

Example:AL

branchIdstring

Identifier for a related branch, if applicable.

stateCoIdstring

State company ID

Example:294553

namestring

The other name.

Example:My Underwriters Inc

createdAtstring(date)

Date of the creation of this record in AgentSync.

Example:2021-04-04

updatedAtstring(date)

Date of the most recent update to this record in AgentSync.

Example:2024-12-02

niprDeletedboolean

Indicates if the contact information was marked deleted by NIPR.

Example

OtherNamesV2

idinteger(int64)

Unique identifier for the contact information.

Example:1234567

npnstring

National Producer Number associated with the contact information.

Example:18551108

transactionIdstring(uuid)

Example:ae51f10b-8b5e-40ba-98a9-8f860392b344

typestring

Type of other name. One of ALIAS, FIRM_BRANCH, PREVIOUS

Allowed values:ALIASFIRM_BRANCHPREVIOUS

Example:ALIAS

forStatestring

State where the other name applies.

>= 2 characters<= 2 characters

Example:AL

branchIdstring

Identifier for a related branch, if applicable.

stateCoIdstring

State company ID

Example:294553

namestring

The other name.

Example:My Underwriters Inc

createdAtstring(date)

Date of the creation of this record in AgentSync.

Example:2021-04-04

updatedAtstring(date)

Date of the most recent update to this record in AgentSync.

Example:2024-12-02

niprDeletedboolean

Indicates if the contact information was marked deleted by NIPR.

linksobject
Show Child Parameters
Example