Create compliance document

POST

/orgs/compliance_documents/create/v1

POST

/orgs/compliance_documents/create/v1

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.orgs.complianceDocuments.createV1({
8         document_type: "security_threat_assessment",
9         schema_version: 1,
10     });
11 }
12 main();

1 {
2   "_id": "doc_9f8b7c6a-1234-4d56-8e9f-abcdef123456",
3   "document_type": "security_threat_assessment",
4   "org_id": "org_7a8b9c0d1234",
5   "org_type": "provider",
6   "schema_version": 1,
7   "description": "Annual security threat assessment report for 2024.",
8   "org_compliance_document_s3_object_metadata_ids": [
9     "s3meta_20240115_001"
10   ],
11   "valid_from": "2024-01-15T09:30:00Z",
12   "valid_until": "2025-01-14T23:59:59Z"
13 }

Creates a compliance document record for the caller’s provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientCreate1) -> (OrgComplianceDocument1)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

document_typeenumRequired

schema_versionintegerRequired

descriptionstring or nullOptional<=524288 characters

valid_fromdatetime or nullOptional

valid_untildatetime or nullOptional

Response

Successful Response

_idstring

document_typeenum

org_idstring

Must be a string starting with org_

org_typeenum

schema_versioninteger

descriptionstring or null<=524288 characters

org_compliance_document_s3_object_metadata_idslist of strings

valid_fromdatetime or null

valid_untildatetime or null

Errors

422

Compliance Documents Create V1request Unprocessable Entity Error