Create compliance document

POST

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

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.

document_typeenumRequired

schema_versionintegerRequired

descriptionstringOptional<=524288 characters

valid_fromdatetimeOptional

valid_untildatetimeOptional

Response

Successful Response

_idstring

document_typeenum

driver_idstring

org_idstring

Must be a string starting with org_

schema_versioninteger

descriptionstringOptional<=524288 characters

driver_compliance_document_s3_object_metadata_idslist of stringsOptional

valid_fromdatetimeOptional

valid_untildatetimeOptional

Errors

422

Compliance Documents Create V1request Unprocessable Entity Error

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	document_type: "drivers_license",
9	schema_version: 1,
10	});
11	}
12	main();

1	{
2	"_id": "_id",
3	"document_type": "drivers_license",
4	"driver_id": "driver_id",
5	"org_id": "org_id",
6	"schema_version": 1,
7	"description": "description",
8	"driver_compliance_document_s3_object_metadata_ids": [
9	"driver_compliance_document_s3_object_metadata_ids"
10	],
11	"valid_from": "2024-01-15T09:30:00Z",
12	"valid_until": "2024-01-15T09:30:00Z"
13	}