Search
K
ProducerSync API

Get regulatory action values for a specific regulatory action

Returns all regulatory actions value records for ID of a given regulatory action.

get
https://api.sandbox.agentsync.io/v2/regulatoryActions/{id}/regulatoryActionValues

Query Parameters

sizeinteger(int64)

the number of objects on the page (min = 1 / max = 1,000)

Default:250

>= 1<= 1000

Path Parameters

idintegerrequired

Unique regulatory actions ID

Response

application/hal+json

Success

embeddedobject
Show Child Parameters
 
application/hal+json

Get regulatory actions for a specific NPN

Returns all regulatory actions associated with a specific NPN. If you’re not already subscribed, this request will automatically subscribe you to the NPN.

get
https://api.sandbox.agentsync.io/v2/entities/{npn}/regulatoryActions

Query Parameters

statesarray[string]

comma separated list of states abbreviations (must be 2 characters) - this will filter on the forState field

Example:MO, CA, CO

updatedSincestring(date)

limits results to those that have an updated date equivalent to or after to the date provided (YYYY-MM-DD) - this will filter on the updatedAt field

Example:2024-10-15

includeDeletedboolean

specifiy whether or not deleted records should be included in the response - this will filter on the niprDeleted field

Default:true

sizeinteger(int64)

the number of objects on the page (min = 1 / max = 1,000)

Default:250

>= 1<= 1000

continuationTokenstring

Token for fetching the next page of results

Path Parameters

npnstringrequired

National Producer Number (npn) of the data to return

Example:123456789

Response

application/hal+json

Success

embeddedobject
Show Child Parameters
linksobject
Show Child Parameters
 
application/hal+json

Get regulatory actions by ID

Retrieves a single regulatory actions record using its unique regulatory actions ID.

get
https://api.sandbox.agentsync.io/v1/regulatoryActions/{id}

Path Parameters

idintegerrequired

Unique regulatory actions ID

Response

application/hal+json

Success

RegulatoryActionsV1

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

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
 
application/hal+json

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

idintegerrequired

Unique regulatory action value ID

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

LoaMapping

object
categoriesarray[string]

Example:property, health, casualty

Example