Sign in

v1

latestOpenAPI 3.1.02026-07-24300110.4 KB

POST Document

Creates a document.

post/v2/exchange/documents

Query parameters

namestring required

Name of the document

filestring binary required

The document file to upload

descriptionstring

Description of the document

certification'soc1-type-1' | 'soc1-type-2' | 'soc2-type-1' | 'soc2-type-2' | 'soc3' | 'iso-9001' | 'iso-22301-2019' | 'iso-27001' | 'iso-27001-2013' | 'iso-27001-2022' | 'iso-27017' | 'iso-27018' | 'iso-27018-2014' | 'iso-27701' | 'iso-14001' | 'csa' | 'pci' | 'gdpr' | 'sig' | 'hipaa' | 'hipaa-ce' | 'hitrust' | 'fedramp' | 'fedramp-high' | 'fedramp-li-saas' | 'fedramp-moderate' | 'cyber-essentials' | 'cyber-essentials-plus' | 'nist' | 'nist-800-171' | 'ccpa' | '21-cfr-11' | 'fisma' | 'eu-cloud-coc' | 'microsoft-365-certified-app' | 'ico-registered' | 'iatf-16949' | 'ens' | 'tpn' | 'tpn-blue' | 'tpn-gold' | 'cfpb' | 'eu-us-data-privacy' | 'pipeda' | 'tisax' | 'vpat' | 'swiss-us-dpf' | 'uk-extension-to-eu-us-dpf' | 'tx-ramp' | 'us-dol-cybersecurity' | 'casa' | 'irap soc1-type-1' | 'irap'

Certification type (badge) of the document

featuredboolean

When set to true, this document will be 'featured' on a public profile

folder_idstring

UUID of the folder to place the document in

access_level'public' | 'protected' | 'need_to_know' | 'internal'

Access level of the document

product_line_idsstring

Comma-separated Product Line UUIDs. These are the applicable product lines for the document. Leave blank if applicable to all product lines.

access_group_idsstring

Comma-separated Access Group UUIDs

disable_downloadsboolean

Disable downloads for this document

use_for_question_answeringboolean

Use this document for question answering. If not provided, it will be automatically determined based on whether the document can be used for question answering.

expires_atstring

Expiration date in ISO 8601 format (e.g. 2026-12-31).

curator_idstring

Document owner/curator. Must be a user in your org. Cannot be combined with curator_email unless they match.

curator_emailstring

Alternative to curator_id. Resolved to a user in your org. Cannot be combined with curator_id unless they match.

Headers

X-API-KEYstring

Your Conveyor API key

Response

201

idstring
created_atstring
updated_atstring
file_updated_atstring
namestring
descriptionstring
display_certificationstring
publicly_accessibleboolean
featuredboolean
folderstring
access_levelstring
use_for_question_answeringboolean
disable_downloadsboolean

Example response

{
  "id": "9ac0f20b-554e-490e-b806-e6713068404c",
  "created_at": "2024-09-17T17:48:17.221Z",
  "updated_at": "2024-09-17T17:48:17.500Z",
  "file_updated_at": "2024-09-17T17:48:17.422Z",
  "name": "test_document_name",
  "description": "test test",
  "display_certification": "Cyber Essentials",
  "featured": true,
  "folder": "testa",
  "access_level": "need_to_know",
  "product_lines": [
    {
      "id": "c75a6dff-532e-481a-9fcb-0410afc7ea7e",
      "created_at": "2024-09-11T17:04:48.615Z",
      "updated_at": "2024-09-11T17:04:48.615Z",
      "_type": "product_line",
      "program_id": "af57131d-50e7-4b2d-be4e-a8703ec255bc",
      "name": "test cloud",
      "in_use": true
    }
  ],
  "access_groups": [
    {
      "id": "bb2ecf25-1cfb-451a-adfe-91fcf9bd6158",
      "created_at": "2024-09-11T17:05:40.182Z",
      "updated_at": "2024-09-11T17:05:40.182Z",
      "_type": "exchange/access_group",
      "name": "test access group ",
      "dataroom_id": "74fa2c77-402c-4384-b68d-35746d79659e",
      "in_use": true,
      "_links": {
        "self": {
          "href": "http://localhost:4006/exchange/access_groups/bb2ecf25-1cfb-451a-adfe-91fcf9bd6158"
        }
      }
    }
  ],
  "versions": [
    {
      "id": "ed3a99aa-eab8-45cc-9aac-04050b59d1ff",
      "version_number": 1,
      "content_type": "application/pdf",
      "filename": "Boarding Pass - OYJHHQ - BOS-SFO.pdf",
      "created_at": "2024-09-17T17:48:17.422Z"
    }
  ],
  "use_for_question_answering": true
}