idintegerrequired
Unique line of authority ID
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
Response
application/hal+json
Response
application/hal+json
Success
LicenseLoaV1
LicenseLoaV1object
application/hal+json
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.
get
https://api.sandbox.agentsync.io/v2/otherNames
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
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
Response
application/hal+json
Success
embeddedobject
Show Child Parameters
application/hal+json
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.
get
https://api.sandbox.agentsync.io/v2/entities/{npn}/otherNames
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
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 other names by ID
Retrieves a single other names record using its unique other names ID.
get
https://api.sandbox.agentsync.io/v1/otherNames/{id}
Path Parameters
idintegerrequired
Unique other names ID
Response
application/hal+json
Response
application/hal+json
Success
OtherNamesV1
OtherNamesV1object
application/hal+json