Withdraw credential
curl --request POST \
--url https://api.sortx.co.uk/contractors/{contactId}/credentials/{credentialId}/withdraw \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"reason": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://api.sortx.co.uk/contractors/{contactId}/credentials/{credentialId}/withdraw', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractors/{contactId}/credentials/{credentialId}/withdraw"
payload = { "reason": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<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
Withdraw credential
Withdraw evidence that no longer stands; it stays in the history
POST
/
contractors
/
{contactId}
/
credentials
/
{credentialId}
/
withdraw
Withdraw credential
curl --request POST \
--url https://api.sortx.co.uk/contractors/{contactId}/credentials/{credentialId}/withdraw \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"reason": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://api.sortx.co.uk/contractors/{contactId}/credentials/{credentialId}/withdraw', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/contractors/{contactId}/credentials/{credentialId}/withdraw"
payload = { "reason": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"contactId": "<string>",
"kind": "<string>",
"name": "<string>",
"reference": "<string>",
"provider": "<string>",
"coverMinor": 123,
"currency": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"documentId": "<string>",
"status": "<string>",
"supersededById": "<string>",
"endedAt": "<string>",
"endReason": "<string>",
"actorUserId": "<string>",
"actorName": "<string>",
"createdAt": "<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
application/json
Response
Success