Attach certificates
curl --request POST \
--url https://api.sortx.co.uk/companies/{id}/onboarding-certificates \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"documentIds": [
"<string>"
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({documentIds: ['<string>']})
};
fetch('https://api.sortx.co.uk/companies/{id}/onboarding-certificates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/companies/{id}/onboarding-certificates"
payload = { "documentIds": ["<string>"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"credential": {
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"approvedAt": "<string>",
"approvedByName": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
},
"documentIds": [
"<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>"
}company-onboarding
Attach certificates
Attach the insurance certificates uploaded onto a company the New company wizard added
POST
/
companies
/
{id}
/
onboarding-certificates
Attach certificates
curl --request POST \
--url https://api.sortx.co.uk/companies/{id}/onboarding-certificates \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"documentIds": [
"<string>"
]
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({documentIds: ['<string>']})
};
fetch('https://api.sortx.co.uk/companies/{id}/onboarding-certificates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/companies/{id}/onboarding-certificates"
payload = { "documentIds": ["<string>"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"credential": {
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"approvedAt": "<string>",
"approvedByName": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<string>"
},
"documentIds": [
"<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>"
}