ProducerSync API

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

OtherNamesV1

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

RegulatoryActionsBaseResponse

object

Common regulatory actions fields shared across versions.

idinteger(int64)

Unique identifier for the regulatory actions.

Example:1234567

npnstring

National Producer Number associated with the regulatory actions.

Example:18551108

transactionIdstring(uuid)

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

forStatestring

State where the regulatory action applies.

>= 2 characters<= 2 characters

Example:AL

actionIdstring

Identification of the regulatory action.

Example:13537078

actionDatestring(date)

The date the regulatory action occurred.

Example:2017-07-10

effectiveDatestring(date)

The date the regulatory action is effective

Example:2017-07-10

enterDatestring(date)

The date the regulatory action was entered in the jurisdiction system.

Example:2018-02-08

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

penaltyFineForfeitureinteger

Amount in USD of fine, if applicable.

Example:150

lengthOfOrderinteger

The sanction period.

Example:30

Example

RegulatoryActionValuesBase

object

All regulatory actions should have three associated child objects - disposition, origin, and reason

idinteger

Unique identifier for the regulatory action value.

Example:123

regulatoryActionIdinteger

Unique identifier for the related regulatory action.

Example:1234567

transactionIdstring(uuid)

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

typestring

One of the following values is expected per object - REASON, ORIGIN, DISPOSITION

Allowed values:REASONORIGINDISPOSITION

Example:DISPOSITION

valuestring

Description of the related regulatory action

Example:Cease And Desist

createdAtstring(date)

Date of the creation of this record in AgentSync.

Example:2021-03-23

updatedAtstring(date)

Date of the most recent update to this record in AgentSync

Example:2024-04-16

Example

RegulatoryActionValuesV2

object
regulatoryActionValuesarray

All regulatory actions should have three associated child objects - disposition, origin, and reason

Show Child Parameters
Example