idintegerrequired
Unique regulatory action value ID
Get regulatory action values by ID
Retrieves a single regulatory action value record using its unique regulatory action value ID.
get
https://api.sandbox.agentsync.io/v1/regulatoryActionValues/{id}
Path Parameters
Response
application/hal+json
Response
application/hal+json
Success
RegulatoryActionValuesV1
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
metadataobject
Show Child Parameters
deletedboolean
Example:true
application/hal+json
Webhook Events
Outbound events delivered to your configured endpoint when new compliance data is available or your monitored population changes.
producerSyncUpdatesAvailable
WEBHOOKFires once per day, after AgentSync has finished processing NIPR’s refresh
across your entire monitored population.
This is a batch-complete signal, not a per-producer one. There is no event for an
individual NPN, and the payload carries only a runDate — no NPN — because the
event means “every producer you monitor has been processed”, not “this producer
changed”. NIPR publishes once daily, so this is the cadence at which compliance
data can change at all.
Use data.runDate as the value for the updatedSince parameter to fetch just the
records that changed.
post
https://api.sandbox.agentsync.io
Body
application/json
Body
application/json
UpdatesAvailableWebhookEvent
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
dataobjectrequired
Show Child Parameters
Response
2XX
Response
2XX
Customer endpoint acknowledged the event.
2XX
producerSyncNpnActivated
WEBHOOKDelivered when a producer is added to your monitored population.
Fires immediately — it is triggered by a change to your account’s subscription
list, not by NIPR’s daily cycle. Use it to start onboarding workflows or run an
initial compliance check.
post
https://api.sandbox.agentsync.io
Body
application/json
Body
application/json
NpnActivatedWebhookEvent
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
dataobjectrequired
Show Child Parameters
Response
2XX
Response
2XX
Customer endpoint acknowledged the event.
2XX
producerSyncNpnDeactivated
WEBHOOKDelivered when a producer is removed from your monitored population.
Fires immediately — it is triggered by a change to your account’s subscription
list, not by NIPR’s daily cycle. Use it to remove the producer from active
monitoring or trigger offboarding actions.
post
https://api.sandbox.agentsync.io
Body
application/json
Body
application/json
NpnDeactivatedWebhookEvent
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
dataobjectrequired
Show Child Parameters
Response
2XX
Response
2XX
Customer endpoint acknowledged the event.
2XX