Upload incoming certificate
curl --request POST \
--url https://api.sortx.co.uk/certificate-intake/files \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form file=@example-fileconst form = new FormData();
form.append('file', '<string>');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.sortx.co.uk/certificate-intake/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/certificate-intake/files"
files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, files=files, headers=headers)
print(response.text){
"id": "<string>",
"documentId": "<string>",
"name": "<string>",
"contentType": "<string>",
"sizeBytes": 123,
"source": "upload",
"batchId": "<string>",
"emailFrom": "<string>",
"emailSubject": "<string>",
"status": "to_file",
"revision": 123,
"receivedAt": "<string>",
"textState": "<string>",
"postcodeMatches": [
{
"id": "<string>",
"label": "<string>"
}
],
"suggestion": {
"id": "<string>",
"state": "<string>",
"note": "<string>",
"kind": {
"id": "<string>",
"label": "<string>",
"confidence": 123
},
"property": {
"id": "<string>",
"label": "<string>",
"confidence": 123
},
"values": [
{
"field": "<string>",
"value": "<string>",
"spanId": "<string>",
"quote": "<string>"
}
],
"missingFields": [
"<string>"
]
},
"readiness": "reading",
"filed": {
"subjectKind": "<string>",
"subjectId": "<string>",
"label": "<string>",
"kind": "<string>"
},
"decidedAt": "<string>",
"dismissReason": "<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>"
}compliance
Upload incoming certificate
Add one certificate file to the incoming certificates; the same request id replays
POST
/
certificate-intake
/
files
Upload incoming certificate
curl --request POST \
--url https://api.sortx.co.uk/certificate-intake/files \
--header 'Content-Type: multipart/form-data' \
--header 'x-api-key: <api-key>' \
--form file=@example-fileconst form = new FormData();
form.append('file', '<string>');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://api.sortx.co.uk/certificate-intake/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/certificate-intake/files"
files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, files=files, headers=headers)
print(response.text){
"id": "<string>",
"documentId": "<string>",
"name": "<string>",
"contentType": "<string>",
"sizeBytes": 123,
"source": "upload",
"batchId": "<string>",
"emailFrom": "<string>",
"emailSubject": "<string>",
"status": "to_file",
"revision": 123,
"receivedAt": "<string>",
"textState": "<string>",
"postcodeMatches": [
{
"id": "<string>",
"label": "<string>"
}
],
"suggestion": {
"id": "<string>",
"state": "<string>",
"note": "<string>",
"kind": {
"id": "<string>",
"label": "<string>",
"confidence": 123
},
"property": {
"id": "<string>",
"label": "<string>",
"confidence": 123
},
"values": [
{
"field": "<string>",
"value": "<string>",
"spanId": "<string>",
"quote": "<string>"
}
],
"missingFields": [
"<string>"
]
},
"readiness": "reading",
"filed": {
"subjectKind": "<string>",
"subjectId": "<string>",
"label": "<string>",
"kind": "<string>"
},
"decidedAt": "<string>",
"dismissReason": "<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
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Body
multipart/form-data
Response
Success
Available options:
upload, email Available options:
to_file, filed, dismissed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
reading, ready, needs_look Show child attributes
Show child attributes