ProducerSync API

ProducerSync API

v2.86.10OAS 3.1

Producer compliance data for the NPNs you monitor — licenses and LOAs, appointments,
regulatory actions, addresses, contact information, and other names — plus the
endpoints to manage which producers your account subscribes to.

Every endpoint requires an OAuth2 client-credentials token and the scope shown on that
endpoint. See Authentication for
how to request credentials and retrieve a token,
API Base URLs for the sandbox and
production hosts, and Pagination for
how paging works across list endpoints.

Use the sidebar groups to navigate: subscription management is under
NPN Management, and each producer data domain has its own group.

Webhook events

AgentSync delivers outbound events to your configured endpoint when new compliance
data is available and when your monitored population changes. Each event is an HTTP
POST whose body carries a unique id, a dot-notation type, a timestamp, and a
type-specific data payload; respond 2xx to acknowledge. The event types are
declared under webhooks below.

Registration, signature verification, retry behaviour and the recommended daily-sync
pattern are documented at
ProducerSync API Webhooks.

API Base URL
  • Server 1:https://api.sandbox.agentsync.io

    Sandbox

NPN Management

manage the list of subscribed NPNs that your account has access to

Get active NPNs subscribed to the account

Returns a list of active NPNs associated with the account.

get
https://api.sandbox.agentsync.io/v1/accounts/subscriptions

Response

application/json

Success

array[string]
 
application/json

Replace the list of active NPNs subscribed to the account

Replaced the current list of active NPNs with the new list provided in the request. This request will delete and add NPNs.
This operation is asynchronous

post
https://api.sandbox.agentsync.io/v1/accounts/subscriptions

Body

application/json

The list of NPNs to activate

array[string]

Response

application/json

Accepted — operation is asynchronous. Use the returned job ID to poll for status.

Subscription200

successboolean

Example:true

messagestring

Example:Job is in progress

job_idstring

Example:0ded8367-01ac-4519-8cd7-ce965d55c0b0

linksobject
Show Child Parameters
 
application/json

Append to the list of active NPNs subscribed to the account

Append to the current list of active NPNs with the new list provided in the request.
This operation is asynchronous

put
https://api.sandbox.agentsync.io/v1/accounts/subscriptions

Body

application/json
array[string]

Response

application/json

Accepted — operation is asynchronous. Use the returned job ID to poll for status.

Subscription200

successboolean

Example:true

messagestring

Example:Job is in progress

job_idstring

Example:0ded8367-01ac-4519-8cd7-ce965d55c0b0

linksobject
Show Child Parameters
 
application/json