Search
K
  • NPN Management
    • getGet active NPNs subscribed to the account
    • postReplace the list of active NPNs subscribed to the account
    • putAppend to the list of active NPNs subscribed to the account
    • delRemove active NPNs subscribed to the account
    • getGet the status for an NPN management job
    • getGet the status details for an NPN management job
  • Producer Addresses
    • getGet addresses for subscribed NPNs
    • getGet addresses for a specific NPN
    • getGet address by ID
  • Producer Appointments
    • getGet appointments for subscribed NPNs
    • getGet appointments for a specific NPN
    • getGet appointment by ID
  • Producer Contact Information
    • getGet contact information for subscribed NPNs
    • getGet contact information for a specific NPN
    • getGet contact information by ID
  • Producer Entities
    • getGet entities for subscribed NPNs
    • getGet the entity for a specific NPN
  • Producer Licenses and LOAs
    • getGet licenses for subscribed NPNs
    • getGet license line of authorities (LOAs) for subscribed NPNs
    • getGet license line of authorities for an associated license
    • getGet license for a specific NPN
    • getGet licenses by ID
    • getGet license line of authority by ID
  • Producer Other Names
    • getGet other names for subscribed NPNs
    • getGet other names for a specific NPN
    • getGet other names by ID
  • Producer Regulatory Actions
    • getGet regulatory actions for subscribed NPNs
    • getGet regulatory action values for a specific regulatory action
    • getGet regulatory actions for a specific NPN
    • getGet regulatory actions by ID
    • getGet regulatory action values by ID

API docs by Redocly

ProducerSync API (latest)

Download OpenAPI specification:

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.

Responses

200

Success

401

Unauthorized

404

Not Found

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/accounts/subscriptions

Sandbox

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

Response samples

  • 200
  • 401
  • 404
  • 429
  • 500

Content type

application/json

Copy

[ "1618516", "16211", "227714", "228855", "229777", "117232"]

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

Request Body schema: application/json required

The list of NPNs to activate

Array

string

Responses

200

Success

401

Unauthorized

404

Not Found

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

post/v1/accounts/subscriptions

Sandbox

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

Request samples

  • Payload

Content type

application/json

Copy

[ "912484758", "123456689", "999999999"]

Response samples

  • 200
  • 401
  • 404
  • 429
  • 500

Content type

application/json

Copy

Expand all Collapse all

{ "success": true, "message": "Job is in progress", "job_id": "0ded8367-01ac-4519-8cd7-ce965d55c0b0", "links": { "status": { "href": "https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0"}}}

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

Request Body schema: application/json required

Array

string

Responses

200

Success

401

Unauthorized

404

Not Found

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

put/v1/accounts/subscriptions

Sandbox

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

Request samples

  • Payload

Content type

application/json

Copy

[ "912484758", "123456689", "999999999"]

Response samples

  • 200
  • 401
  • 404
  • 429
  • 500

Content type

application/json

Copy

Expand all Collapse all

{ "success": true, "message": "Job is in progress", "job_id": "0ded8367-01ac-4519-8cd7-ce965d55c0b0", "links": { "status": { "href": "https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0"}}}

Remove active NPNs subscribed to the account

Request a list of currently active NPNs to un-associated with the account (or delete).

Request Body schema: application/json required

Array

string

Responses

202

Accepted

401

Unauthorized

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

delete/v1/accounts/subscriptions

Sandbox

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

Request samples

  • Payload

Content type

application/json

Copy

[ "912484758", "123456689", "999999999"]

Response samples

  • 401
  • 415
  • 429
  • 500

Content type

application/json

Copy

{ "message": "Unauthorized"}

Get the status for an NPN management job

Returns the status and additional metadata about a specific NPN management job

path Parameters

jobId

required

string <uuid>

ID of the job corresponding to the details you are looking for

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/accounts/subscriptions/status/{jobId}

Sandbox

https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/{jobId}

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "id": "0ded8367-01ac-4519-8cd7-ce965d55c0b0", "createdAt": "2025-04-14", "updatedAt": "2025-04-14", "details": { "success": true, "state": "SUCCEEDED", "totalNpns": 3, "queuedNpns": 0, "inProgressNpns": 0, "successfulNpns": 3, "failedNpns": 0}, "links": { "self": { "href": "https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0"}, "details": { "href": "https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0/details"}}}

