ProducerSync API

RegulatoryActionValuesV1

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

metadataobject
Show Child Parameters
deletedboolean

Example:true

Example

RegulatoryActionsV1

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

fileRefstring

File reference identifier for the regulatory action, as reported by the jurisdiction. Format varies by
state.

Example:123

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

regulatoryActionValuesobject

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

Show Child Parameters
niprDeletedboolean

Indicates if the regulatory actions was marked deleted by NIPR.

linksobject
Show Child Parameters
Example

WebhookEventEnvelope

object

Fields common to every ProducerSync webhook event.

idstringrequired

Unique identifier for this event, a TypeID with the whe_ prefix. Repeated on retries — use it to deduplicate.

Example:whe_01m0a149wzf6sb9ap9y8tafwe1

typestringrequired

The specific event type.

timestampstring(date-time)required

UTC time the event was generated. Fractional-second precision is not fixed - parse with a tolerant RFC 3339 parser rather than a fixed-millisecond format.

Example:2026-08-18T08:52:09.2471298Z

Example

UpdatesAvailableEventData

object
runDatestring(date)required

The NIPR run date the completed batch covers. Pass this as updatedSince to fetch only the records that changed.

Example:2025-07-24

Example

UpdatesAvailableWebhookEvent

idstringrequired

Unique identifier for this event, a TypeID with the whe_ prefix. Repeated on retries — use it to deduplicate.

Example:whe_01m0a149wzf6sb9ap9y8tafwe1

typestringrequired

The specific event type.

timestampstring(date-time)required

UTC time the event was generated. Fractional-second precision is not fixed - parse with a tolerant RFC 3339 parser rather than a fixed-millisecond format.

Example:2026-08-18T08:52:09.2471298Z

dataobjectrequired
Show Child Parameters
Example