Mark vendor access as revoked
curl --request POST \
--url https://api.trycomp.ai/v1/offboarding-checklist/member/{memberId}/access-revocations/{vendorId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"notes": "Seat removed from the admin console on 2026-03-04.",
"fileName": "okta-deprovision.png",
"fileType": "image/png",
"fileData": "iVBORw0KGgo="
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
notes: 'Seat removed from the admin console on 2026-03-04.',
fileName: 'okta-deprovision.png',
fileType: 'image/png',
fileData: 'iVBORw0KGgo='
})
};
fetch('https://api.trycomp.ai/v1/offboarding-checklist/member/{memberId}/access-revocations/{vendorId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/offboarding-checklist/member/{memberId}/access-revocations/{vendorId}"
payload = {
"notes": "Seat removed from the admin console on 2026-03-04.",
"fileName": "okta-deprovision.png",
"fileType": "image/png",
"fileData": "iVBORw0KGgo="
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Offboarding Checklist
Mark vendor access as revoked | Comp AI API
Marks a single vendor’s access for a departing member as revoked, optionally attaching evidence and notes, as part of offboarding access removal.
POST
/
v1
/
offboarding-checklist
/
member
/
{memberId}
/
access-revocations
/
{vendorId}
Mark vendor access as revoked
curl --request POST \
--url https://api.trycomp.ai/v1/offboarding-checklist/member/{memberId}/access-revocations/{vendorId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"notes": "Seat removed from the admin console on 2026-03-04.",
"fileName": "okta-deprovision.png",
"fileType": "image/png",
"fileData": "iVBORw0KGgo="
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
notes: 'Seat removed from the admin console on 2026-03-04.',
fileName: 'okta-deprovision.png',
fileType: 'image/png',
fileData: 'iVBORw0KGgo='
})
};
fetch('https://api.trycomp.ai/v1/offboarding-checklist/member/{memberId}/access-revocations/{vendorId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.trycomp.ai/v1/offboarding-checklist/member/{memberId}/access-revocations/{vendorId}"
payload = {
"notes": "Seat removed from the admin console on 2026-03-04.",
"fileName": "okta-deprovision.png",
"fileType": "image/png",
"fileData": "iVBORw0KGgo="
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Authorizations
API key for authentication
Body
application/json
Optional notes and evidence for the revocation
Free-text note stored with the revocation record.
Example:
"Seat removed from the admin console on 2026-03-04."
Evidence file name. fileName, fileType and fileData must be sent together or all omitted.
Example:
"okta-deprovision.png"
MIME type of the evidence file.
Example:
"image/png"
Base64-encoded evidence file contents.
Example:
"iVBORw0KGgo="
Response
201 - undefined
Was this page helpful?

