Skip to main content
POST
Complete a contact document upload
Confirms that the file was uploaded to the presigned URL and makes the document usable on calls.

Overview

The stored object is verified before anything changes: it must exist, be within the 20 MiB limit, be no larger than the size you declared when starting the upload, and carry the content type the URL was issued for. A file that fails any of these is deleted, its reservation is released, and you get a 400 saying which check failed. Safe to retry. Completing an already-completed document returns it unchanged with a 200.

Example

Error Scenarios

  • 400 Bad Request: Nothing has been uploaded to the URL yet, or the stored file is too large, larger than declared, or of a different content type. A file that fails verification is deleted
  • 404 Not Found: No such document on that contact
  • 429 Too Many Requests: Completion rate limit exceeded — wait for Retry-After seconds

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

id
string<uuid>
required

Contact the document belongs to.

documentId
string<uuid>
required

Document id.

Query Parameters

companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

Upload verified; the document is now READY

id
string<uuid>
required

Document ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

title
string
required

Human-readable label for the document

Example:

"Benefits and perks"

status
enum<string>
required

PENDING while waiting for the file to be uploaded to the presigned URL and the upload to be completed; READY once the file is confirmed stored. Only READY documents are attached to calls.

Available options:
PENDING,
READY
Example:

"READY"

isActive
boolean
required

Whether the agent may consult this document during a call. Always false while the upload is PENDING.

Example:

true

source
enum<string>
required

UPLOAD for a file attached through the API or the dashboard. CV for the document the platform produces from a contact's processed CV (contacts only); a CV document can be deactivated but not renamed or deleted. Always UPLOAD on an agent's knowledge base.

Available options:
UPLOAD,
CV
Example:

"UPLOAD"

createdAt
string<date-time>
required

When the document was created

Example:

"2026-08-08T10:15:00.000Z"

fileName
string

Original file name as uploaded

Example:

"benefits-and-perks.pdf"

mimeType
string

MIME type of the stored file

Example:

"application/pdf"

sizeBytes
number

Size of the stored file in bytes, as verified against storage. Absent until the upload is READY.

Example:

482133