Skip to main content
POST
Create document resource

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
file
file
required
title
string
required

Title of the document resource.

Minimum string length: 1
description
string

Description of the document resource.

ownerAssignment
string

Owner to assign as a JSON string: {"type":"User","id":""}.

customerVisibility
string

Customer visibility on the Trust Center: PRIVATE | SHAREABLE | REQUEST_ACCESS | PUBLIC.

downloadPermission
string

Trust Center download permission: VIEW_ONLY | VIEW_AND_DOWNLOAD.

isUsedInQuestionnaires
string

Whether to use this resource for Questionnaire Automation answer generation ("true" / "false").

expirationDate
string

Expiration date in ISO 8601.

tags
string

Tags as a JSON array: [{"categoryId":"","tagId":""}].

categoryId
string

Trust Center category id to associate this resource with. Only applied when customerVisibility is REQUEST_ACCESS or PUBLIC; other visibilities don't place the resource on the Trust Center, so the category is ignored. Pass an unknown id to fall back to uncategorized.

Response

200 - application/json

Ok

id
string
required
type
enum<string>
required
Available options:
FILE
title
string
required
description
string | null
required
fileUrl
string
required

Presigned S3 URL for the underlying document. Expires after 1 hour due to AWS IAM Role limitations on presigned URL lifetimes. Re-fetch the resource to obtain a fresh URL once this one expires.

customerVisibility
enum<string> | null
required
Available options:
PRIVATE,
SHAREABLE,
REQUEST_ACCESS,
PUBLIC,
null
downloadPermission
enum<string> | null
required
Available options:
VIEW_ONLY,
VIEW_AND_DOWNLOAD,
null
isUsedInQuestionnaires
boolean | null
required
ownerAssignment
object | null
required
expirationStatus
enum<string>
required

Customer-facing expiration status used by knowledge-base API responses (answer library entries and resources). Derived from the persisted expiresAt field at read time.

Available options:
CURRENT,
EXPIRED
expirationDate
string | null
required
lastUpdated
string
required
lastVerified
string | null
required
tags
object[]
required
categoryId
string | null
required

Trust Center category id the resource is currently filed under, or null if uncategorized (or not on the Trust Center, which is the case for PRIVATE / SHAREABLE resources).