Search
K
ProducerSync API

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.

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

Query Parameters

npnsarray[string]

comma separated list of National Producer Numbers (NPNs)

Example:123456789, 987654321

statesarray[string]

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

Example:MO, CA, CO

activeboolean

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

loaCodesstring

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

Example:12,3

loaCategoriesarray[string]

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)

Example:casualty, property

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

Match pattern:yyyy-MM-dd

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

Response

application/hal+json

Success

embeddedobject
Show Child Parameters
get/v2/licenses
 
application/hal+json

Get license line of authorities (LOAs) for subscribed NPNs

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

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

Query Parameters

licenseIdsstring

comma separated list of license IDs

Example:10000,1000033,21733

sizeinteger(int64)

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

Default:250

>= 1<= 1000

Response

application/json

Success

embeddedobject

Container for a list of license records in version 2

Show Child Parameters
get/v2/licenseLoas
 
application/json

Get license line of authorities for an associated license

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

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

Path Parameters

licenseIdintegerrequired

License ID of the data to return

Example:1234567

Response

application/hal+json

Success

embeddedobject

Container for a list of license records in version 2

Show Child Parameters
get/v2/licenses/{licenseId}/licenseLoas
 
application/hal+json

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.

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

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

activeboolean

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

loaCodesstring

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

Example:12,3

loaCategoriesarray[string]

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)

Example:casualty, property

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

Match pattern:yyyy-MM-dd

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

Path Parameters

npnstringrequired

National Producer Number (npn) of the data to return

Example:123456789

Response

application/hal+json

Success

embeddedobject
Show Child Parameters
get/v2/entities/{npn}/licenses
 
application/hal+json