Update compliance document

PATCH

/shipping/drivers/compliance_documents/update/v1/:driver_compliance_document_id

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

Authentication

AuthorizationBearer

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

Path parameters

driver_compliance_document_idstringRequired

Request

This endpoint expects an object.

descriptionstringOptional<=524288 characters

description__set_to_NonebooleanOptionalDefaults to false

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 Update 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.updateV1("driver_compliance_document_id", {});
8	}
9	main();

1	{
2	"schema_version": 1,
3	"_id": "dcd_9f8a7b6c5d4e3f2a1b0c",
4	"org_id": "org_1234567890abcdef",
5	"driver_id": "drv_abcdef1234567890",
6	"document_type": "drivers_license",
7	"description": "Updated driver license document for John Doe.",
8	"driver_compliance_document_s3_object_metadata_ids": [
9	"s3obj_9876543210fedcba"
10	],
11	"valid_from": "2023-05-01T08:00:00Z",
12	"valid_until": "2026-05-01T08:00:00Z"
13	}