ProducerSync API

AddressV1

idinteger(int64)

Unique identifier for the address.

Example:1234567

npnstring

National Producer Number associated with the address.

Example:18551108

transactionIdstring(uuid)

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

typestring

Type of address. One of BUSINESS, MAILING, RESIDENCE

Allowed values:BUSINESSMAILINGRESIDENCE

Example:BUSINESS

forStatestring

State where the address 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 address.

Example:2024-12-01

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

line1string

Street address.

Example:789 S Washington Ave

citystring

City of the address.

Example:Denver

statestring

State of the address.

Example:CO

zipstring

ZIP or postal code.

Example:80211

countrystring

Country of the address.

Example:U.S.A.

niprDeletedboolean

Indicates if the address was marked deleted by NIPR.

linksobject
Show Child Parameters
Example

AppointmentsBaseResponse

object

Base schema containing common appointment fields.

idinteger(int64)

Unique identifier for the appointment.

Example:1234567

npnstring

National Producer Number associated with the appointment.

Example:18551108

transactionIdstring(uuid)

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

forStatestring

Two-letter state code where the appointment applies.

>= 2 characters<= 2 characters

Example:AL

branchIdstring

Optional branch identifier.

companyNamestring

Name of the appointing insurance company.

Example:My Insurance Company

feinIdstring

Federal Employer Identification Number (FEIN) of the company.

coCodestring

5-digit company code.

>= 5 characters<= 5 characters

Example:98765

loastring

Line of Authority (LOA) name.

Example:Property

loaCodestring

Line of Authority code (may be numeric or alphanumeric).

Example:12

statusstring

Appointment status (e.g., Active, Terminated).

Example:Terminated

statusReasonDatestring(date)

Date when the current status took effect.

Example:2024-02-29

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

terminationReasonstring

Reason for termination, if applicable.

Example:Not for Cause

countyCodestring

Optional county code.

loaMappingobject
Show Child Parameters
niprDeletedboolean

Indicates if the appointment is marked as deleted by NIPR.

Example

AppointmentsV2Response

idinteger(int64)

Unique identifier for the appointment.

Example:1234567

npnstring

National Producer Number associated with the appointment.

Example:18551108

transactionIdstring(uuid)

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

forStatestring

Two-letter state code where the appointment applies.

>= 2 characters<= 2 characters

Example:AL

branchIdstring

Optional branch identifier.

companyNamestring

Name of the appointing insurance company.

Example:My Insurance Company

feinIdstring

Federal Employer Identification Number (FEIN) of the company.

coCodestring

5-digit company code.

>= 5 characters<= 5 characters

Example:98765

loastring

Line of Authority (LOA) name.

Example:Property

loaCodestring

Line of Authority code (may be numeric or alphanumeric).

Example:12

statusstring

Appointment status (e.g., Active, Terminated).

Example:Terminated

statusReasonDatestring(date)

Date when the current status took effect.

Example:2024-02-29

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

terminationReasonstring

Reason for termination, if applicable.

Example:Not for Cause

countyCodestring

Optional county code.

loaMappingobject
Show Child Parameters
niprDeletedboolean

Indicates if the appointment is marked as deleted by NIPR.

linksobject
Show Child Parameters
Example

AppointmentsV1

idinteger(int64)

Unique identifier for the appointment.

Example:1234567

npnstring

National Producer Number associated with the appointment.

Example:18551108

transactionIdstring(uuid)

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

forStatestring

Two-letter state code where the appointment applies.

>= 2 characters<= 2 characters

Example:AL

branchIdstring

Optional branch identifier.

companyNamestring

Name of the appointing insurance company.

Example:My Insurance Company

feinIdstring

Federal Employer Identification Number (FEIN) of the company.

coCodestring

5-digit company code.

>= 5 characters<= 5 characters

Example:98765

loastring

Line of Authority (LOA) name.

Example:Property

loaCodestring

Line of Authority code (may be numeric or alphanumeric).

Example:12

statusstring

Appointment status (e.g., Active, Terminated).

Example:Terminated

statusReasonDatestring(date)

Date when the current status took effect.

Example:2024-02-29

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

terminationReasonstring

Reason for termination, if applicable.

Example:Not for Cause

countyCodestring

Optional county code.

loaMappingobject
Show Child Parameters
niprDeletedboolean

Indicates if the appointment is marked as deleted by NIPR.

linksobject
Show Child Parameters
Example

ContactInfosBaseResponse

object

Common contact information 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 contact information.

Allowed values:BUSINESS_PHONEBUSINESS_EMAILFAX

Example:BUSINESS_EMAIL

forStatestring

State where the contact information 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 contact information.

Example:2024-12-01

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

valuestring

The contact information itself (phone number, email, etc.)

Example:apis.rock@agentsync.io

niprDeletedboolean

Indicates if the contact information was marked deleted by NIPR.

Example