Get the status details for an NPN management job

Returns the status details about a specific NPN management job

path Parameters

jobId

required

string <uuid>

ID of the job corresponding to the details you are looking for

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/accounts/subscriptions/status/{jobId}/details

Sandbox

https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/{jobId}/details

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "subscriptionJobItem": [ { "status": "FAILED", "npn": 229777, "message": "No producer data found for entity id '{npn}'."}]}, "links": { "self": { "href": "https://api.sandbox.agentsync.io/v1/accounts/subscriptions/status/0ded8367-01ac-4519-8cd7-ce965d55c0b0/details?page=0&size=250"}}}

Producer Addresses

Address information for producers

Get addresses for subscribed NPNs

Returns all address records for NPNs you are currently subscribed to.

If no query parameters are provided in the request, then the response will include all addresses for all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one parameter to narrow your results.

query Parameters

npns

Array of strings

Example: npns=123456789,987654321

comma separated list of National Producer Numbers (NPNs)

states

Array of strings

Example: states=MO,CA,CO

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

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/addresses

Sandbox

https://api.sandbox.agentsync.io/v2/addresses

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "addresses": [ { }]}}

Get addresses for a specific NPN

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

path Parameters

npn

required

string

Example: 123456789

National Producer Number (npn) of the data to return

query Parameters

states

Array of strings

Example: states=MO,CA,CO

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

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/entities/{npn}/addresses

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "addresses": [ { }]}}

Get address by ID

Retrieves a single address record using its unique address ID.

path Parameters

id

required

integer

Unique address ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/addresses/{id}

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

{ }

Producer Appointments

Appointment information for producers

Get appointments for subscribed NPNs

Returns all appointment records for NPNs you are currently subscribed to.

If no query parameters are provided in the request, then the response will include all appointments for all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one parameter to narrow your results.

query Parameters

npns

Array of strings

Example: npns=123456789,987654321

comma separated list of National Producer Numbers (NPNs)

states

Array of strings

Example: states=MO,CA,CO

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

coCodes

string

Example: coCodes=24740,70408,21458

comma separated list of company/co codes (must by 5 digits) - this will filter on the coCode field

status

string

Default: null

Enum: "TERMINATED" "APPOINTED"

Example: status=TERMINATED

A single appointment status to search for. This is an exact string match of either TERMINATED or APPOINTED - this will filter on the status field

loaCategories

Array of strings

Example: loaCategories=casualty,property

comma seperated list of loa categories - this will filter on the loaMapping.categories array (it will return all records containing at least one of the values passed)

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/appointments

Sandbox

https://api.sandbox.agentsync.io/v2/appointments

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "appointments": [ { }]}}

Get appointments for a specific NPN

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

path Parameters

npn

required

string

Example: 123456789

National Producer Number (npn) of the data to return

query Parameters

states

Array of strings

Example: states=MO,CA,CO

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

coCodes

string

Example: coCodes=24740,70408,21458

comma separated list of company/co codes (must by 5 digits) - this will filter on the coCode field

status

string

Default: null

Enum: "TERMINATED" "APPOINTED"

Example: status=TERMINATED

A single appointment status to search for. This is an exact string match of either TERMINATED or APPOINTED - this will filter on the status field

loaCategories

Array of strings

Example: loaCategories=casualty,property

comma seperated list of loa categories - this will filter on the loaMapping.categories array (it will return all records containing at least one of the values passed)

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/entities/{npn}/appointments

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "appointments": [ { }]}}

Get appointment by ID

Retrieves a single appointment record using its unique address ID.

path Parameters

id

required

integer

Unique appointment ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/appointments/{id}

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

{ }

Producer Contact Information

Contact information for producers

Get contact information for subscribed NPNs

Returns all contact information records for NPNs you are currently subscribed to.

If no query parameters are provided in the request, then the response will include all contact information for all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one parameter to narrow your results.

query Parameters

npns

Array of strings

Example: npns=123456789,987654321

comma separated list of National Producer Numbers (NPNs)

states

Array of strings

Example: states=MO,CA,CO

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

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/contactInfos

Sandbox

https://api.sandbox.agentsync.io/v2/contactInfos

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "contactInfos": [ { }]}}

Get contact information for a specific NPN

Returns all contact information associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.

