ProducerSync API

EntitiesBaseResponse

object

Common entity fields shared across versions.

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.

Example

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