ProducerSync API

EntitiesLinks

object
selfobject
Show Child Parameters
addressesobject
Show Child Parameters
contactInfosobject
Show Child Parameters
appointmentsobject
Show Child Parameters
licensesobject
Show Child Parameters
residentLicenseobject
Show Child Parameters
Example

EntitiesV2Response

idinteger(int64)

Unique identifier for the entity.

Example:1234567

npnstring

National Producer Number associated with the entity.

Example:18551108

transactionIdstring(uuid)

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

typestring

Type of entity - individual or firm.

Allowed values:INDIVIDUALFIRM

Example:INDIVIDUAL

feinIdstring | null

Federal Employer Identification Number. Expected to be NULL for individuals.

Example:123456789

companyNamestring | null

Name of the firm. Expected to be NULL for individuals.

Example:Acme Insurance Group

firstNamestring

Example:Jeff

middleNamestring

Example:Lee

lastNamestring

Example:Android

dateOfBirthstring | null(date)

Date of birth for the producer. Expected to be NULL for a firm.

Example:1983-12-15

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

noLicensesboolean
subscriptionCountinteger

Example:4

niprDeletedboolean

Indicates if the entity was marked deleted by NIPR.

linksobject
Show Child Parameters
Example

EntitiesV1Metadata

object
no_licensesboolean
last_nipr_entity_updatestring(date-time)

Example:2024-11-20T12:42:43.519662+00:00

Example

EntitiesV1

idinteger(int64)

Unique identifier for the entity.

Example:1234567

npnstring

National Producer Number associated with the entity.

Example:18551108

transactionIdstring(uuid)

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

typestring

Type of entity - individual or firm.

Allowed values:INDIVIDUALFIRM

Example:INDIVIDUAL

feinIdstring | null

Federal Employer Identification Number. Expected to be NULL for individuals.

Example:123456789

companyNamestring | null

Name of the firm. Expected to be NULL for individuals.

Example:Acme Insurance Group

firstNamestring

Example:Jeff

middleNamestring

Example:Lee

lastNamestring

Example:Android

dateOfBirthstring | null(date)

Date of birth for the producer. Expected to be NULL for a firm.

Example:1983-12-15

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

noLicensesboolean
subscriptionCountinteger

Example:4

niprDeletedboolean

Indicates if the entity was marked deleted by NIPR.

metadataobject
Show Child Parameters
linksobject
Show Child Parameters
Example

LicensesBaseResponse

object

Base schema containing common license fields.

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

Example