DocumentsDelete document

Delete document

DELETE/firm-partners/workspace/documents/{uuid}

Deletes the document blob and database row.

Blocked for Period Close system roots and Bank Statements/ paths.

HMAC signature only

Headers

count-workspace-iduuidrequired

UUID of the client workspace to act on. It must be one of your firm's client workspaces (or the firm's own workspace) and within the API key's client workspaces.

Path parameters

uuiduuidrequired

Document UUID.

Responses

200Document deleted.
400The `count-workspace-id` header is missing.
401Missing signing headers, an invalid HMAC signature, or a timestamp more than 5 minutes off. Troubleshoot
403Document is in a protected path. Troubleshoot
404Document not found.
429Rate limit exceeded (100 requests per minute per firm user of each app, or 10,000 per minute per app). Troubleshoot
DELETEhttps://api.getcount.com/firm-partners/workspace/documents/{uuid}
Request
import crypto from 'node:crypto';

const BASE_URL = 'https://api.getcount.com';
const CLIENT_ID = process.env.COUNT_CLIENT_ID;
const CLIENT_SECRET = process.env.COUNT_CLIENT_SECRET;

const method = 'DELETE';
const signingPath = '/workspace/documents/d9e0f1a2-b3c4-5678-def0-890123456789';
const timestamp = Math.floor(Date.now() / 1000).toString();
const bodyString = '';

const bodyHash = '';
const baseString = `${method}:${signingPath}:${timestamp}:${bodyHash}`;
const signature = crypto.createHmac('sha256', CLIENT_SECRET).update(baseString).digest('hex');

const response = await fetch(`${BASE_URL}/firm-partners/workspace/documents/d9e0f1a2-b3c4-5678-def0-890123456789`, {
  method,
  headers: {
    'x-client-id': CLIENT_ID,
    'x-timestamp': timestamp,
    'x-signature': signature,
    'count-workspace-id': '5e4d3c2b-1a09-4f8e-8d7c-6b5a49382716',
  },
});

console.log(await response.json());
Response · 200
{
  "status": "success",
  "message": "Document deleted."
}