licenseIdintegerrequired
License ID of the data to return
Example:1234567
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
Response
application/hal+json
Response
application/hal+json
Success
embeddedobject
Container for a list of license records in version 2
Show Child Parameters
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
Response
application/hal+json
Success
embeddedobject
Show Child Parameters
application/hal+json
Get licenses by ID
Retrieves a single license record using its unique license ID.
get
https://api.sandbox.agentsync.io/v1/licenses/{id}
Path Parameters
idintegerrequired
Unique license ID
Response
application/hal+json
Response
application/hal+json
Success
LicensesV1
licenseLoasarray[object]
agentTypesarray[string]
Example:Producer
niprDeletedboolean
Indicates if the license was marked deleted by NIPR.
application/hal+json
Get license line of authority by ID
Retrieves a single line of authority record using its unique loa ID.
get
https://api.sandbox.agentsync.io/v1/licenseLoas/{id}
Path Parameters
idintegerrequired
Unique line of authority ID
Response
application/hal+json
Response
application/hal+json
Success
LicenseLoaV1
LicenseLoaV1object
application/hal+json
Producer Other Names
Other names information for producers