Create compliance document

POST

/shipping/drivers/compliance_documents/create/v1/:driver_id

POST

/shipping/drivers/compliance_documents/create/v1/:driver_id

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.shipping.drivers.complianceDocuments.createV1("driver_id", {
8         schema_version: 1,
9         document_type: "drivers_license",
10     });
11 }
12 main();

1 {
2   "schema_version": 1,
3   "_id": "doc_9f8b7c6a2d3e4f1a",
4   "org_id": "org_12345abcde",
5   "driver_id": "driver_67890fghij",
6   "document_type": "drivers_license",
7   "description": "State-issued driver's license for John Doe",
8   "driver_compliance_document_s3_object_metadata_ids": [
9     "s3obj_abcdef1234567890"
10   ],
11   "valid_from": "2023-06-01T08:00:00Z",
12   "valid_until": "2028-06-01T08:00:00Z"
13 }

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

Authentication

AuthorizationBearer

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

Path parameters

driver_idstringRequired

Request

This endpoint expects an object.

schema_versionintegerRequired

document_typeenumRequired

descriptionstringOptional<=524288 characters

valid_fromdatetimeOptional

valid_untildatetimeOptional

Response

Successful Response

schema_versioninteger

_idstring

org_idstring

Must be a string starting with org_

driver_idstring

document_typeenum

descriptionstring<=524288 characters

driver_compliance_document_s3_object_metadata_idslist of strings

valid_fromdatetime

valid_untildatetime

Errors

422

Compliance Documents Create V1request Unprocessable Entity Error