cURL
curl --request GET \
--url https://public.api.live.turrisfi.com/v2/upstream/agents/{agentId}/license-compliance-statuses \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://public.api.live.turrisfi.com/v2/upstream/agents/{agentId}/license-compliance-statuses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public.api.live.turrisfi.com/v2/upstream/agents/{agentId}/license-compliance-statuses"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"productName": "<string>",
"states": [
{
"stateCode": "AL",
"licenseStatus": {
"statusName": "<string>",
"statusMessages": [
"<string>"
]
},
"appointmentStatus": {
"statusName": "<string>",
"statusMessages": [
"<string>"
]
}
}
]
},
"requestId": "dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8",
"timestamp": "2025-11-12T20:49:03.293Z"
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}Compliance Status
Get Agent Compliance Status
Retrieve license compliance status for an agent
GET
/
v2
/
upstream
/
agents
/
{agentId}
/
license-compliance-statuses
cURL
curl --request GET \
--url https://public.api.live.turrisfi.com/v2/upstream/agents/{agentId}/license-compliance-statuses \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://public.api.live.turrisfi.com/v2/upstream/agents/{agentId}/license-compliance-statuses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public.api.live.turrisfi.com/v2/upstream/agents/{agentId}/license-compliance-statuses"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"productName": "<string>",
"states": [
{
"stateCode": "AL",
"licenseStatus": {
"statusName": "<string>",
"statusMessages": [
"<string>"
]
},
"appointmentStatus": {
"statusName": "<string>",
"statusMessages": [
"<string>"
]
}
}
]
},
"requestId": "dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8",
"timestamp": "2025-11-12T20:49:03.293Z"
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}Returns the license compliance status for a specific agent, evaluated against your upstream entityβs product requirements and filtered by state and product.
Authorizations
bearerrestricted-access-token
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Agent ID
Example:
"507f1f77bcf86cd799439011"
Query Parameters
State code (two-letter abbreviation)
Example:
"CA"
Product ID
Example:
"6098a7f8c9e77c001f3c5a1b"
Was this page helpful?