Mark onboarding check
curl --request POST \
--url https://api.sortx.co.uk/contractor-onboarding/{id}/checks/{item} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"note": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '<string>'})
};
fetch('https://api.sortx.co.uk/contractor-onboarding/{id}/checks/{item}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-onboarding/{id}/checks/{item}"
payload = { "note": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"card": {
"id": "<string>",
"businessName": "<string>",
"trades": [
"<string>"
],
"tradeLabel": "<string>",
"stage": "invited",
"invitedAt": "<string>",
"opened": true,
"filled": 123,
"required": 123,
"lastActivityAt": "<string>",
"stalledDays": 123,
"reviewPill": {
"tone": "ok",
"label": "<string>"
},
"changesRequested": true,
"approvedAt": "<string>",
"contactId": "<string>"
},
"headline": "<string>",
"email": "<string>",
"phone": "<string>",
"coverageAreas": [
"<string>"
],
"teamSize": 123,
"employsStaff": true,
"registrationNumber": "<string>",
"vatNumber": "<string>",
"appliedAt": "<string>",
"changesMessage": "<string>",
"documents": [
{
"slot": "company_details",
"label": "<string>",
"required": true,
"state": "missing",
"note": "<string>",
"submissionId": "<string>",
"documentId": "<string>"
}
],
"checks": [
{
"item": "register_lookup",
"label": "<string>",
"done": true,
"automatic": true,
"note": "<string>",
"doneByName": "<string>",
"doneAt": "<string>"
}
],
"canApprove": true,
"blockers": [
"<string>"
]
}{
"_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
Mark onboarding check
Mark one of your checks done: register lookup, Companies House, bank details confirmed by phone
POST
/
contractor-onboarding
/
{id}
/
checks
/
{item}
Mark onboarding check
curl --request POST \
--url https://api.sortx.co.uk/contractor-onboarding/{id}/checks/{item} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"note": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({note: '<string>'})
};
fetch('https://api.sortx.co.uk/contractor-onboarding/{id}/checks/{item}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractor-onboarding/{id}/checks/{item}"
payload = { "note": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"card": {
"id": "<string>",
"businessName": "<string>",
"trades": [
"<string>"
],
"tradeLabel": "<string>",
"stage": "invited",
"invitedAt": "<string>",
"opened": true,
"filled": 123,
"required": 123,
"lastActivityAt": "<string>",
"stalledDays": 123,
"reviewPill": {
"tone": "ok",
"label": "<string>"
},
"changesRequested": true,
"approvedAt": "<string>",
"contactId": "<string>"
},
"headline": "<string>",
"email": "<string>",
"phone": "<string>",
"coverageAreas": [
"<string>"
],
"teamSize": 123,
"employsStaff": true,
"registrationNumber": "<string>",
"vatNumber": "<string>",
"appliedAt": "<string>",
"changesMessage": "<string>",
"documents": [
{
"slot": "company_details",
"label": "<string>",
"required": true,
"state": "missing",
"note": "<string>",
"submissionId": "<string>",
"documentId": "<string>"
}
],
"checks": [
{
"item": "register_lookup",
"label": "<string>",
"done": true,
"automatic": true,
"note": "<string>",
"doneByName": "<string>",
"doneAt": "<string>"
}
],
"canApprove": true,
"blockers": [
"<string>"
]
}{
"_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>"
}Authorizations
Response
Success