List compliance documents

GET

/shipping/drivers/compliance_documents/list/v1/:driver_id

Lists compliance documents for one driver in the caller’s provider organization. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[DriverComplianceDocument1])

Authentication

AuthorizationBearer

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

Path parameters

driver_idstringRequired

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 List 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.listV1("driver_id");
8	}
9	main();

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