path Parameters

npn

required

string

Example: 123456789

National Producer Number (npn) of the data to return

query Parameters

states

Array of strings

Example: states=MO,CA,CO

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

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/entities/{npn}/contactInfos

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "contactInfos": [ { }]}}

Get contact information by ID

Retrieves a single contact information record using its unique contact information ID.

path Parameters

id

required

integer

Unique contact information ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/contactInfos/{id}

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

{ }

Producer Entities

Entity information for producers

Get entities for subscribed NPNs

Returns all entity records for NPNs you are currently subscribed to.

If no query parameters are provided in the request, then the response will include all entities for all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one parameter to narrow your results.

query Parameters

npns

Array of strings

Example: npns=123456789,987654321

comma separated list of National Producer Numbers (NPNs)

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/entities

Sandbox

https://api.sandbox.agentsync.io/v2/entities

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "entities": [ { }]}}

Get the entity for a specific NPN

Returns the entity associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.

path Parameters

npn

required

string

Example: 123456789

National Producer Number (npn) of the data to return

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/entities/{npn}

Sandbox

https://api.sandbox.agentsync.io/v1/entities/{npn}

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "entities": [ { }]}}

Producer Licenses and LOAs

License and LOA information for producers

Get licenses for subscribed NPNs

Returns all license records for NPNs you are currently subscribed to.

If no query parameters are provided in the request, then the response will include all licenses for all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one parameter to narrow your results.

query Parameters

npns

Array of strings

Example: npns=123456789,987654321

comma separated list of National Producer Numbers (NPNs)

states

Array of strings

Example: states=MO,CA,CO

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

active

boolean

Example: active=false

true or false indicating a search for active licenses (in its absence, both active and inactive licenses will be returned)

loaCodes

string

Example: loaCodes=12,3

comma separated list of LOA codes to filter licenses. This will return all licenses that match at least one of the specified LOA codes.

loaCategories

Array of strings

Example: loaCategories=casualty,property

comma seperated list of loa categories - this will filter on the loaMapping.categories array (it will return all records containing at least one of the values passed)

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/licenses

Sandbox

https://api.sandbox.agentsync.io/v2/licenses

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "licenses": [ { "licenseLoas": [ { "licenseLoas": [ { }]}], "agentTypes": [ "Producer"], "niprDeleted": false}]}}

Get license line of authorities (LOAs) for subscribed NPNs

Returns all license LOA records for NPNs you are currently subscribed to

query Parameters

licenseIds

string

Example: licenseIds=10000,1000033,21733

comma separated list of license IDs

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/licenseLoas

Sandbox

https://api.sandbox.agentsync.io/v2/licenseLoas

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/json

Copy

Expand all Collapse all

{ "embedded": { "licenseLoas": [ { }]}}

Get license line of authorities for an associated license

Returns all license line of authorities associated with a unique license ID

path Parameters

licenseId

required

integer

Example: 1234567

License ID of the data to return

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/licenses/{licenseId}/licenseLoas

Sandbox

https://api.sandbox.agentsync.io/v2/licenses/{licenseId}/licenseLoas

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "licenseLoas": [ { }]}}

Get license for a specific NPN

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

path Parameters

npn

required

string

Example: 123456789

National Producer Number (npn) of the data to return

query Parameters

states

Array of strings

Example: states=MO,CA,CO

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

active

boolean

Example: active=false

true or false indicating a search for active licenses (in its absence, both active and inactive licenses will be returned)

loaCodes

string

Example: loaCodes=12,3

comma separated list of LOA codes to filter licenses. This will return all licenses that match at least one of the specified LOA codes.

loaCategories

Array of strings

Example: loaCategories=casualty,property

comma seperated list of loa categories - this will filter on the loaMapping.categories array (it will return all records containing at least one of the values passed)

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/entities/{npn}/licenses

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "licenses": [ { "licenseLoas": [ { "licenseLoas": [ { }]}], "agentTypes": [ "Producer"], "niprDeleted": false}]}}

Get licenses by ID

Retrieves a single license record using its unique license ID.

path Parameters

id

required

integer

Unique license ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/licenses/{id}

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "licenseLoas": [ { }], "agentTypes": [ "Producer"], "niprDeleted": false}

Get license line of authority by ID

Retrieves a single line of authority record using its unique loa ID.

