Insurance
curl --request GET \
--url https://api.sortx.co.uk/contractor-insurance \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/contractor-insurance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-insurance"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"kpis": {
"onFile": 123,
"contractors": 123,
"verified": 123,
"awaiting": 123,
"awaitingRecent": 123,
"expired": 123
},
"tabs": {
"all": 123,
"issues": 123,
"unverified": 123
},
"rows": [
{
"contactId": "<string>",
"name": "<string>",
"subline": "<string>",
"publicLiability": {
"state": "valid",
"label": "<string>",
"detail": "<string>",
"credentialId": "<string>",
"verified": true
},
"employersLiability": {
"state": "valid",
"label": "<string>",
"detail": "<string>",
"credentialId": "<string>",
"verified": true
},
"accreditation": {
"state": "valid",
"label": "<string>",
"detail": "<string>",
"credentialId": "<string>",
"verified": true
},
"riskAssessment": {
"state": "valid",
"label": "<string>",
"detail": "<string>",
"credentialId": "<string>",
"verified": true
},
"issue": true,
"unverified": true,
"minimumIssues": [
"<string>"
]
}
],
"toVerify": [
{
"id": "<string>",
"source": "submission",
"title": "<string>",
"kind": "<string>",
"contactId": "<string>",
"onboardingId": "<string>",
"who": "<string>",
"fileType": "<string>",
"uploadedAt": "<string>",
"coverMinor": 123,
"reference": "<string>",
"provider": "<string>",
"expiresOn": "<string>",
"documentId": "<string>"
}
],
"toVerifyCount": 123,
"minimums": {
"groups": [
{
"label": "<string>",
"trades": [
"<string>"
],
"publicLiabilityMinor": 123,
"accreditationRequired": true
}
],
"employersLiabilityMinor": 123,
"custom": true
}
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}contractors
Insurance
The Insurance & certificates board: the grid by contractor (all, issues, unverified), the queue to verify and your minimums
GET
/
contractor-insurance
Insurance
curl --request GET \
--url https://api.sortx.co.uk/contractor-insurance \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/contractor-insurance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-insurance"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"kpis": {
"onFile": 123,
"contractors": 123,
"verified": 123,
"awaiting": 123,
"awaitingRecent": 123,
"expired": 123
},
"tabs": {
"all": 123,
"issues": 123,
"unverified": 123
},
"rows": [
{
"contactId": "<string>",
"name": "<string>",
"subline": "<string>",
"publicLiability": {
"state": "valid",
"label": "<string>",
"detail": "<string>",
"credentialId": "<string>",
"verified": true
},
"employersLiability": {
"state": "valid",
"label": "<string>",
"detail": "<string>",
"credentialId": "<string>",
"verified": true
},
"accreditation": {
"state": "valid",
"label": "<string>",
"detail": "<string>",
"credentialId": "<string>",
"verified": true
},
"riskAssessment": {
"state": "valid",
"label": "<string>",
"detail": "<string>",
"credentialId": "<string>",
"verified": true
},
"issue": true,
"unverified": true,
"minimumIssues": [
"<string>"
]
}
],
"toVerify": [
{
"id": "<string>",
"source": "submission",
"title": "<string>",
"kind": "<string>",
"contactId": "<string>",
"onboardingId": "<string>",
"who": "<string>",
"fileType": "<string>",
"uploadedAt": "<string>",
"coverMinor": 123,
"reference": "<string>",
"provider": "<string>",
"expiresOn": "<string>",
"documentId": "<string>"
}
],
"toVerifyCount": 123,
"minimums": {
"groups": [
{
"label": "<string>",
"trades": [
"<string>"
],
"publicLiabilityMinor": 123,
"accreditationRequired": true
}
],
"employersLiabilityMinor": 123,
"custom": true
}
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}