path Parameters

id

required

integer

Unique line of authority ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/licenseLoas/{id}

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

{ }

Producer Other Names

Other names information for producers

Get other names for subscribed NPNs

Returns all other names records for NPNs you are currently subscribed to.

query Parameters

npns

Array of strings

Example: npns=123456789,987654321

comma separated list of National Producer Numbers (NPNs)

states

Array of strings

Example: states=MO,CA,CO

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

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/otherNames

Sandbox

https://api.sandbox.agentsync.io/v2/otherNames

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "otherNames": [ { }]}}

Get other names for a specific NPN

Returns all other names associated with a specific NPN. If you're not already subscribed, this request will automatically subscribe you to the NPN.

path Parameters

npn

required

string

Example: 123456789

National Producer Number (npn) of the data to return

query Parameters

states

Array of strings

Example: states=MO,CA,CO

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

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/entities/{npn}/otherNames

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "otherNames": [ { }]}}

Get other names by ID

Retrieves a single other names record using its unique other names ID.

path Parameters

id

required

integer

Unique other names ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/otherNames/{id}

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

{ }

Producer Regulatory Actions

Regulatory actions information for producers

Get regulatory actions for subscribed NPNs

Returns all regulatory actions records for NPNs you are currently subscribed to.

If no query parameters are provided in the request, then the response will include all regulatory actions for all currently subscribed NPNs. To maximize effectiveness, we strongly recommend using at least one parameter to narrow your results.

query Parameters

npns

Array of strings

Example: npns=123456789,987654321

comma separated list of National Producer Numbers (NPNs)

states

Array of strings

Example: states=MO,CA,CO

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

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/regulatoryActions

Sandbox

https://api.sandbox.agentsync.io/v2/regulatoryActions

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "regulatoryActions": [ { "regulatoryActionValues": { "regulatoryActionValues": [ { "metadata": { "last_nipr_alert_update": "2024-01-20T10:54:35.30506+00:00", "last_nipr_entity_update": "2024-04-16T22:58:09.398811+00:00"}, "deleted": true}]}, "niprDeleted": false}]}}

Get regulatory action values for a specific regulatory action

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

path Parameters

id

required

integer

Unique regulatory actions ID

query Parameters

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/regulatoryActions/{id}/regulatoryActionValues

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "regulatoryActionValues": [ { "regulatoryActionValues": [ { "metadata": { "last_nipr_alert_update": "2024-01-20T10:54:35.30506+00:00", "last_nipr_entity_update": "2024-04-16T22:58:09.398811+00:00"}, "deleted": true}]}]}}

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.

path Parameters

npn

required

string

Example: 123456789

National Producer Number (npn) of the data to return

query Parameters

states

Array of strings

Example: states=MO,CA,CO

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

updatedSince

string <date> yyyy-MM-dd

Example: updatedSince=2024-10-15

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

includeDeleted

boolean

Default: true

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

size

integer <int64> [ 1 .. 1000 ]

Default: 250

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v2/entities/{npn}/regulatoryActions

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "embedded": { "regulatoryActions": [ { "regulatoryActionValues": { "regulatoryActionValues": [ { "metadata": { "last_nipr_alert_update": "2024-01-20T10:54:35.30506+00:00", "last_nipr_entity_update": "2024-04-16T22:58:09.398811+00:00"}, "deleted": true}]}, "niprDeleted": false}]}}

Get regulatory actions by ID

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

path Parameters

id

required

integer

Unique regulatory actions ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/regulatoryActions/{id}

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "regulatoryActionValues": { "metadata": { "last_nipr_alert_updated": "string", "last_nipr_entity_update": "string"}, "deleted": true}, "niprDeleted": false}

Get regulatory action values by ID

Retrieves a single regulatory action value record using its unique regulatory action value ID.

path Parameters

id

required

integer

Unique regulatory action value ID

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

429

Too Many Requests

500

Internal Server Error

504

Gateway Timeout

get/v1/regulatoryActionValues/{id}

Sandbox

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

Response samples

  • 200
  • 400
  • 401
  • 403
  • 404
  • 405
  • 429
  • 500

Content type

application/hal+json

Copy

Expand all Collapse all

{ "metadata": { "last_nipr_alert_updated": "string", "last_nipr_entity_update": "string"}, "deleted": true}