{"items":[{"type":"link","label":"MeshVI API","link":"/apis/meshvi","routeSlug":"/apis/meshvi","content":{"contentType":"overview","meta":{"name":"MeshVI API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"meshvi.json","url":"/_bundle/apis/meshvi.json?download"},{"kind":"download","label":"meshvi.yaml","url":"/_bundle/apis/meshvi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"MeshVI API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API documentation for MeshVI services. Protected routes use application authorization ([APIAuthorize]): a valid Bearer JWT is validated by the API. Calls to the hosted base URL also require an API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, enforced at the API edge. Includes Acord certificate verification and retrieval, client, document (Document Manager v1 list/upload/update/download/delete), driver, policy, vehicle, vehicle and driver coverage assignment, and policy premium report operations for real-time insurance verification and fleet management."},"children":[]}]}]}]}],"sectionId":"/apis/meshvi"}],"sectionId":"/apis/meshvi"}]}]}},{"type":"group","label":"meshVerified","link":"/apis/meshvi/meshverified","routeSlug":"/apis/meshvi/meshverified","items":[{"label":"Get Client Certificate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/meshverified/paths/~1v1~1certificates~1clients/get","routeSlug":"/apis/meshvi/meshverified/paths/~1v1~1certificates~1clients/get","metadata":{"seo":{"title":"Get Client Certificate","description":"Retrieves the Acord certificate for a client. Provide either client id or DOT number (exactly one)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Client Certificate","isWebhook":false,"pointer":"/paths/~1v1~1certificates~1clients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Client Certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the Acord certificate for a client. Provide either client id or DOT number (exactly one)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_34","description":"Client ID."},{"name":"dot","in":"query","schemaId":"schema_35","description":"DOT number (digits only)."}],"pointer":"/paths/~1v1~1certificates~1clients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/certificates/clients","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","schemaId":"schema_34"},{"name":"dot","in":"query","schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/certificates/clients","href":"meshverified/paths/~1v1~1certificates~1clients/get","summary":"Get Client Certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Certificate data returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36"},{"code":"400","description":"Bad Request (e.g. missing or invalid parameters)."},{"code":"401","description":"Unauthorized."},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1certificates~1clients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"400"},{"code":"401"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meshverified/paths/~1v1~1certificates~1clients/get"}],"panels":[]}]},"httpPath":"/v1/certificates/clients"},{"label":"Get Client Coverages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/meshverified/paths/~1v1~1coverages~1clients/get","routeSlug":"/apis/meshvi/meshverified/paths/~1v1~1coverages~1clients/get","metadata":{"seo":{"title":"Get Client Coverages","description":"Verifies active certificates of insurance across DOT numbers. Provide exactly one of: dots (array), dot (single), or id (client ID)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Client Coverages","isWebhook":false,"pointer":"/paths/~1v1~1coverages~1clients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Client Coverages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Verifies active certificates of insurance across DOT numbers. Provide exactly one of: dots (array), dot (single), or id (client ID)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"dots","in":"query","schemaId":"schema_37","description":"List of DOT numbers to verify."},{"name":"dot","in":"query","schemaId":"schema_35","description":"Single DOT number (digits only)."},{"name":"id","in":"query","schemaId":"schema_34","description":"Client ID."}],"pointer":"/paths/~1v1~1coverages~1clients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/coverages/clients","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"dots","in":"query","schemaId":"schema_37"},{"name":"dot","in":"query","schemaId":"schema_35"},{"name":"id","in":"query","schemaId":"schema_34"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/coverages/clients","href":"meshverified/paths/~1v1~1coverages~1clients/get","summary":"Get Client Coverages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful verification.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CertificateVerificationResponse"}},"schemaId":"components/schemas/CertificateVerificationResponse"},{"code":"400","description":"Bad Request (e.g. missing or invalid parameters).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v1~1coverages~1clients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CertificateVerificationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CertificateVerificationResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meshverified/paths/~1v1~1coverages~1clients/get"}],"panels":[]}]},"httpPath":"/v1/coverages/clients"},{"label":"Get Vehicle Coverages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/meshverified/paths/~1v1~1coverages~1vehicles/get","routeSlug":"/apis/meshvi/meshverified/paths/~1v1~1coverages~1vehicles/get","metadata":{"seo":{"title":"Get Vehicle Coverages","description":"Verifies certificate of insurance for a vehicle. Provide either vin or licensePlate (exactly one)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Vehicle Coverages","isWebhook":false,"pointer":"/paths/~1v1~1coverages~1vehicles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Vehicle Coverages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Verifies certificate of insurance for a vehicle. Provide either vin or licensePlate (exactly one)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"vin","in":"query","schemaId":"schema_38","description":"VIN (17 characters)."},{"name":"licensePlate","in":"query","schemaId":"schema_35","description":"License plate number."}],"pointer":"/paths/~1v1~1coverages~1vehicles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/coverages/vehicles","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"vin","in":"query","schemaId":"schema_38"},{"name":"licensePlate","in":"query","schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/coverages/vehicles","href":"meshverified/paths/~1v1~1coverages~1vehicles/get","summary":"Get Vehicle Coverages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful verification.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"400","description":"Bad Request (provide either vin or licensePlate, not both)."},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v1~1coverages~1vehicles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meshverified/paths/~1v1~1coverages~1vehicles/get"}],"panels":[]}]},"httpPath":"/v1/coverages/vehicles"},{"label":"Get Vehicle Certificate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/meshverified/paths/~1v1~1certificates~1vehicles/get","routeSlug":"/apis/meshvi/meshverified/paths/~1v1~1certificates~1vehicles/get","metadata":{"seo":{"title":"Get Vehicle Certificate","description":"Retrieves the Acord certificate for a vehicle. Provide exactly one of: id, vin, or licensePlate. clientId may be used in some contexts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Vehicle Certificate","isWebhook":false,"pointer":"/paths/~1v1~1certificates~1vehicles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Vehicle Certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the Acord certificate for a vehicle. Provide exactly one of: id, vin, or licensePlate. clientId may be used in some contexts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_34","description":"Vehicle ID."},{"name":"vin","in":"query","schemaId":"schema_38","description":"VIN (17 characters)."},{"name":"licensePlate","in":"query","schemaId":"schema_35","description":"License plate number."},{"name":"clientId","in":"query","schemaId":"schema_34","description":"Client ID (optional context)."}],"pointer":"/paths/~1v1~1certificates~1vehicles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/certificates/vehicles","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","schemaId":"schema_34"},{"name":"vin","in":"query","schemaId":"schema_38"},{"name":"licensePlate","in":"query","schemaId":"schema_35"},{"name":"clientId","in":"query","schemaId":"schema_34"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/certificates/vehicles","href":"meshverified/paths/~1v1~1certificates~1vehicles/get","summary":"Get Vehicle Certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Certificate data returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"400","description":"Bad Request."},{"code":"401","description":"Unauthorized."},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1certificates~1vehicles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"400"},{"code":"401"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/meshverified/paths/~1v1~1certificates~1vehicles/get"}],"panels":[]}]},"httpPath":"/v1/certificates/vehicles"}],"content":{"contentType":"group","meta":{"name":"meshVerified"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"meshVerified","showPageActions":true},{"nodeType":"markdoc","content":"Certificate verification and retrieval (Acord)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/certificates/clients","summary":"Get Client Certificate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meshverified/paths/~1v1~1certificates~1clients/get","deprecated":false},{"title":"/v1/coverages/clients","summary":"Get Client Coverages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meshverified/paths/~1v1~1coverages~1clients/get","deprecated":false},{"title":"/v1/coverages/vehicles","summary":"Get Vehicle Coverages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meshverified/paths/~1v1~1coverages~1vehicles/get","deprecated":false},{"title":"/v1/certificates/vehicles","summary":"Get Vehicle Certificate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/meshverified/paths/~1v1~1certificates~1vehicles/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Clients","link":"/apis/meshvi/clients","routeSlug":"/apis/meshvi/clients","items":[{"label":"Search clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/clients/paths/~1v1~1clients/get","routeSlug":"/apis/meshvi/clients/paths/~1v1~1clients/get","metadata":{"seo":{"title":"Search clients","description":"Paginated search of clients with filtering and sorting. Supports page, limit, sort, and filters (name, dot, agencyId, producerId, parentClientId, deleted, clientTypeId, acordEnabled)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Search clients","isWebhook":false,"pointer":"/paths/~1v1~1clients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search clients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginated search of clients with filtering and sorting. Supports page, limit, sort, and filters (name, dot, agencyId, producerId, parentClientId, deleted, clientTypeId, acordEnabled)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_40","description":"Page number (1-based)."},{"name":"limit","in":"query","schemaId":"schema_41","description":"Items per page (1-1000)."},{"name":"sort","in":"query","schemaId":"schema_42","description":"Sort field (e.g. -clientName for descending)."},{"name":"name","in":"query","schemaId":"schema_42","description":"Filter by client name (partial match)."},{"name":"dot","in":"query","schemaId":"schema_42","description":"Filter by DOT number."},{"name":"agencyId","in":"query","schemaId":"schema_34","description":"Filter by agency ID."},{"name":"producerId","in":"query","schemaId":"schema_34","description":"Filter by producer ID."},{"name":"parentClientId","in":"query","schemaId":"schema_34","description":"Filter by parent client ID."},{"name":"deleted","in":"query","schemaId":"schema_43","description":"Filter by deleted status."},{"name":"clientTypeId","in":"query","schemaId":"schema_34","description":"Filter by client type ID."},{"name":"acordEnabled","in":"query","schemaId":"schema_43","description":"Filter by ACORD enabled."}],"pointer":"/paths/~1v1~1clients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_40"},{"name":"limit","in":"query","schemaId":"schema_41"},{"name":"sort","in":"query","schemaId":"schema_42"},{"name":"name","in":"query","schemaId":"schema_42"},{"name":"dot","in":"query","schemaId":"schema_42"},{"name":"agencyId","in":"query","schemaId":"schema_34"},{"name":"producerId","in":"query","schemaId":"schema_34"},{"name":"parentClientId","in":"query","schemaId":"schema_34"},{"name":"deleted","in":"query","schemaId":"schema_43"},{"name":"clientTypeId","in":"query","schemaId":"schema_34"},{"name":"acordEnabled","in":"query","schemaId":"schema_43"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/clients","href":"clients/paths/~1v1~1clients/get","summary":"Search clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of clients."},{"code":"400","description":"Invalid query parameters."},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v1~1clients/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/paths/~1v1~1clients/get"}],"panels":[]}]},"httpPath":"/v1/clients"},{"label":"Create client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/clients/paths/~1v1~1clients/post","routeSlug":"/apis/meshvi/clients/paths/~1v1~1clients/post","metadata":{"seo":{"title":"Create client","description":"Creates a new client. Required: clientName, agencyId. Name-based fields (state, city, mailingState, mailingCity) are resolved to IDs via master data lookup. If parentClientId is provided, the parent must belong to the same agency."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create client","isWebhook":false,"pointer":"/paths/~1v1~1clients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new client. Required: clientName, agencyId. Name-based fields (state, city, mailingState, mailingCity) are resolved to IDs via master data lookup. If parentClientId is provided, the parent must belong to the same agency."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44","pointer":"/paths/~1v1~1clients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/clients","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_44"}},"responseCodes":["201","400","401","403"],"pointer":"/v1/clients","href":"clients/paths/~1v1~1clients/post","summary":"Create client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_44"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Client created successfully."},{"code":"400","description":"Invalid request data or validation errors."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - token not authorized for the specified agencyId."}],"pointer":"/paths/~1v1~1clients/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/paths/~1v1~1clients/post"}],"panels":[]}]},"httpPath":"/v1/clients"},{"label":"Get client detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/clients/paths/~1v1~1clients~1{id}/get","routeSlug":"/apis/meshvi/clients/paths/~1v1~1clients~1{id}/get","metadata":{"seo":{"title":"Get client detail","description":"Retrieves client details by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get client detail","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get client detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves client details by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_45","description":"Client ID.","required":true}],"pointer":"/paths/~1v1~1clients~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/clients/{id}","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_45"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v1/clients/{id}","href":"clients/paths/~1v1~1clients~1{id}/get","summary":"Get client detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Client details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientDetail","exampleIds":["paths/~1v1~1clients~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ClientDetail","exampleIds":["paths/~1v1~1clients~1{id}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid id."},{"code":"401","description":"Unauthorized."},{"code":"404","description":"Client not found."}],"pointer":"/paths/~1v1~1clients~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClientDetail","exampleIds":["paths/~1v1~1clients~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientDetail","exampleIds":["paths/~1v1~1clients~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/paths/~1v1~1clients~1{id}/get"}],"panels":[]}]},"httpPath":"/v1/clients/{id}"},{"label":"Update client","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/clients/paths/~1v1~1clients~1{id}/put","routeSlug":"/apis/meshvi/clients/paths/~1v1~1clients~1{id}/put","metadata":{"seo":{"title":"Update client","description":"Updates an existing client. All fields are optional (partial update). If agencyId is provided, the token must be authorized for it. If parentClientId is provided, it must belong to the same agency as the client being updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update client","isWebhook":false,"pointer":"/paths/~1v1~1clients~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing client. All fields are optional (partial update). If agencyId is provided, the token must be authorized for it. If parentClientId is provided, it must belong to the same agency as the client being updated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_45","description":"Client identifier.","required":true}],"pointer":"/paths/~1v1~1clients~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_46"}},"schemaId":"schema_46","pointer":"/paths/~1v1~1clients~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/clients/{id}","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_45"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_46"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/clients/{id}","href":"clients/paths/~1v1~1clients~1{id}/put","summary":"Update client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_46","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_46"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Client updated successfully."},{"code":"400","description":"Invalid request data or validation errors."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - token not authorized for the specified client, agencyId, or parentClientId."},{"code":"404","description":"Client not found."}],"pointer":"/paths/~1v1~1clients~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/paths/~1v1~1clients~1{id}/put"}],"panels":[]}]},"httpPath":"/v1/clients/{id}"}],"content":{"contentType":"group","meta":{"name":"Clients"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clients","showPageActions":true},{"nodeType":"markdoc","content":"Client CRUD and search."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/clients","summary":"Search clients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clients/paths/~1v1~1clients/get","deprecated":false},{"title":"/v1/clients","summary":"Create client","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clients/paths/~1v1~1clients/post","deprecated":false},{"title":"/v1/clients/{id}","summary":"Get client detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clients/paths/~1v1~1clients~1{id}/get","deprecated":false},{"title":"/v1/clients/{id}","summary":"Update client","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clients/paths/~1v1~1clients~1{id}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Documents","link":"/apis/meshvi/documents","routeSlug":"/apis/meshvi/documents","items":[{"label":"List client documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/paths/~1v1~1documents~1clients/get","routeSlug":"/apis/meshvi/documents/paths/~1v1~1documents~1clients/get","metadata":{"seo":{"title":"List client documents","description":"Returns document file names and time-limited download URLs (S3 pre-signed) for a client. Requires Document Manager View permission scoped to the client module. When dot is provided, the API validates that the DOT is set on the client and that the caller has access (same pattern as GET /v1/clients)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List client documents","isWebhook":false,"pointer":"/paths/~1v1~1documents~1clients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List client documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns document file names and time-limited download URLs (S3 pre-signed) for a client. Requires Document Manager "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission scoped to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the API validates that the DOT is set on the client and that the caller has access (same pattern as GET /v1/clients)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clientId","in":"query","schemaId":"schema_47","description":"Client ID.","required":true},{"name":"dot","in":"query","schemaId":"schema_42","description":"Optional DOT number; when set, must match the specified client and your access."}],"pointer":"/paths/~1v1~1documents~1clients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/documents/clients","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"clientId","in":"query","required":true,"schemaId":"schema_47"},{"name":"dot","in":"query","required":false,"schemaId":"schema_42"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v1/documents/clients","href":"documents/paths/~1v1~1documents~1clients/get","summary":"List client documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wrapped result: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" true with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" listing documents, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" false (e.g. no documents) with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" text — still HTTP 200."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48"},{"code":"400","description":"Invalid clientId, DOT validation failed, or document list error."},{"code":"401","description":"Unauthorized."},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — Document Manager view not allowed for this client."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1documents~1clients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/paths/~1v1~1documents~1clients/get"}],"panels":[]}]},"httpPath":"/v1/documents/clients"},{"label":"Upload client document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/paths/~1v1~1documents~1clients/post","routeSlug":"/apis/meshvi/documents/paths/~1v1~1documents~1clients/post","metadata":{"seo":{"title":"Upload client document","description":"Multipart upload of a file for a client. Requires Document Manager Create/Edit scoped to the client module. Max request size ~25 MB. Optional Idempotency-Key header: duplicate key returns HTTP 200 with the existing document. On success, response is { success, data } with documentId, fileName, and optional downloadUrl. On failure, body is { errorCode, errorText } (camelCase with CamelCaseResponse)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upload client document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1clients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload client document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multipart upload of a file for a client. Requires Document Manager "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scoped to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module. Max request size ~25 MB. Optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header: duplicate key returns HTTP 200 with the existing document. On success, response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ success, data }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"downloadUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On failure, body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ errorCode, errorText }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (camelCase with CamelCaseResponse)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clientId","in":"query","schemaId":"schema_47","description":"Client ID.","required":true}],"pointer":"/paths/~1v1~1documents~1clients/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_42","description":"Optional idempotency key for safe retries."}],"pointer":"/paths/~1v1~1documents~1clients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_49"}},"schemaId":"schema_49","pointer":"/paths/~1v1~1documents~1clients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/documents/clients","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"clientId","in":"query","required":true,"schemaId":"schema_47"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_49"}},"responseCodes":["200","201","400","401","403","413","415","422"],"pointer":"/v1/documents/clients","href":"documents/paths/~1v1~1documents~1clients/post","summary":"Upload client document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_49","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_49"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK — idempotent replay or update path; wrapped success with document payload."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}},"schemaId":"components/schemas/ApiResponseDocumentUpload"},{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created — new document stored."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}},"schemaId":"components/schemas/ApiResponseDocumentUpload"},{"code":"400","description":"Bad request (e.g. missing client, client not found).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden."},{"code":"413","description":"Payload too large.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"415","description":"Unsupported media type / invalid extension.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"422","description":"Validation error (e.g. content vs extension, document type mismatch).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"}],"pointer":"/paths/~1v1~1documents~1clients/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseDocumentUpload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}}},{"code":"201","schemaId":"components/schemas/ApiResponseDocumentUpload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}}},{"code":"400","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"401"},{"code":"403"},{"code":"413","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"415","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"422","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/paths/~1v1~1documents~1clients/post"}],"panels":[]}]},"httpPath":"/v1/documents/clients"},{"label":"List policy documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/paths/~1v1~1documents~1policies/get","routeSlug":"/apis/meshvi/documents/paths/~1v1~1documents~1policies/get","metadata":{"seo":{"title":"List policy documents","description":"Returns document file names and time-limited download URLs for a policy. Requires Document Manager View permission scoped to the policy module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"List policy documents","isWebhook":false,"pointer":"/paths/~1v1~1documents~1policies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List policy documents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns document file names and time-limited download URLs for a policy. Requires Document Manager "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission scoped to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"policyId","in":"query","schemaId":"schema_47","description":"Policy ID.","required":true}],"pointer":"/paths/~1v1~1documents~1policies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/documents/policies","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"policyId","in":"query","required":true,"schemaId":"schema_47"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v1/documents/policies","href":"documents/paths/~1v1~1documents~1policies/get","summary":"List policy documents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wrapped result: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" true with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" false when no documents."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48"},{"code":"400","description":"Invalid policyId or failed to retrieve list."},{"code":"401","description":"Unauthorized."},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — Document Manager view not allowed for this policy."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1documents~1policies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/paths/~1v1~1documents~1policies/get"}],"panels":[]}]},"httpPath":"/v1/documents/policies"},{"label":"Upload policy document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/paths/~1v1~1documents~1policies/post","routeSlug":"/apis/meshvi/documents/paths/~1v1~1documents~1policies/post","metadata":{"seo":{"title":"Upload policy document","description":"Multipart upload for a policy. Requires Document Manager Create/Edit scoped to the policy module. Same limits and idempotency behavior as POST /v1/documents/clients."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upload policy document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1policies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload policy document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multipart upload for a policy. Requires Document Manager "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scoped to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module. Same limits and idempotency behavior as POST /v1/documents/clients."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"policyId","in":"query","schemaId":"schema_47","description":"Policy ID.","required":true}],"pointer":"/paths/~1v1~1documents~1policies/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_42","description":"Optional idempotency key for safe retries."}],"pointer":"/paths/~1v1~1documents~1policies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_50"}},"schemaId":"schema_50","pointer":"/paths/~1v1~1documents~1policies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/documents/policies","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"policyId","in":"query","required":true,"schemaId":"schema_47"}],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_50"}},"responseCodes":["200","201","400","401","403","413","415","422"],"pointer":"/v1/documents/policies","href":"documents/paths/~1v1~1documents~1policies/post","summary":"Upload policy document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_50","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_50"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK — idempotent replay."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}},"schemaId":"components/schemas/ApiResponseDocumentUpload"},{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}},"schemaId":"components/schemas/ApiResponseDocumentUpload"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden."},{"code":"413","description":"Payload too large.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"415","description":"Unsupported media type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"}],"pointer":"/paths/~1v1~1documents~1policies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseDocumentUpload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}}},{"code":"201","schemaId":"components/schemas/ApiResponseDocumentUpload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}}},{"code":"400","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"401"},{"code":"403"},{"code":"413","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"415","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"422","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/paths/~1v1~1documents~1policies/post"}],"panels":[]}]},"httpPath":"/v1/documents/policies"},{"label":"Update client document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/paths/~1v1~1documents~1{id}~1client/put","routeSlug":"/apis/meshvi/documents/paths/~1v1~1documents~1{id}~1client/put","metadata":{"seo":{"title":"Update client document","description":"Replaces/updates an existing document that belongs to a client (multipart). Requires Document Manager Create/Edit for the client module. Path id is the document ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update client document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1{id}~1client/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update client document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces/updates an existing document that belongs to a client (multipart). Requires Document Manager "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module. Path "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the document ID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","description":"Document ID.","required":true}],"pointer":"/paths/~1v1~1documents~1{id}~1client/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_42"}],"pointer":"/paths/~1v1~1documents~1{id}~1client/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_50"}},"schemaId":"schema_50","pointer":"/paths/~1v1~1documents~1{id}~1client/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/documents/{id}/client","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_50"}},"responseCodes":["200","400","401","403","404","413","415","422"],"pointer":"/v1/documents/{id}/client","href":"documents/paths/~1v1~1documents~1{id}~1client/put","summary":"Update client document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_50","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_50"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}},"schemaId":"components/schemas/ApiResponseDocumentUpload"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden."},{"code":"404","description":"Document not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"413","description":"Payload too large.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"415","description":"Unsupported media type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"422","description":"Not a client document or validation failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"}],"pointer":"/paths/~1v1~1documents~1{id}~1client/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseDocumentUpload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}}},{"code":"400","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"413","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"415","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"422","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/paths/~1v1~1documents~1{id}~1client/put"}],"panels":[]}]},"httpPath":"/v1/documents/{id}/client"},{"label":"Delete client document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/deleteclientdocument","routeSlug":"/apis/meshvi/documents/deleteclientdocument","metadata":{"seo":{"title":"Delete client document","description":"Deletes a document that belongs to a client. Requires Document Manager Delete for the client module. Path id is the document ID. Returns 422 if the document is already deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteClientDocument","name":"Delete client document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1{id}~1client/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete client document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a document that belongs to a client. Requires Document Manager "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module. Path "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the document ID. Returns "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the document is already deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","description":"Document ID.","required":true}],"pointer":"/paths/~1v1~1documents~1{id}~1client/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/documents/{id}/client","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/v1/documents/{id}/client","href":"documents/deleteclientdocument","openApiOperationId":"deleteClientDocument","summary":"Delete client document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentDelete"}},"schemaId":"components/schemas/ApiResponseDocumentDelete"},{"code":"400","description":"Invalid document id (must be greater than zero).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden."},{"code":"404","description":"Document not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"422","description":"Document is already deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1documents~1{id}~1client/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseDocumentDelete","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentDelete"}}},{"code":"400","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"422","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/deleteclientdocument"}],"panels":[]}]},"httpPath":"/v1/documents/{id}/client"},{"label":"Download client document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/paths/~1v1~1documents~1{id}~1client~1download/get","routeSlug":"/apis/meshvi/documents/paths/~1v1~1documents~1{id}~1client~1download/get","metadata":{"seo":{"title":"Download client document","description":"Returns a wrapped payload with documentId, downloadUrl, and expiresAtUtc. Requires Document Manager View for the client module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Download client document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1{id}~1client~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download client document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a wrapped payload with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"documentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"downloadUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiresAtUtc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires Document Manager "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","description":"Document ID.","required":true}],"pointer":"/paths/~1v1~1documents~1{id}~1client~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/documents/{id}/client/download","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/documents/{id}/client/download","href":"documents/paths/~1v1~1documents~1{id}~1client~1download/get","summary":"Download client document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentDownload"}},"schemaId":"components/schemas/ApiResponseDocumentDownload"},{"code":"400","description":"Invalid document id."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden."},{"code":"404","description":"Document or file not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"}],"pointer":"/paths/~1v1~1documents~1{id}~1client~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseDocumentDownload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentDownload"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/paths/~1v1~1documents~1{id}~1client~1download/get"}],"panels":[]}]},"httpPath":"/v1/documents/{id}/client/download"},{"label":"Update policy document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/paths/~1v1~1documents~1{id}~1policy/put","routeSlug":"/apis/meshvi/documents/paths/~1v1~1documents~1{id}~1policy/put","metadata":{"seo":{"title":"Update policy document","description":"Updates an existing document tied to a policy. Requires Document Manager Create/Edit for the policy module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update policy document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1{id}~1policy/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update policy document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing document tied to a policy. Requires Document Manager "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","description":"Document ID.","required":true}],"pointer":"/paths/~1v1~1documents~1{id}~1policy/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_42"}],"pointer":"/paths/~1v1~1documents~1{id}~1policy/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_50"}},"schemaId":"schema_50","pointer":"/paths/~1v1~1documents~1{id}~1policy/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/documents/{id}/policy","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_42"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_50"}},"responseCodes":["200","400","401","403","404","413","415","422"],"pointer":"/v1/documents/{id}/policy","href":"documents/paths/~1v1~1documents~1{id}~1policy/put","summary":"Update policy document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_50","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_50"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}},"schemaId":"components/schemas/ApiResponseDocumentUpload"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden."},{"code":"404","description":"Document not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"413","description":"Payload too large.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"415","description":"Unsupported media type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"422","description":"Not a policy document or validation failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"}],"pointer":"/paths/~1v1~1documents~1{id}~1policy/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseDocumentUpload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentUpload"}}},{"code":"400","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"413","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"415","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"422","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/paths/~1v1~1documents~1{id}~1policy/put"}],"panels":[]}]},"httpPath":"/v1/documents/{id}/policy"},{"label":"Delete policy document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/deletepolicydocument","routeSlug":"/apis/meshvi/documents/deletepolicydocument","metadata":{"seo":{"title":"Delete policy document","description":"Deletes a document tied to a policy. Requires Document Manager Delete for the policy module. Path id is the document ID. Returns 422 if the document is already deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePolicyDocument","name":"Delete policy document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1{id}~1policy/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete policy document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a document tied to a policy. Requires Document Manager "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module. Path "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the document ID. Returns "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the document is already deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","description":"Document ID.","required":true}],"pointer":"/paths/~1v1~1documents~1{id}~1policy/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/documents/{id}/policy","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/v1/documents/{id}/policy","href":"documents/deletepolicydocument","openApiOperationId":"deletePolicyDocument","summary":"Delete policy document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Document deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentDelete"}},"schemaId":"components/schemas/ApiResponseDocumentDelete"},{"code":"400","description":"Invalid document id (must be greater than zero).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden."},{"code":"404","description":"Document not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"422","description":"Document is already deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1documents~1{id}~1policy/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseDocumentDelete","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentDelete"}}},{"code":"400","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"422","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/deletepolicydocument"}],"panels":[]}]},"httpPath":"/v1/documents/{id}/policy"},{"label":"Download policy document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/documents/paths/~1v1~1documents~1{id}~1policy~1download/get","routeSlug":"/apis/meshvi/documents/paths/~1v1~1documents~1{id}~1policy~1download/get","metadata":{"seo":{"title":"Download policy document","description":"Same as GET /v1/documents/{id}/client/download but authorization is scoped to the policy module."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Download policy document","isWebhook":false,"pointer":"/paths/~1v1~1documents~1{id}~1policy~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download policy document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same as GET /v1/documents/{id}/client/download but authorization is scoped to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" module."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_47","description":"Document ID.","required":true}],"pointer":"/paths/~1v1~1documents~1{id}~1policy~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/documents/{id}/policy/download","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_47"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/documents/{id}/policy/download","href":"documents/paths/~1v1~1documents~1{id}~1policy~1download/get","summary":"Download policy document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentDownload"}},"schemaId":"components/schemas/ApiResponseDocumentDownload"},{"code":"400","description":"Invalid document id."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden."},{"code":"404","description":"Document or file not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}},"schemaId":"components/schemas/DocumentManagerErrorBody"}],"pointer":"/paths/~1v1~1documents~1{id}~1policy~1download/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseDocumentDownload","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseDocumentDownload"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/DocumentManagerErrorBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentManagerErrorBody"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/paths/~1v1~1documents~1{id}~1policy~1download/get"}],"panels":[]}]},"httpPath":"/v1/documents/{id}/policy/download"}],"content":{"contentType":"group","meta":{"name":"Documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document Manager v1: list, upload, update, download, and delete for clients and policies ([APIAuthorize])."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/documents/clients","summary":"List client documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/paths/~1v1~1documents~1clients/get","deprecated":false},{"title":"/v1/documents/clients","summary":"Upload client document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/paths/~1v1~1documents~1clients/post","deprecated":false},{"title":"/v1/documents/policies","summary":"List policy documents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/paths/~1v1~1documents~1policies/get","deprecated":false},{"title":"/v1/documents/policies","summary":"Upload policy document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/paths/~1v1~1documents~1policies/post","deprecated":false},{"title":"/v1/documents/{id}/client","summary":"Update client document","prefix":{"name":"put","color":"put"},"badges":[],"link":"/documents/paths/~1v1~1documents~1{id}~1client/put","deprecated":false},{"title":"/v1/documents/{id}/client","summary":"Delete client document","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/documents/deleteclientdocument","deprecated":false},{"title":"/v1/documents/{id}/client/download","summary":"Download client document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/paths/~1v1~1documents~1{id}~1client~1download/get","deprecated":false},{"title":"/v1/documents/{id}/policy","summary":"Update policy document","prefix":{"name":"put","color":"put"},"badges":[],"link":"/documents/paths/~1v1~1documents~1{id}~1policy/put","deprecated":false},{"title":"/v1/documents/{id}/policy","summary":"Delete policy document","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/documents/deletepolicydocument","deprecated":false},{"title":"/v1/documents/{id}/policy/download","summary":"Download policy document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/paths/~1v1~1documents~1{id}~1policy~1download/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Drivers","link":"/apis/meshvi/drivers","routeSlug":"/apis/meshvi/drivers","items":[{"label":"Search drivers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/drivers/paths/~1v1~1drivers/get","routeSlug":"/apis/meshvi/drivers/paths/~1v1~1drivers/get","metadata":{"seo":{"title":"Search drivers","description":"Paginated search of drivers with filtering and sorting. Supports query parameters for pagination, sorting, and filtering by client, status, license, and search text."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Search drivers","isWebhook":false,"pointer":"/paths/~1v1~1drivers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search drivers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginated search of drivers with filtering and sorting. Supports query parameters for pagination, sorting, and filtering by client, status, license, and search text."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_40","description":"Page number (1-based)."},{"name":"limit","in":"query","schemaId":"schema_41","description":"Items per page (1-1000)."},{"name":"sort","in":"query","schemaId":"schema_42","description":"Sort field with optional '-' prefix for descending (e.g. -firstName, lastName, license, status)."},{"name":"q","in":"query","schemaId":"schema_42","description":"Search text for fuzzy matching across name, license, and other fields."},{"name":"license","in":"query","schemaId":"schema_42","description":"Filter by driver license number (partial match)."},{"name":"clientId","in":"query","schemaId":"schema_34","description":"Filter by client ID."},{"name":"driverStatus","in":"query","schemaId":"schema_51","description":"Filter by driver status: active, notActive, pending."}],"pointer":"/paths/~1v1~1drivers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/drivers","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_40"},{"name":"limit","in":"query","schemaId":"schema_41"},{"name":"sort","in":"query","schemaId":"schema_42"},{"name":"q","in":"query","schemaId":"schema_42"},{"name":"license","in":"query","schemaId":"schema_42"},{"name":"clientId","in":"query","schemaId":"schema_34"},{"name":"driverStatus","in":"query","schemaId":"schema_51"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/drivers","href":"drivers/paths/~1v1~1drivers/get","summary":"Search drivers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of drivers."},{"code":"400","description":"Invalid query parameters."},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v1~1drivers/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drivers/paths/~1v1~1drivers/get"}],"panels":[]}]},"httpPath":"/v1/drivers"},{"label":"Create driver","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/drivers/paths/~1v1~1drivers/post","routeSlug":"/apis/meshvi/drivers/paths/~1v1~1drivers/post","metadata":{"seo":{"title":"Create driver","description":"Creates a new driver. Required: clientId, firstName, lastName, driverType. Date fields use MM-dd-yyyy format. Name-based fields (state, city, driverType, dlType) are resolved to IDs via master data lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create driver","isWebhook":false,"pointer":"/paths/~1v1~1drivers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create driver","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new driver. Required: clientId, firstName, lastName, driverType. Date fields use MM-dd-yyyy format. Name-based fields (state, city, driverType, dlType) are resolved to IDs via master data lookup."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_52"}},"schemaId":"schema_52","pointer":"/paths/~1v1~1drivers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/drivers","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_52"}},"responseCodes":["201","400","401","403"],"pointer":"/v1/drivers","href":"drivers/paths/~1v1~1drivers/post","summary":"Create driver"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_52","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_52"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Driver created successfully."},{"code":"400","description":"Invalid request data or validation errors."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - token not authorized for the specified clientId."}],"pointer":"/paths/~1v1~1drivers/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drivers/paths/~1v1~1drivers/post"}],"panels":[]}]},"httpPath":"/v1/drivers"},{"label":"Search drivers (legacy POST)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/drivers/paths/~1v1~1drivers~1search/post","routeSlug":"/apis/meshvi/drivers/paths/~1v1~1drivers~1search/post","metadata":{"seo":{"title":"Search drivers (legacy POST)","description":"Paginated driver search using the legacy CommonPagingFilterRequest body (pageIndex, pageSize, sortBy, sortOrder, filter). Prefer GET /v1/drivers for new integrations; this endpoint remains for backward compatibility. Requires [APIAuthorize] with Driver View access at client scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Search drivers (legacy POST)","isWebhook":false,"pointer":"/paths/~1v1~1drivers~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search drivers (legacy POST)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paginated driver search using the legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CommonPagingFilterRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body (pageIndex, pageSize, sortBy, sortOrder, filter). Prefer GET "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/drivers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new integrations; this endpoint remains for backward compatibility. Requires [APIAuthorize] with Driver View access at client scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53","pointer":"/paths/~1v1~1drivers~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/drivers/search","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_53"}},"responseCodes":["200","400","401"],"pointer":"/v1/drivers/search","href":"drivers/paths/~1v1~1drivers~1search/post","summary":"Search drivers (legacy POST)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_53"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Driver list wrapped in ApiResponse with paging container.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54"},{"code":"400","description":"Invalid request body."},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v1~1drivers~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drivers/paths/~1v1~1drivers~1search/post"}],"panels":[]}]},"httpPath":"/v1/drivers/search"},{"label":"Get driver detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/drivers/paths/~1v1~1drivers~1{id}/get","routeSlug":"/apis/meshvi/drivers/paths/~1v1~1drivers~1{id}/get","metadata":{"seo":{"title":"Get driver detail","description":"Retrieves driver details by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get driver detail","isWebhook":false,"pointer":"/paths/~1v1~1drivers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get driver detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves driver details by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_45","description":"Driver identifier.","required":true}],"pointer":"/paths/~1v1~1drivers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/drivers/{id}","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_45"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v1/drivers/{id}","href":"drivers/paths/~1v1~1drivers~1{id}/get","summary":"Get driver detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Driver details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverDetail","exampleIds":["paths/~1v1~1drivers~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/DriverDetail","exampleIds":["paths/~1v1~1drivers~1{id}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid driver id."},{"code":"401","description":"Unauthorized."},{"code":"404","description":"Driver not found."}],"pointer":"/paths/~1v1~1drivers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DriverDetail","exampleIds":["paths/~1v1~1drivers~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DriverDetail","exampleIds":["paths/~1v1~1drivers~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drivers/paths/~1v1~1drivers~1{id}/get"}],"panels":[]}]},"httpPath":"/v1/drivers/{id}"},{"label":"Update driver","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/drivers/paths/~1v1~1drivers~1{id}/put","routeSlug":"/apis/meshvi/drivers/paths/~1v1~1drivers~1{id}/put","metadata":{"seo":{"title":"Update driver","description":"Updates an existing driver. Uses the same request body as create. Only provided fields are updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update driver","isWebhook":false,"pointer":"/paths/~1v1~1drivers~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update driver","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing driver. Uses the same request body as create. Only provided fields are updated."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_45","description":"Driver identifier.","required":true}],"pointer":"/paths/~1v1~1drivers~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_55"}},"schemaId":"schema_55","pointer":"/paths/~1v1~1drivers~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/drivers/{id}","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_45"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_55"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/drivers/{id}","href":"drivers/paths/~1v1~1drivers~1{id}/put","summary":"Update driver"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_55","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_55"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Driver updated successfully."},{"code":"400","description":"Invalid request data or validation errors."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - token not authorized for the specified driver."},{"code":"404","description":"Driver not found."}],"pointer":"/paths/~1v1~1drivers~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drivers/paths/~1v1~1drivers~1{id}/put"}],"panels":[]}]},"httpPath":"/v1/drivers/{id}"},{"label":"Associate driver to vehicle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/drivers/associatedrivertovehicle","routeSlug":"/apis/meshvi/drivers/associatedrivertovehicle","metadata":{"seo":{"title":"Associate driver to vehicle","description":"Associates an existing driver with the specified vehicle, or creates a new driver and associates them. If driverId is provided (>0), the driver must exist. If driverId is 0, firstName and lastName are required to create a new driver."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"associateDriverToVehicle","name":"Associate driver to vehicle","isWebhook":false,"pointer":"/paths/~1v1~1drivers~1vehicles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Associate driver to vehicle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associates an existing driver with the specified vehicle, or creates a new driver and associates them. If driverId is provided (>0), the driver must exist. If driverId is 0, firstName and lastName are required to create a new driver."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56","pointer":"/paths/~1v1~1drivers~1vehicles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/drivers/vehicles","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_56"}},"responseCodes":["200","400","401","403"],"pointer":"/v1/drivers/vehicles","href":"drivers/associatedrivertovehicle","openApiOperationId":"associateDriverToVehicle","summary":"Associate driver to vehicle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Driver associated with vehicle successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssociateDriverToVehicleResponse"}},"schemaId":"components/schemas/AssociateDriverToVehicleResponse"},{"code":"400","description":"Invalid request (e.g. vehicleId or driver required, invalid IDs)."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - not authorized for the vehicle."}],"pointer":"/paths/~1v1~1drivers~1vehicles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AssociateDriverToVehicleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AssociateDriverToVehicleResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drivers/associatedrivertovehicle"}],"panels":[]}]},"httpPath":"/v1/drivers/vehicles"},{"label":"Assign driver coverage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/drivers/assigndrivercoverage","routeSlug":"/apis/meshvi/drivers/assigndrivercoverage","metadata":{"seo":{"title":"Assign driver coverage","description":"Assigns a driver to an OA or DD policy coverage (sponsored scheduled driver). Requires Driver Create/Edit. For active policies, provide policyAddedDate; for future policies the server uses the policy effective date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assignDriverCoverage","name":"Assign driver coverage","isWebhook":false,"pointer":"/paths/~1v1~1drivers~1coverages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign driver coverage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigns a driver to an OA or DD policy coverage (sponsored scheduled driver). Requires Driver "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For active policies, provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"policyAddedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; for future policies the server uses the policy effective date."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssignDriverCoverageRequest"}},"schemaId":"components/schemas/AssignDriverCoverageRequest","pointer":"/paths/~1v1~1drivers~1coverages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/drivers/coverages","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssignDriverCoverageRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/drivers/coverages","href":"drivers/assigndrivercoverage","openApiOperationId":"assignDriverCoverage","summary":"Assign driver coverage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"components/schemas/AssignDriverCoverageRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssignDriverCoverageRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Coverage assigned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseAssignDriverCoverage"}},"schemaId":"components/schemas/ApiResponseAssignDriverCoverage"},{"code":"400","description":"Invalid request or business validation failure."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - not authorized for the driver."},{"code":"404","description":"Driver or policy not found."},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1drivers~1coverages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseAssignDriverCoverage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseAssignDriverCoverage"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drivers/assigndrivercoverage"}],"panels":[]}]},"httpPath":"/v1/drivers/coverages"},{"label":"Update driver coverage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/drivers/updatedrivercoverage","routeSlug":"/apis/meshvi/drivers/updatedrivercoverage","metadata":{"seo":{"title":"Update driver coverage","description":"Updates an already-assigned driver OA/DD coverage. coverageStatus: 1 = response needed (remove), 2 = coverage declined, 7 = sponsored scheduled driver (change policy added date). Status 4 is not valid for drivers. Requires Driver Create/Edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDriverCoverage","name":"Update driver coverage","isWebhook":false,"pointer":"/paths/~1v1~1drivers~1coverages/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update driver coverage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an already-assigned driver OA/DD coverage. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coverageStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = response needed (remove), "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = coverage declined, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = sponsored scheduled driver (change policy added date). Status "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not valid for drivers. Requires Driver "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDriverCoverageRequest"}},"schemaId":"components/schemas/UpdateDriverCoverageRequest","pointer":"/paths/~1v1~1drivers~1coverages/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/drivers/coverages","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateDriverCoverageRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/drivers/coverages","href":"drivers/updatedrivercoverage","openApiOperationId":"updateDriverCoverage","summary":"Update driver coverage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"components/schemas/UpdateDriverCoverageRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDriverCoverageRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Coverage updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseUpdateDriverCoverage"}},"schemaId":"components/schemas/ApiResponseUpdateDriverCoverage"},{"code":"400","description":"Invalid request or business validation failure."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - not authorized for the driver."},{"code":"404","description":"Driver or policy not found."},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1drivers~1coverages/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseUpdateDriverCoverage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseUpdateDriverCoverage"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drivers/updatedrivercoverage"}],"panels":[]}]},"httpPath":"/v1/drivers/coverages"}],"content":{"contentType":"group","meta":{"name":"Drivers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Drivers","showPageActions":true},{"nodeType":"markdoc","content":"Driver CRUD, search, vehicle association, and OA/DD coverage assignment."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/drivers","summary":"Search drivers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/drivers/paths/~1v1~1drivers/get","deprecated":false},{"title":"/v1/drivers","summary":"Create driver","prefix":{"name":"post","color":"post"},"badges":[],"link":"/drivers/paths/~1v1~1drivers/post","deprecated":false},{"title":"/v1/drivers/search","summary":"Search drivers (legacy POST)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/drivers/paths/~1v1~1drivers~1search/post","deprecated":false},{"title":"/v1/drivers/{id}","summary":"Get driver detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/drivers/paths/~1v1~1drivers~1{id}/get","deprecated":false},{"title":"/v1/drivers/{id}","summary":"Update driver","prefix":{"name":"put","color":"put"},"badges":[],"link":"/drivers/paths/~1v1~1drivers~1{id}/put","deprecated":false},{"title":"/v1/drivers/vehicles","summary":"Associate driver to vehicle","prefix":{"name":"post","color":"post"},"badges":[],"link":"/drivers/associatedrivertovehicle","deprecated":false},{"title":"/v1/drivers/coverages","summary":"Assign driver coverage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/drivers/assigndrivercoverage","deprecated":false},{"title":"/v1/drivers/coverages","summary":"Update driver coverage","prefix":{"name":"put","color":"put"},"badges":[],"link":"/drivers/updatedrivercoverage","deprecated":false}]}]}]}]}},{"type":"group","label":"Policies","link":"/apis/meshvi/policies","routeSlug":"/apis/meshvi/policies","items":[{"label":"Search policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/policies/paths/~1v1~1policies/get","routeSlug":"/apis/meshvi/policies/paths/~1v1~1policies/get","metadata":{"seo":{"title":"Search policies","description":"Paginated search of policies. Query params: page, limit, sort, q, policy, clientId, deleted, status, coverageType."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Search policies","isWebhook":false,"pointer":"/paths/~1v1~1policies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search policies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginated search of policies. Query params: page, limit, sort, q, policy, clientId, deleted, status, coverageType."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_40"},{"name":"limit","in":"query","schemaId":"schema_41"},{"name":"sort","in":"query","schemaId":"schema_42"},{"name":"q","in":"query","schemaId":"schema_42","description":"Search text."},{"name":"policy","in":"query","schemaId":"schema_42","description":"Policy number filter."},{"name":"clientId","in":"query","schemaId":"schema_34"},{"name":"deleted","in":"query","schemaId":"schema_43"},{"name":"status","in":"query","schemaId":"schema_42","description":"all, active, cancelled, future, expired."},{"name":"coverageType","in":"query","schemaId":"schema_42","description":"PD, NT, OA, PA, CG, AL, GL, WC, TI, DD, VD."}],"pointer":"/paths/~1v1~1policies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/policies","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_40"},{"name":"limit","in":"query","schemaId":"schema_41"},{"name":"sort","in":"query","schemaId":"schema_42"},{"name":"q","in":"query","schemaId":"schema_42"},{"name":"policy","in":"query","schemaId":"schema_42"},{"name":"clientId","in":"query","schemaId":"schema_34"},{"name":"deleted","in":"query","schemaId":"schema_43"},{"name":"status","in":"query","schemaId":"schema_42"},{"name":"coverageType","in":"query","schemaId":"schema_42"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/policies","href":"policies/paths/~1v1~1policies/get","summary":"Search policies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of policies."},{"code":"400","description":"Invalid query parameters."},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v1~1policies/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policies/paths/~1v1~1policies/get"}],"panels":[]}]},"httpPath":"/v1/policies"},{"label":"Create policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/policies/paths/~1v1~1policies/post","routeSlug":"/apis/meshvi/policies/paths/~1v1~1policies/post","metadata":{"seo":{"title":"Create policy","description":"Creates a new policy. Required: clientId, effectiveDate, expirationDate, and either coverageType or fullCoverageTypeName. Name-based fields (insurerName, stateName, producerName, etc.) are resolved to IDs via master data lookup. The token must be authorized for the specified clientId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create policy","isWebhook":false,"pointer":"/paths/~1v1~1policies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new policy. Required: clientId, effectiveDate, expirationDate, and either coverageType or fullCoverageTypeName. Name-based fields (insurerName, stateName, producerName, etc.) are resolved to IDs via master data lookup. The token must be authorized for the specified clientId."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57","pointer":"/paths/~1v1~1policies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/policies","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_57"}},"responseCodes":["201","400","401","403"],"pointer":"/v1/policies","href":"policies/paths/~1v1~1policies/post","summary":"Create policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Policy created successfully."},{"code":"400","description":"Invalid request data or validation errors (e.g. clientId mandatory, invalid coverageType, expirationDate before effectiveDate)."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - token not authorized for the specified clientId."}],"pointer":"/paths/~1v1~1policies/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policies/paths/~1v1~1policies/post"}],"panels":[]}]},"httpPath":"/v1/policies"},{"label":"Search policies (legacy POST)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/policies/paths/~1v1~1policies~1search/post","routeSlug":"/apis/meshvi/policies/paths/~1v1~1policies~1search/post","metadata":{"seo":{"title":"Search policies (legacy POST)","description":"Paginated policy search using the legacy CommonPagingFilterRequest body (pageIndex, pageSize, sortBy, sortOrder, filter). Prefer GET /v1/policies for new integrations; this endpoint remains for backward compatibility. Requires [APIAuthorize] with Policy View access at client scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Search policies (legacy POST)","isWebhook":false,"pointer":"/paths/~1v1~1policies~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search policies (legacy POST)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paginated policy search using the legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CommonPagingFilterRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body (pageIndex, pageSize, sortBy, sortOrder, filter). Prefer GET "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1/policies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new integrations; this endpoint remains for backward compatibility. Requires [APIAuthorize] with Policy View access at client scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_58"}},"schemaId":"schema_58","pointer":"/paths/~1v1~1policies~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/policies/search","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_58"}},"responseCodes":["200","400","401"],"pointer":"/v1/policies/search","href":"policies/paths/~1v1~1policies~1search/post","summary":"Search policies (legacy POST)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_58","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_58"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Policy list wrapped in ApiResponse with paging container.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54"},{"code":"400","description":"Invalid request body."},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v1~1policies~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policies/paths/~1v1~1policies~1search/post"}],"panels":[]}]},"httpPath":"/v1/policies/search"},{"label":"Get policy detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/policies/paths/~1v1~1policies~1{id}/get","routeSlug":"/apis/meshvi/policies/paths/~1v1~1policies~1{id}/get","metadata":{"seo":{"title":"Get policy detail","description":"Retrieves policy details by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get policy detail","isWebhook":false,"pointer":"/paths/~1v1~1policies~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get policy detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves policy details by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_45","description":"Policy identifier.","required":true}],"pointer":"/paths/~1v1~1policies~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/policies/{id}","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_45"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v1/policies/{id}","href":"policies/paths/~1v1~1policies~1{id}/get","summary":"Get policy detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Policy details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PolicyDetail","exampleIds":["paths/~1v1~1policies~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PolicyDetail","exampleIds":["paths/~1v1~1policies~1{id}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request."},{"code":"401","description":"Unauthorized."},{"code":"404","description":"Policy not found."},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1policies~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PolicyDetail","exampleIds":["paths/~1v1~1policies~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PolicyDetail","exampleIds":["paths/~1v1~1policies~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policies/paths/~1v1~1policies~1{id}/get"}],"panels":[]}]},"httpPath":"/v1/policies/{id}"},{"label":"Update policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/policies/paths/~1v1~1policies~1{id}/put","routeSlug":"/apis/meshvi/policies/paths/~1v1~1policies~1{id}/put","metadata":{"seo":{"title":"Update policy","description":"Updates an existing policy. Only properties present in the request body are updated (partial update). Supports the same fields as create. Name-based fields are resolved via master data lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update policy","isWebhook":false,"pointer":"/paths/~1v1~1policies~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing policy. Only properties present in the request body are updated (partial update). Supports the same fields as create. Name-based fields are resolved via master data lookup."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_45","description":"Policy identifier.","required":true}],"pointer":"/paths/~1v1~1policies~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"schemaId":"schema_59","pointer":"/paths/~1v1~1policies~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/policies/{id}","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_45"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_59"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/policies/{id}","href":"policies/paths/~1v1~1policies~1{id}/put","summary":"Update policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_59","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Policy updated successfully."},{"code":"400","description":"Invalid request data or validation errors."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - token not authorized for the specified policy."},{"code":"404","description":"Policy not found."}],"pointer":"/paths/~1v1~1policies~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policies/paths/~1v1~1policies~1{id}/put"}],"panels":[]}]},"httpPath":"/v1/policies/{id}"},{"label":"Get policy vehicles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/policies/paths/~1v1~1policies~1{id}~1vehicles/get","routeSlug":"/apis/meshvi/policies/paths/~1v1~1policies~1{id}~1vehicles/get","metadata":{"seo":{"title":"Get policy vehicles","description":"Retrieves a paginated list of vehicles associated with a policy. Supports optional filters for make, value, and status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get policy vehicles","isWebhook":false,"pointer":"/paths/~1v1~1policies~1{id}~1vehicles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get policy vehicles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a paginated list of vehicles associated with a policy. Supports optional filters for make, value, and status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_45","description":"Policy identifier.","required":true}],"pointer":"/paths/~1v1~1policies~1{id}~1vehicles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_40","description":"Page number (1-based)."},{"name":"limit","in":"query","schemaId":"schema_41","description":"Items per page."},{"name":"make","in":"query","schemaId":"schema_34","description":"Filter by make ID."},{"name":"makeName","in":"query","schemaId":"schema_35","description":"Filter by make name (e.g. 'Freightliner'). Resolved to make ID via lookup."},{"name":"value","in":"query","schemaId":"schema_60","description":"Filter by vehicle value."},{"name":"status","in":"query","schemaId":"schema_34","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by vehicle status ID (0 = Not Active, 1 = Active, 2 = Pending)."},"children":[]}]}]}]},{"name":"statusName","in":"query","schemaId":"schema_35","description":"Filter by vehicle status name: Active, Pending, Not Active. Resolved to status ID."}],"pointer":"/paths/~1v1~1policies~1{id}~1vehicles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/policies/{id}/vehicles","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_45"}],"query":[{"name":"page","in":"query","schemaId":"schema_40"},{"name":"limit","in":"query","schemaId":"schema_41"},{"name":"make","in":"query","schemaId":"schema_34"},{"name":"makeName","in":"query","schemaId":"schema_35"},{"name":"value","in":"query","schemaId":"schema_60"},{"name":"status","in":"query","schemaId":"schema_34"},{"name":"statusName","in":"query","schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v1/policies/{id}/vehicles","href":"policies/paths/~1v1~1policies~1{id}~1vehicles/get","summary":"Get policy vehicles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of vehicles for the policy."},{"code":"400","description":"Invalid policy id or query parameters."},{"code":"401","description":"Unauthorized."},{"code":"404","description":"Policy not found."}],"pointer":"/paths/~1v1~1policies~1{id}~1vehicles/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/policies/paths/~1v1~1policies~1{id}~1vehicles/get"}],"panels":[]}]},"httpPath":"/v1/policies/{id}/vehicles"}],"content":{"contentType":"group","meta":{"name":"Policies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Policies","showPageActions":true},{"nodeType":"markdoc","content":"Policy CRUD, search, and related vehicles."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/policies","summary":"Search policies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/policies/paths/~1v1~1policies/get","deprecated":false},{"title":"/v1/policies","summary":"Create policy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/policies/paths/~1v1~1policies/post","deprecated":false},{"title":"/v1/policies/search","summary":"Search policies (legacy POST)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/policies/paths/~1v1~1policies~1search/post","deprecated":false},{"title":"/v1/policies/{id}","summary":"Get policy detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/policies/paths/~1v1~1policies~1{id}/get","deprecated":false},{"title":"/v1/policies/{id}","summary":"Update policy","prefix":{"name":"put","color":"put"},"badges":[],"link":"/policies/paths/~1v1~1policies~1{id}/put","deprecated":false},{"title":"/v1/policies/{id}/vehicles","summary":"Get policy vehicles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/policies/paths/~1v1~1policies~1{id}~1vehicles/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Vehicles","link":"/apis/meshvi/vehicles","routeSlug":"/apis/meshvi/vehicles","items":[{"label":"Get Vehicle Certificate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/vehicles/paths/~1v1~1certificates~1vehicles/get","routeSlug":"/apis/meshvi/vehicles/paths/~1v1~1certificates~1vehicles/get","metadata":{"seo":{"title":"Get Vehicle Certificate","description":"Retrieves the Acord certificate for a vehicle. Provide exactly one of: id, vin, or licensePlate. clientId may be used in some contexts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Vehicle Certificate","isWebhook":false,"pointer":"/paths/~1v1~1certificates~1vehicles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Vehicle Certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the Acord certificate for a vehicle. Provide exactly one of: id, vin, or licensePlate. clientId may be used in some contexts."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_34","description":"Vehicle ID."},{"name":"vin","in":"query","schemaId":"schema_38","description":"VIN (17 characters)."},{"name":"licensePlate","in":"query","schemaId":"schema_35","description":"License plate number."},{"name":"clientId","in":"query","schemaId":"schema_34","description":"Client ID (optional context)."}],"pointer":"/paths/~1v1~1certificates~1vehicles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/certificates/vehicles","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","schemaId":"schema_34"},{"name":"vin","in":"query","schemaId":"schema_38"},{"name":"licensePlate","in":"query","schemaId":"schema_35"},{"name":"clientId","in":"query","schemaId":"schema_34"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/certificates/vehicles","href":"vehicles/paths/~1v1~1certificates~1vehicles/get","summary":"Get Vehicle Certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Certificate data returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39"},{"code":"400","description":"Bad Request."},{"code":"401","description":"Unauthorized."},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1certificates~1vehicles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"400"},{"code":"401"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vehicles/paths/~1v1~1certificates~1vehicles/get"}],"panels":[]}]},"httpPath":"/v1/certificates/vehicles"},{"label":"Search vehicles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/vehicles/paths/~1v1~1vehicles/get","routeSlug":"/apis/meshvi/vehicles/paths/~1v1~1vehicles/get","metadata":{"seo":{"title":"Search vehicles","description":"Paginated search of vehicles with filtering and sorting. Supports query parameters for pagination, sorting, and filtering by VIN, unit, make, owner, garaging address, value, and status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Search vehicles","isWebhook":false,"pointer":"/paths/~1v1~1vehicles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search vehicles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginated search of vehicles with filtering and sorting. Supports query parameters for pagination, sorting, and filtering by VIN, unit, make, owner, garaging address, value, and status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_40","description":"Page number (1-based)."},{"name":"limit","in":"query","schemaId":"schema_41","description":"Items per page (1-1000)."},{"name":"sort","in":"query","schemaId":"schema_42","description":"Sort field with optional '-' prefix for descending (e.g. -unit, vin, make, value)."},{"name":"q","in":"query","schemaId":"schema_42","description":"Search text (searches across VIN, unit, make, owner, garaging address)."},{"name":"vin","in":"query","schemaId":"schema_42","description":"Filter by VIN (partial match)."},{"name":"unit","in":"query","schemaId":"schema_42","description":"Filter by unit number (partial match)."},{"name":"make","in":"query","schemaId":"schema_42","description":"Filter by make/manufacturer name (partial match)."},{"name":"owner","in":"query","schemaId":"schema_42","description":"Filter by owner name (partial match)."},{"name":"garagingAddress","in":"query","schemaId":"schema_42","description":"Filter by garaging address (partial match)."},{"name":"value","in":"query","schemaId":"schema_42","description":"Filter by minimum vehicle value."},{"name":"status","in":"query","schemaId":"schema_61","description":"Filter by vehicle status: Active, NotActive, Pending."}],"pointer":"/paths/~1v1~1vehicles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/vehicles","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_40"},{"name":"limit","in":"query","schemaId":"schema_41"},{"name":"sort","in":"query","schemaId":"schema_42"},{"name":"q","in":"query","schemaId":"schema_42"},{"name":"vin","in":"query","schemaId":"schema_42"},{"name":"unit","in":"query","schemaId":"schema_42"},{"name":"make","in":"query","schemaId":"schema_42"},{"name":"owner","in":"query","schemaId":"schema_42"},{"name":"garagingAddress","in":"query","schemaId":"schema_42"},{"name":"value","in":"query","schemaId":"schema_42"},{"name":"status","in":"query","schemaId":"schema_61"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v1/vehicles","href":"vehicles/paths/~1v1~1vehicles/get","summary":"Search vehicles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of vehicles."},{"code":"400","description":"Invalid query parameters."},{"code":"401","description":"Unauthorized."}],"pointer":"/paths/~1v1~1vehicles/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vehicles/paths/~1v1~1vehicles/get"}],"panels":[]}]},"httpPath":"/v1/vehicles"},{"label":"Create vehicle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/vehicles/paths/~1v1~1vehicles/post","routeSlug":"/apis/meshvi/vehicles/paths/~1v1~1vehicles/post","metadata":{"seo":{"title":"Create vehicle","description":"Creates a new vehicle. Required: clientId, unitType/unitTypeName, unit, modelYear, makes/makeCompanyName, serialNumber (VIN, 17 characters). Name-based fields are resolved to IDs via master data lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create vehicle","isWebhook":false,"pointer":"/paths/~1v1~1vehicles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create vehicle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new vehicle. Required: clientId, unitType/unitTypeName, unit, modelYear, makes/makeCompanyName, serialNumber (VIN, 17 characters). Name-based fields are resolved to IDs via master data lookup."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62","pointer":"/paths/~1v1~1vehicles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/vehicles","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_62"}},"responseCodes":["201","400","401","403"],"pointer":"/v1/vehicles","href":"vehicles/paths/~1v1~1vehicles/post","summary":"Create vehicle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_62"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Vehicle created successfully."},{"code":"400","description":"Invalid request data or validation errors."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - token not authorized for the specified clientId."}],"pointer":"/paths/~1v1~1vehicles/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vehicles/paths/~1v1~1vehicles/post"}],"panels":[]}]},"httpPath":"/v1/vehicles"},{"label":"Get vehicle detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/vehicles/paths/~1v1~1vehicles~1{id}/get","routeSlug":"/apis/meshvi/vehicles/paths/~1v1~1vehicles~1{id}/get","metadata":{"seo":{"title":"Get vehicle detail","description":"Retrieves complete vehicle details by ID including driver assignments, coverage types, policy associations, lienholder information, billing details, and audit information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get vehicle detail","isWebhook":false,"pointer":"/paths/~1v1~1vehicles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get vehicle detail","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves complete vehicle details by ID including driver assignments, coverage types, policy associations, lienholder information, billing details, and audit information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_63","description":"Vehicle identifier.","required":true}],"pointer":"/paths/~1v1~1vehicles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/vehicles/{id}","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v1/vehicles/{id}","href":"vehicles/paths/~1v1~1vehicles~1{id}/get","summary":"Get vehicle detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Vehicle details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleDetail","exampleIds":["paths/~1v1~1vehicles~1{id}/get/responses/200/content/application~1json/examples/vehicleDetail"]}},"schemaId":"components/schemas/VehicleDetail","exampleIds":["paths/~1v1~1vehicles~1{id}/get/responses/200/content/application~1json/examples/vehicleDetail"]},{"code":"400","description":"Invalid id."},{"code":"401","description":"Unauthorized."},{"code":"404","description":"Vehicle not found or access denied."}],"pointer":"/paths/~1v1~1vehicles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VehicleDetail","exampleIds":["paths/~1v1~1vehicles~1{id}/get/responses/200/content/application~1json/examples/vehicleDetail"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VehicleDetail","exampleIds":["paths/~1v1~1vehicles~1{id}/get/responses/200/content/application~1json/examples/vehicleDetail"]}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vehicles/paths/~1v1~1vehicles~1{id}/get"}],"panels":[]}]},"httpPath":"/v1/vehicles/{id}"},{"label":"Update vehicle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/vehicles/paths/~1v1~1vehicles~1{id}/put","routeSlug":"/apis/meshvi/vehicles/paths/~1v1~1vehicles~1{id}/put","metadata":{"seo":{"title":"Update vehicle","description":"Updates an existing vehicle. Only provided fields are updated (partial update). Name-based fields (makeCompanyName, unitTypeName, licensePlateStateName) are resolved to IDs via master data lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update vehicle","isWebhook":false,"pointer":"/paths/~1v1~1vehicles~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update vehicle","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing vehicle. Only provided fields are updated (partial update). Name-based fields (makeCompanyName, unitTypeName, licensePlateStateName) are resolved to IDs via master data lookup."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_45","description":"Vehicle identifier.","required":true}],"pointer":"/paths/~1v1~1vehicles~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_64"}},"schemaId":"schema_64","pointer":"/paths/~1v1~1vehicles~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/vehicles/{id}","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_45"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_64"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/vehicles/{id}","href":"vehicles/paths/~1v1~1vehicles~1{id}/put","summary":"Update vehicle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"schema_64","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_64"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Vehicle updated successfully."},{"code":"400","description":"Invalid request data or validation errors."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - token not authorized for the specified vehicle."},{"code":"404","description":"Vehicle not found."}],"pointer":"/paths/~1v1~1vehicles~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vehicles/paths/~1v1~1vehicles~1{id}/put"}],"panels":[]}]},"httpPath":"/v1/vehicles/{id}"},{"label":"Assign vehicle coverage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/vehicles/assignvehiclecoverage","routeSlug":"/apis/meshvi/vehicles/assignvehiclecoverage","metadata":{"seo":{"title":"Assign vehicle coverage","description":"Assigns a vehicle to an existing policy as a scheduled unit coverage. Requires Vehicle Create/Edit. For active policies, provide policyAddedDate; for future policies the server uses the policy effective date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assignVehicleCoverage","name":"Assign vehicle coverage","isWebhook":false,"pointer":"/paths/~1v1~1vehicles~1coverages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign vehicle coverage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigns a vehicle to an existing policy as a scheduled unit coverage. Requires Vehicle "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For active policies, provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"policyAddedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; for future policies the server uses the policy effective date."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssignVehicleCoverageRequest"}},"schemaId":"components/schemas/AssignVehicleCoverageRequest","pointer":"/paths/~1v1~1vehicles~1coverages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/vehicles/coverages","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AssignVehicleCoverageRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/vehicles/coverages","href":"vehicles/assignvehiclecoverage","openApiOperationId":"assignVehicleCoverage","summary":"Assign vehicle coverage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"components/schemas/AssignVehicleCoverageRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AssignVehicleCoverageRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Coverage assigned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseAssignVehicleCoverage"}},"schemaId":"components/schemas/ApiResponseAssignVehicleCoverage"},{"code":"400","description":"Invalid request or business validation failure."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - not authorized for the vehicle."},{"code":"404","description":"Vehicle or policy not found."},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1vehicles~1coverages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseAssignVehicleCoverage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseAssignVehicleCoverage"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vehicles/assignvehiclecoverage"}],"panels":[]}]},"httpPath":"/v1/vehicles/coverages"},{"label":"Update vehicle coverage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/vehicles/updatevehiclecoverage","routeSlug":"/apis/meshvi/vehicles/updatevehiclecoverage","metadata":{"seo":{"title":"Update vehicle coverage","description":"Updates an already-assigned scheduled-unit vehicle coverage. coverageStatus: 1 = response needed (remove), 2 = coverage declined, 4 = sponsored scheduled unit (change policy added date). Requires Vehicle Create/Edit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateVehicleCoverage","name":"Update vehicle coverage","isWebhook":false,"pointer":"/paths/~1v1~1vehicles~1coverages/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update vehicle coverage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an already-assigned scheduled-unit vehicle coverage. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coverageStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = response needed (remove), "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = coverage declined, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = sponsored scheduled unit (change policy added date). Requires Vehicle "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create/Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateVehicleCoverageRequest"}},"schemaId":"components/schemas/UpdateVehicleCoverageRequest","pointer":"/paths/~1v1~1vehicles~1coverages/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/vehicles/coverages","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateVehicleCoverageRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/vehicles/coverages","href":"vehicles/updatevehiclecoverage","openApiOperationId":"updateVehicleCoverage","summary":"Update vehicle coverage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"schemaId":"components/schemas/UpdateVehicleCoverageRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateVehicleCoverageRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Coverage updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseUpdateVehicleCoverage"}},"schemaId":"components/schemas/ApiResponseUpdateVehicleCoverage"},{"code":"400","description":"Invalid request or business validation failure."},{"code":"401","description":"Unauthorized."},{"code":"403","description":"Forbidden - not authorized for the vehicle."},{"code":"404","description":"Vehicle or policy not found."},{"code":"500","description":"Internal server error."}],"pointer":"/paths/~1v1~1vehicles~1coverages/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiResponseUpdateVehicleCoverage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiResponseUpdateVehicleCoverage"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vehicles/updatevehiclecoverage"}],"panels":[]}]},"httpPath":"/v1/vehicles/coverages"},{"label":"Get vehicles by lienholder","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/vehicles/paths/~1v1~1vehicles~1lienholders~1{id}/get","routeSlug":"/apis/meshvi/vehicles/paths/~1v1~1vehicles~1lienholders~1{id}/get","metadata":{"seo":{"title":"Get vehicles by lienholder","description":"Retrieves lienholder detail with associated vehicles. Returns lienholder info (lienholderId, lienholderName, phone, address, agency, vehicleTotalCount, vehicleValueTotalCount, powerUnit, nonPowerUnit) plus vehicles array."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get vehicles by lienholder","isWebhook":false,"pointer":"/paths/~1v1~1vehicles~1lienholders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get vehicles by lienholder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves lienholder detail with associated vehicles. Returns lienholder info (lienholderId, lienholderName, phone, address, agency, vehicleTotalCount, vehicleValueTotalCount, powerUnit, nonPowerUnit) plus vehicles array."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_63","description":"Lienholder identifier.","required":true}],"pointer":"/paths/~1v1~1vehicles~1lienholders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/vehicles/lienholders/{id}","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_63"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v1/vehicles/lienholders/{id}","href":"vehicles/paths/~1v1~1vehicles~1lienholders~1{id}/get","summary":"Get vehicles by lienholder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Lienholder detail with vehicles array.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65"},{"code":"400","description":"Invalid lienholder ID."},{"code":"401","description":"Unauthorized."},{"code":"404","description":"Lienholder not found or access denied."}],"pointer":"/paths/~1v1~1vehicles~1lienholders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/vehicles/paths/~1v1~1vehicles~1lienholders~1{id}/get"}],"panels":[]}]},"httpPath":"/v1/vehicles/lienholders/{id}"}],"content":{"contentType":"group","meta":{"name":"Vehicles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Vehicles","showPageActions":true},{"nodeType":"markdoc","content":"Vehicle CRUD, search, certificate operations, and scheduled-unit coverage assignment."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/certificates/vehicles","summary":"Get Vehicle Certificate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vehicles/paths/~1v1~1certificates~1vehicles/get","deprecated":false},{"title":"/v1/vehicles","summary":"Search vehicles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vehicles/paths/~1v1~1vehicles/get","deprecated":false},{"title":"/v1/vehicles","summary":"Create vehicle","prefix":{"name":"post","color":"post"},"badges":[],"link":"/vehicles/paths/~1v1~1vehicles/post","deprecated":false},{"title":"/v1/vehicles/{id}","summary":"Get vehicle detail","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vehicles/paths/~1v1~1vehicles~1{id}/get","deprecated":false},{"title":"/v1/vehicles/{id}","summary":"Update vehicle","prefix":{"name":"put","color":"put"},"badges":[],"link":"/vehicles/paths/~1v1~1vehicles~1{id}/put","deprecated":false},{"title":"/v1/vehicles/coverages","summary":"Assign vehicle coverage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/vehicles/assignvehiclecoverage","deprecated":false},{"title":"/v1/vehicles/coverages","summary":"Update vehicle coverage","prefix":{"name":"put","color":"put"},"badges":[],"link":"/vehicles/updatevehiclecoverage","deprecated":false},{"title":"/v1/vehicles/lienholders/{id}","summary":"Get vehicles by lienholder","prefix":{"name":"get","color":"get"},"badges":[],"link":"/vehicles/paths/~1v1~1vehicles~1lienholders~1{id}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Reports","link":"/apis/meshvi/reports","routeSlug":"/apis/meshvi/reports","items":[{"label":"Get policy premium report raw data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/meshvi/reports/paths/~1v1~1reports~1{id}~1raw-data/get","routeSlug":"/apis/meshvi/reports/paths/~1v1~1reports~1{id}~1raw-data/get","metadata":{"seo":{"title":"Get policy premium report raw data","description":"Returns the template mapping payload (fixedData, tableData, premium mapping) for a policy premium report (Client.PolicyPremiumReport.id). Uses stored snapshot when available; otherwise computes mapping. Requires [APIAuthorize]; policy access is enforced via policy detail lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get policy premium report raw data","isWebhook":false,"pointer":"/paths/~1v1~1reports~1{id}~1raw-data/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get policy premium report raw data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the template mapping payload (fixedData, tableData, premium mapping) for a policy premium report ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client.PolicyPremiumReport.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Uses stored snapshot when available; otherwise computes mapping. Requires [APIAuthorize]; policy access is enforced via policy detail lookup."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"},{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_66","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Policy premium report ID ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Client.PolicyPremiumReport.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1reports~1{id}~1raw-data/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reports/{id}/raw-data","servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_66"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},{"id":"ApiKeyAuth","type":"apiKey","name":"apiKey","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v1/reports/{id}/raw-data","href":"reports/paths/~1v1~1reports~1{id}~1raw-data/get","summary":"Get policy premium report raw data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/meshvi","description":"Mock server","isMockServer":true},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report raw mapping data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_67"}},"schemaId":"schema_67"},{"code":"400","description":"Invalid report id."},{"code":"401","description":"Unauthorized."},{"code":"404","description":"Report not found."}],"pointer":"/paths/~1v1~1reports~1{id}~1raw-data/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_67","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_67"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reports/paths/~1v1~1reports~1{id}~1raw-data/get"}],"panels":[]}]},"httpPath":"/v1/reports/{id}/raw-data"}],"content":{"contentType":"group","meta":{"name":"Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Policy premium report raw data ([APIAuthorize])."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/reports/{id}/raw-data","summary":"Get policy premium report raw data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reports/paths/~1v1~1reports~1{id}~1raw-data/get","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CertificateVerificationResponse":{"id":"components/schemas/CertificateVerificationResponse","kind":"json-schema","title":"CertificateVerificationResponse","data":{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/CertificateVerificationResult"},{"$ref":"#/components/schemas/DotNotFoundResponse"}]}}}}},"components/schemas/CertificateVerificationResult":{"id":"components/schemas/CertificateVerificationResult","kind":"json-schema","title":"CertificateVerificationResult","data":{"type":"object","properties":{"dotNumber":{"type":"string","description":"Department of Transportation (DOT) number.","example":"123456"},"clients":{"type":"array","items":{"$ref":"#/components/schemas/ClientCOIInfo"}}}}},"components/schemas/ClientCOIInfo":{"id":"components/schemas/ClientCOIInfo","kind":"json-schema","title":"ClientCOIInfo","data":{"type":"object","properties":{"clientName":{"type":"string","example":"Example Trucking Co"},"clientId":{"type":"integer","example":1001},"certificateExists":{"type":"boolean","example":true},"policies":{"type":"array","items":{"$ref":"#/components/schemas/PolicyCOIInfo"}}}}},"components/schemas/PolicyCOIInfo":{"id":"components/schemas/PolicyCOIInfo","kind":"json-schema","title":"PolicyCOIInfo","data":{"type":"object","properties":{"policyNumber":{"type":"string","example":"POL-998877"},"coverageType":{"type":"string","example":"Auto Liability"},"coverageLimit":{"type":["integer","null"],"example":1000000},"effectiveDate":{"type":"string","format":"date-time","example":"2024-01-01T00:00:00Z"},"expirationDate":{"type":"string","format":"date-time","example":"2025-01-01T00:00:00Z"},"unitCoverages":{"$ref":"#/components/schemas/UnitCoverages"}}}},"components/schemas/UnitCoverages":{"id":"components/schemas/UnitCoverages","kind":"json-schema","title":"UnitCoverages","data":{"type":"object","properties":{"anyAuto":{"type":["boolean","null"],"example":true},"ownedAutoOnly":{"type":["boolean","null"],"example":false},"hiredAutosOnly":{"type":["boolean","null"],"example":false},"nonOwnedAutosOnly":{"type":["boolean","null"],"example":false},"scheduledAutos":{"type":["boolean","null"],"example":true}}}},"components/schemas/DotNotFoundResponse":{"id":"components/schemas/DotNotFoundResponse","kind":"json-schema","title":"DotNotFoundResponse","data":{"type":"object","properties":{"dotNumber":{"type":"string","example":"999999"},"message":{"type":"string","example":"DOT number not found"}}}},"components/schemas/ClientDetail":{"id":"components/schemas/ClientDetail","kind":"json-schema","title":"ClientDetail","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client details returned by GET /v1/clients/{id}."},"children":[]}]}]}],"properties":{"clientName":{"type":["string","null"],"description":"Client name."},"dbaName":{"type":["string","null"],"description":"DBA (Doing Business As) name."},"agencyName":{"type":["string","null"],"description":"Agency name."},"producerName":{"type":["string","null"],"description":"Producer name."},"description":{"type":["string","null"],"description":"Client description."},"dot":{"type":["string","null"],"description":"DOT number."},"address1":{"type":["string","null"],"description":"Primary address line 1."},"city":{"type":["string","null"],"description":"Primary city."},"state":{"type":["string","null"],"description":"Primary state."},"zip":{"type":["string","null"],"description":"Primary ZIP code."},"mailingAddress1":{"type":["string","null"],"description":"Mailing address line 1."},"mailingCity":{"type":["string","null"],"description":"Mailing city."},"mailingState":{"type":["string","null"],"description":"Mailing state."},"mailingZip":{"type":["string","null"],"description":"Mailing ZIP code."},"parentClient":{"type":["string","null"],"description":"Parent client name."},"csrEmail":{"type":["string","null"],"description":"CSR email address."}}}},"components/schemas/PolicyDetail":{"id":"components/schemas/PolicyDetail","kind":"json-schema","title":"PolicyDetail","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Policy details returned by GET /v1/policies/{id}."},"children":[]}]}]}],"properties":{"policyId":{"type":"integer","description":"Policy identifier."},"policy":{"type":["string","null"],"description":"Policy number."},"clientName":{"type":["string","null"],"description":"Client name."},"insurerName":{"type":["string","null"],"description":"Insurer name."},"insurerNAICNumber":{"type":["string","null"],"description":"Insurer NAIC number."},"coverageTypeText":{"type":["string","null"],"description":"Coverage type code."},"fullCoverageTypeName":{"type":["string","null"],"description":"Full coverage type name."},"policyTypeText":{"type":["string","null"],"description":"Policy type."},"contractNo":{"type":["string","null"],"description":"Contract number."},"accessPointName":{"type":["string","null"],"description":"Access point name."},"policyRenewedSourceText":{"type":["string","null"],"description":"Policy renewed source."},"effectiveDate":{"type":"string","format":"date-time","description":"Effective date."},"expirationDate":{"type":"string","format":"date-time","description":"Expiration date."},"status":{"type":["string","null"],"description":"Policy status."},"annualRate":{"type":["number","null"],"description":"Annual rate for power units."},"monthlyRate":{"type":["number","null"],"description":"Monthly rate for power units."},"nonPowerAnnualRate":{"type":["number","null"],"description":"Annual rate for non-power units."},"nonPowerMonthlyRate":{"type":["number","null"],"description":"Monthly rate for non-power units."},"deductibleAmount":{"type":["integer","null"],"description":"Deductible amount."},"deductibleType":{"type":["string","null"],"description":"Deductible type."},"billingRateType":{"type":["string","null"],"description":"Billing rate type."},"billingFrequency":{"type":["string","null"],"description":"Billing frequency."},"reportDay":{"type":["integer","null"],"description":"Report day of month."},"generatedDay":{"type":["integer","null"],"description":"Generated day of month."},"policyRenew":{"type":"boolean","description":"Policy renew flag."},"proRata":{"type":"boolean","description":"Pro rata billing."},"createdDate":{"type":"string","format":"date-time","description":"Created date."},"modifiedDate":{"type":"string","format":"date-time","description":"Modified date."},"createdBy":{"type":["string","null"],"description":"Created by user."},"modifiedBy":{"type":["string","null"],"description":"Modified by user."},"eachOccurrence":{"type":["integer","null"],"description":"Each occurrence limit."},"generalAggregate":{"type":["integer","null"],"description":"General aggregate limit."},"unitLimit":{"type":["integer","null"],"description":"Unit limit."},"policyLimit":{"type":["integer","null"],"description":"Policy limit."},"description":{"type":["string","null"],"description":"Policy description."},"taxRate":{"type":["number","null"],"description":"Tax rate percentage."},"numberOfInstallments":{"type":["integer","null"],"description":"Number of installments."},"depositPercentage":{"type":["number","null"],"description":"Deposit percentage."},"estimatedPremium":{"type":["number","null"],"description":"Estimated premium."},"stateName":{"type":["string","null"],"description":"State name."},"towingLimit":{"type":["number","null"],"description":"Towing limit."},"anyAuto":{"type":["boolean","null"],"description":"Any auto coverage."},"scheduledAutos":{"type":["boolean","null"],"description":"Scheduled autos coverage."},"minimumPremium":{"type":["number","null"],"description":"Minimum premium."}}}},"components/schemas/VehicleDetail":{"id":"components/schemas/VehicleDetail","kind":"json-schema","title":"VehicleDetail","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vehicle details returned by GET /v1/vehicles/{id}."},"children":[]}]}]}],"example":{"id":101,"vin":"1HGBH41JXMN109186","unit":"TRK-001","clientId":1,"clientName":"Acme Trucking LLC","make":"Freightliner","model":"Cascadia","modelYear":2024,"unitType":"Tractor","unitTypeId":1,"unitCategory":"Power Unit","value":125000,"futureValue":110000,"licensePlateNo":"TN-ABC123","licensePlateStateName":"Tennessee","garagingAddress":"123 Industrial Blvd, Nashville TN 37201","vehicleStatus":"Active","effectiveDate":"2024-01-01T00:00:00Z","vehicleNotes":"Primary highway tractor","certificateNotes":null,"gvwr":"80,000 lbs","mileage":45000,"billingValue":125000,"billingProRata":1,"createdDate":"2024-01-15T10:00:00Z","modifiedDate":"2024-06-01T14:30:00Z","createdBy":"admin@meshvi.com","modifiedBy":"admin@meshvi.com"},"properties":{"id":{"type":"integer","format":"int64","description":"Vehicle identifier."},"vin":{"type":["string","null"],"description":"Vehicle Identification Number."},"unit":{"type":["string","null"],"description":"Unit identifier/number."},"clientId":{"type":["integer","null"],"description":"Client (owner) identifier."},"clientName":{"type":["string","null"],"description":"Client name."},"make":{"type":["string","null"],"description":"Make/manufacturer."},"model":{"type":["string","null"],"description":"Model name."},"modelYear":{"type":["integer","null"],"description":"Model year."},"unitType":{"type":["string","null"],"description":"Unit type name."},"unitTypeId":{"type":["integer","null"],"description":"Unit type identifier."},"unitCategory":{"type":["string","null"],"description":"Unit category."},"value":{"type":["number","null"],"description":"Vehicle value."},"futureValue":{"type":["number","null"],"description":"Future value."},"licensePlateNo":{"type":["string","null"],"description":"License plate number."},"licensePlateStateName":{"type":["string","null"],"description":"License plate state."},"garagingAddress":{"type":["string","null"],"description":"Garaging address."},"vehicleStatus":{"type":["string","null"],"description":"Vehicle status: Active, Pending, Not Active."},"effectiveDate":{"type":["string","null"],"format":"date-time","description":"Effective date."},"vehicleNotes":{"type":["string","null"],"description":"Vehicle notes."},"certificateNotes":{"type":["string","null"],"description":"Certificate notes."},"gvwr":{"type":["string","null"],"description":"Gross vehicle weight rating."},"mileage":{"type":["integer","null"],"description":"Mileage."},"billingValue":{"type":["number","null"],"description":"Billing value."},"billingProRata":{"type":["number","null"],"description":"Billing pro rata."},"createdDate":{"type":"string","format":"date-time","description":"Created date."},"modifiedDate":{"type":"string","format":"date-time","description":"Modified date."},"createdBy":{"type":["string","null"],"description":"Created by user."},"modifiedBy":{"type":["string","null"],"description":"Modified by user."}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"error":{"oneOf":[{"type":"string","example":"Validation failed"},{"type":"object","properties":{"ErrorCode":{"type":"integer","example":1001},"ErrorText":{"type":"string","example":"Process failed"}}}]}}}},"components/schemas/DocumentDownloadReference":{"id":"components/schemas/DocumentDownloadReference","kind":"json-schema","title":"DocumentDownloadReference","data":{"type":"object","description":"File name and pre-signed download URL from Document Manager v1 list endpoints.","properties":{"fileName":{"type":"string"},"downloadUrl":{"type":"string"}}}},"components/schemas/DocumentUploadPayload":{"id":"components/schemas/DocumentUploadPayload","kind":"json-schema","title":"DocumentUploadPayload","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload inside ApiResponse.data for POST/PUT /v1/documents/* upload and update."},"children":[]}]}]}],"properties":{"documentId":{"type":"integer"},"fileName":{"type":"string"},"downloadUrl":{"type":["string","null"],"description":"Optional pre-signed URL when available."}}}},"components/schemas/DocumentDownloadPayload":{"id":"components/schemas/DocumentDownloadPayload","kind":"json-schema","title":"DocumentDownloadPayload","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload inside ApiResponse.data for GET /v1/documents/{id}/.../download."},"children":[]}]}]}],"properties":{"documentId":{"type":"integer"},"downloadUrl":{"type":"string"},"expiresAtUtc":{"type":"string","format":"date-time"}}}},"components/schemas/ApiResponseDocumentUpload":{"id":"components/schemas/ApiResponseDocumentUpload","kind":"json-schema","title":"ApiResponseDocumentUpload","data":{"type":"object","description":"Standard v1 success wrapper for document upload/update.","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/DocumentUploadPayload"},"error":{"type":"string"}}}},"components/schemas/ApiResponseDocumentDownload":{"id":"components/schemas/ApiResponseDocumentDownload","kind":"json-schema","title":"ApiResponseDocumentDownload","data":{"type":"object","description":"Standard v1 success wrapper for document download metadata.","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/DocumentDownloadPayload"},"error":{"type":"string"}}}},"components/schemas/DocumentManagerErrorBody":{"id":"components/schemas/DocumentManagerErrorBody","kind":"json-schema","title":"DocumentManagerErrorBody","data":{"type":"object","description":"Error body for document v1 endpoints on failure (HTTP4xx), when not using the ApiResponse success wrapper.","properties":{"errorCode":{"type":"integer"},"errorText":{"type":"string"}}}},"components/schemas/DriverDetail":{"id":"components/schemas/DriverDetail","kind":"json-schema","title":"DriverDetail","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Driver details returned by GET /v1/drivers/{id}."},"children":[]}]}]}],"properties":{"driverId":{"type":"integer","description":"Driver identifier."},"clientName":{"type":"string","description":"Client name."},"firstName":{"type":"string","description":"Driver first name."},"middleName":{"type":["string","null"],"description":"Driver middle name."},"lastName":{"type":"string","description":"Driver last name."},"driverName":{"type":"string","description":"Full driver name."},"email":{"type":["string","null"],"description":"Driver email."},"phone":{"type":["string","null"],"description":"Driver phone."},"dateOfBirth":{"type":["string","null"],"description":"Date of birth (MM-dd-yyyy)."},"address1":{"type":["string","null"],"description":"Address line 1."},"address2":{"type":["string","null"],"description":"Address line 2."},"city":{"type":["string","null"],"description":"City."},"state":{"type":["string","null"],"description":"State."},"zip":{"type":["string","null"],"description":"ZIP code."},"driverLicenceNo":{"type":["string","null"],"description":"Driver license number."},"driverLicenceState":{"type":["string","null"],"description":"License state."},"driverLicenceType":{"type":["string","null"],"description":"License type (e.g. CDL)."},"dateOfHire":{"type":["string","null"],"description":"Date of hire (MM-dd-yyyy)."},"driverStatus":{"type":["string","null"],"description":"Driver status: active, notActive, pending."},"driverType":{"type":["string","null"],"description":"Driver type."},"terminatedDate":{"type":["string","null"],"description":"Terminated date (MM-dd-yyyy)."},"createdDate":{"type":"string","format":"date-time","description":"Record created date."},"modifiedDate":{"type":"string","format":"date-time","description":"Record modified date."},"createdBy":{"type":["string","null"],"description":"User who created the record."},"modifiedBy":{"type":["string","null"],"description":"User who last modified the record."},"cdlOriginalDate":{"type":["string","null"],"description":"CDL original date (MM-dd-yyyy)."},"oaPolicyName":{"type":["string","null"],"description":"OA policy name."},"oaPolicyAddedDate":{"type":["string","null"],"description":"OA policy added date."},"oafuturePolicyName":{"type":["string","null"],"description":"OA future policy name."},"deletedReason":{"type":["string","null"],"description":"Deleted reason."},"vehicleUnit":{"type":["string","null"],"description":"Assigned vehicle unit."},"vehicleId":{"type":["integer","null"],"format":"int64","description":"Assigned vehicle ID."},"beneficaryFirstName":{"type":["string","null"],"description":"Beneficiary first name."},"beneficiaryMiddleName":{"type":["string","null"],"description":"Beneficiary middle name."},"beneficiaryLastName":{"type":["string","null"],"description":"Beneficiary last name."},"beneficiaryAddress":{"type":["string","null"],"description":"Beneficiary address."},"medicalCertIssueDate":{"type":["string","null"],"description":"Medical certificate issue date."},"medicalCertExpirationDate":{"type":["string","null"],"description":"Medical certificate expiration date."},"sambaVerified":{"type":"boolean","description":"Samba verification status."},"qortaScore":{"type":["integer","null"],"description":"Qorta score."},"agencyApprovedCoverages":{"type":["string","null"],"description":"Agency approved coverages."},"agencyRejectedCoverages":{"type":["string","null"],"description":"Agency rejected coverages."},"ssn":{"type":["string","null"],"description":"SSN (masked as xxx-xx-XXXX)."}}}},"components/schemas/PolicyReportRawDataResponse":{"id":"components/schemas/PolicyReportRawDataResponse","kind":"json-schema","title":"PolicyReportRawDataResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payload for GET /v1/reports/{id}/raw-data."},"children":[]}]}]}],"properties":{"policyPremiumReportId":{"type":"integer","format":"int64","description":"Policy premium report ID."},"policyId":{"type":"integer","description":"Policy ID."},"clientId":{"type":"integer","description":"Client ID."},"reportDate":{"type":"string","format":"date-time","description":"Report date."},"source":{"type":"string","description":"Data source (stored snapshot vs computed)."},"mapping":{"type":["object","null"],"description":"Document renderer mapping (fixedData, tableData, premium fields)."}}}},"components/schemas/AssociateDriverToVehicleResponse":{"id":"components/schemas/AssociateDriverToVehicleResponse","kind":"json-schema","title":"AssociateDriverToVehicleResponse","data":{"type":"object","description":"Response when associating a driver with a vehicle.","properties":{"vehicleId":{"type":"integer","format":"int64","description":"Vehicle ID."},"vin":{"type":["string","null"],"description":"Vehicle VIN."},"driverId":{"type":"integer","description":"Driver ID."},"clientName":{"type":["string","null"],"description":"Client name."},"firstName":{"type":["string","null"],"description":"Driver first name."},"middleName":{"type":["string","null"],"description":"Driver middle name."},"lastName":{"type":["string","null"],"description":"Driver last name."},"driverName":{"type":["string","null"],"description":"Driver full name."},"createdDate":{"type":["string","null"],"description":"Record created date."},"modifiedDate":{"type":["string","null"],"description":"Record modified date."},"createdBy":{"type":["string","null"],"description":"Created by user."},"modifiedBy":{"type":["string","null"],"description":"Modified by user."},"message":{"type":["string","null"],"description":"Success message."}}}},"components/schemas/ApiResponseDocumentDelete":{"id":"components/schemas/ApiResponseDocumentDelete","kind":"json-schema","title":"ApiResponseDocumentDelete","data":{"type":"object","description":"Standard v1 success wrapper for document delete.","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"message":{"type":"string","example":"Document deleted successfully."}}},"error":{"type":"string"}}}},"components/schemas/AssignVehicleCoverageRequest":{"id":"components/schemas/AssignVehicleCoverageRequest","kind":"json-schema","title":"AssignVehicleCoverageRequest","data":{"type":"object","description":"Request body for POST /v1/vehicles/coverages.","required":["vehicleId","policyId"],"properties":{"vehicleId":{"type":"integer","format":"int64","description":"Vehicle to assign coverage for.","minimum":1},"policyId":{"type":"integer","description":"Policy to attach the vehicle to.","minimum":1},"policyAddedDate":{"type":["string","null"],"format":"date-time","description":"Date the vehicle is added to the policy. Required for active policies; for future policies the server uses the policy effective date."}}}},"components/schemas/UpdateVehicleCoverageRequest":{"id":"components/schemas/UpdateVehicleCoverageRequest","kind":"json-schema","title":"UpdateVehicleCoverageRequest","data":{"type":"object","description":"Request body for PUT /v1/vehicles/coverages.","required":["vehicleId","policyId","coverageStatus"],"properties":{"vehicleId":{"type":"integer","format":"int64","description":"Vehicle whose coverage is being updated.","minimum":1},"policyId":{"type":"integer","description":"Policy coverage to update on the vehicle.","minimum":1},"coverageStatus":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target coverage status: 1 = response needed (remove), 2 = coverage declined, 4 = sponsored scheduled unit (change policy added date)."},"children":[]}]}]}],"enum":[1,2,4]},"policyAddedDate":{"type":["string","null"],"format":"date-time","description":"Required when coverageStatus is 4 and the policy is active. Not supported for future policies."},"policyRemovedDate":{"type":["string","null"],"format":"date-time","description":"Required when coverageStatus is 1 or 2 and the policy is active. Must not be provided when coverageStatus is 4."}}}},"components/schemas/AssignVehicleCoverageResponse":{"id":"components/schemas/AssignVehicleCoverageResponse","kind":"json-schema","title":"AssignVehicleCoverageResponse","data":{"type":"object","description":"Payload inside ApiResponse.data for POST /v1/vehicles/coverages.","properties":{"vehicleId":{"type":"integer","format":"int64"},"policyId":{"type":"integer"},"clientId":{"type":"integer"},"coverageType":{"type":"integer"},"coverageTypeText":{"type":["string","null"]},"policyNumber":{"type":["string","null"]},"vin":{"type":["string","null"]},"unit":{"type":["string","null"]},"policyAddedDate":{"type":"string","format":"date-time"},"policyRemovedDate":{"type":["string","null"],"format":"date-time"},"policyEffectiveDate":{"type":"string","format":"date-time"},"policyExpirationDate":{"type":"string","format":"date-time"},"policyStatus":{"type":"integer"},"policyStatusText":{"type":["string","null"]},"message":{"type":["string","null"]}}}},"components/schemas/UpdateVehicleCoverageResponse":{"id":"components/schemas/UpdateVehicleCoverageResponse","kind":"json-schema","title":"UpdateVehicleCoverageResponse","data":{"type":"object","description":"Payload inside ApiResponse.data for PUT /v1/vehicles/coverages.","properties":{"vehicleId":{"type":"integer","format":"int64"},"policyId":{"type":"integer"},"clientId":{"type":"integer"},"coverageType":{"type":"integer"},"coverageTypeText":{"type":["string","null"]},"coverageStatus":{"type":"integer"},"coverageStatusText":{"type":["string","null"]},"policyNumber":{"type":["string","null"]},"vin":{"type":["string","null"]},"unit":{"type":["string","null"]},"policyAddedDate":{"type":"string","format":"date-time"},"policyRemovedDate":{"type":["string","null"],"format":"date-time"},"policyEffectiveDate":{"type":"string","format":"date-time"},"policyExpirationDate":{"type":"string","format":"date-time"},"policyStatus":{"type":"integer"},"policyStatusText":{"type":["string","null"]},"message":{"type":["string","null"]}}}},"components/schemas/ApiResponseAssignVehicleCoverage":{"id":"components/schemas/ApiResponseAssignVehicleCoverage","kind":"json-schema","title":"ApiResponseAssignVehicleCoverage","data":{"type":"object","description":"Standard v1 success wrapper for POST /v1/vehicles/coverages.","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/AssignVehicleCoverageResponse"},"error":{"type":"string"}}}},"components/schemas/ApiResponseUpdateVehicleCoverage":{"id":"components/schemas/ApiResponseUpdateVehicleCoverage","kind":"json-schema","title":"ApiResponseUpdateVehicleCoverage","data":{"type":"object","description":"Standard v1 success wrapper for PUT /v1/vehicles/coverages.","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/UpdateVehicleCoverageResponse"},"error":{"type":"string"}}}},"components/schemas/AssignDriverCoverageRequest":{"id":"components/schemas/AssignDriverCoverageRequest","kind":"json-schema","title":"AssignDriverCoverageRequest","data":{"type":"object","description":"Request body for POST /v1/drivers/coverages.","required":["driverId","policyId"],"properties":{"driverId":{"type":"integer","description":"Driver to assign coverage for.","minimum":1},"policyId":{"type":"integer","description":"OA or DD policy to attach the driver to.","minimum":1},"policyAddedDate":{"type":["string","null"],"format":"date-time","description":"Date the driver is added to the policy. Required for active policies; for future policies the server uses the policy effective date."}}}},"components/schemas/UpdateDriverCoverageRequest":{"id":"components/schemas/UpdateDriverCoverageRequest","kind":"json-schema","title":"UpdateDriverCoverageRequest","data":{"type":"object","description":"Request body for PUT /v1/drivers/coverages.","required":["driverId","policyId","coverageStatus"],"properties":{"driverId":{"type":"integer","description":"Driver whose coverage is being updated.","minimum":1},"policyId":{"type":"integer","description":"Policy coverage to update on the driver.","minimum":1},"coverageStatus":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target coverage status: 1 = response needed (remove), 2 = coverage declined, 7 = sponsored scheduled driver (change policy added date). Status 4 is not valid for drivers."},"children":[]}]}]}],"enum":[1,2,7]},"policyAddedDate":{"type":["string","null"],"format":"date-time","description":"Required when coverageStatus is 7 and the policy is active. Not supported for future policies."},"policyRemovedDate":{"type":["string","null"],"format":"date-time","description":"Required when coverageStatus is 1 or 2 and the policy is active. Must not be provided when coverageStatus is 7."}}}},"components/schemas/AssignDriverCoverageResponse":{"id":"components/schemas/AssignDriverCoverageResponse","kind":"json-schema","title":"AssignDriverCoverageResponse","data":{"type":"object","description":"Payload inside ApiResponse.data for POST /v1/drivers/coverages.","properties":{"driverId":{"type":"integer"},"policyId":{"type":"integer"},"clientId":{"type":"integer"},"coverageType":{"type":"integer"},"coverageTypeText":{"type":["string","null"]},"coverageStatus":{"type":"integer"},"coverageStatusText":{"type":["string","null"]},"policyNumber":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"licenseNumber":{"type":["string","null"]},"policyAddedDate":{"type":"string","format":"date-time"},"policyRemovedDate":{"type":["string","null"],"format":"date-time"},"policyEffectiveDate":{"type":"string","format":"date-time"},"policyExpirationDate":{"type":"string","format":"date-time"},"policyStatus":{"type":"integer"},"policyStatusText":{"type":["string","null"]},"message":{"type":["string","null"]}}}},"components/schemas/UpdateDriverCoverageResponse":{"id":"components/schemas/UpdateDriverCoverageResponse","kind":"json-schema","title":"UpdateDriverCoverageResponse","data":{"type":"object","description":"Payload inside ApiResponse.data for PUT /v1/drivers/coverages.","properties":{"driverId":{"type":"integer"},"policyId":{"type":"integer"},"clientId":{"type":"integer"},"coverageType":{"type":"integer"},"coverageTypeText":{"type":["string","null"]},"coverageStatus":{"type":"integer"},"coverageStatusText":{"type":["string","null"]},"policyNumber":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"licenseNumber":{"type":["string","null"]},"policyAddedDate":{"type":"string","format":"date-time"},"policyRemovedDate":{"type":["string","null"],"format":"date-time"},"policyEffectiveDate":{"type":"string","format":"date-time"},"policyExpirationDate":{"type":"string","format":"date-time"},"policyStatus":{"type":"integer"},"policyStatusText":{"type":["string","null"]},"message":{"type":["string","null"]}}}},"components/schemas/ApiResponseAssignDriverCoverage":{"id":"components/schemas/ApiResponseAssignDriverCoverage","kind":"json-schema","title":"ApiResponseAssignDriverCoverage","data":{"type":"object","description":"Standard v1 success wrapper for POST /v1/drivers/coverages.","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/AssignDriverCoverageResponse"},"error":{"type":"string"}}}},"components/schemas/ApiResponseUpdateDriverCoverage":{"id":"components/schemas/ApiResponseUpdateDriverCoverage","kind":"json-schema","title":"ApiResponseUpdateDriverCoverage","data":{"type":"object","description":"Standard v1 success wrapper for PUT /v1/drivers/coverages.","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/UpdateDriverCoverageResponse"},"error":{"type":"string"}}}},"schema_34":{"kind":"json-schema","data":{"type":["integer","null"]},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":["string","null"]},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"object","description":"Certificate response object."},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":["array","null"],"items":{"type":"string"}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":["string","null"],"minLength":17,"maxLength":17},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":1000,"default":100},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":["boolean","null"]},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"object","required":["clientName","agencyId"],"properties":{"clientName":{"type":"string","description":"Client name (max 255 characters).","example":"Acme Trucking"},"agencyId":{"type":"integer","description":"Agency identifier.","example":1},"producerId":{"type":["integer","null"],"description":"Producer identifier."},"parentClientId":{"type":["integer","null"],"description":"Parent client ID (must belong to the same agency)."},"clientType":{"type":["string","null"],"description":"Client type."},"dot":{"type":["string","null"],"description":"DOT (Department of Transportation) number."},"dbaName":{"type":["string","null"],"description":"DBA (Doing Business As) name."},"description":{"type":["string","null"],"description":"Client description."},"userEmail":{"type":["string","null"],"description":"User email address."},"address1":{"type":["string","null"],"description":"Primary address line 1."},"state":{"type":["string","null"],"description":"Primary state name or code (resolved to stateId).","example":"Tennessee"},"city":{"type":["string","null"],"description":"Primary city name (resolved to cityId, requires state).","example":"Nashville"},"zip":{"type":["string","null"],"description":"Primary ZIP code (max 20 characters)."},"mailingAddress1":{"type":["string","null"],"description":"Mailing address line 1."},"mailingState":{"type":["string","null"],"description":"Mailing state name or code (resolved to mailingStateId)."},"mailingCity":{"type":["string","null"],"description":"Mailing city name (resolved to mailingCityId, requires mailingState)."},"mailingZip":{"type":["string","null"],"description":"Mailing ZIP code (max 20 characters)."},"yearsInBusiness":{"type":["integer","null"],"description":"Years in business (non-negative)."},"taxId":{"type":["string","null"],"description":"Tax ID number."},"clientAdditionalDetails":{"type":["object","null"],"description":"Additional client details."}}},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"object","properties":{"clientName":{"type":["string","null"],"description":"Client name (max 255 characters).","example":"Acme Trucking"},"agencyId":{"type":["integer","null"],"description":"Agency identifier (token must be authorized)."},"producerId":{"type":["integer","null"],"description":"Producer identifier."},"parentClientId":{"type":["integer","null"],"description":"Parent client ID (must belong to the same agency, token must be authorized)."},"clientType":{"type":["string","null"],"description":"Client type."},"dot":{"type":["string","null"],"description":"DOT number."},"dbaName":{"type":["string","null"],"description":"DBA name."},"description":{"type":["string","null"],"description":"Client description."},"userEmail":{"type":["string","null"],"description":"User email address."},"address1":{"type":["string","null"],"description":"Primary address line 1."},"state":{"type":["string","null"],"description":"Primary state name or code (resolved to stateId)."},"city":{"type":["string","null"],"description":"Primary city name (resolved to cityId, requires state)."},"zip":{"type":["string","null"],"description":"Primary ZIP code (max 20 characters)."},"mailingAddress1":{"type":["string","null"],"description":"Mailing address line 1."},"mailingState":{"type":["string","null"],"description":"Mailing state name or code (resolved to mailingStateId)."},"mailingCity":{"type":["string","null"],"description":"Mailing city name (resolved to mailingCityId, requires mailingState)."},"mailingZip":{"type":["string","null"],"description":"Mailing ZIP code (max 20 characters)."},"yearsInBusiness":{"type":["integer","null"],"description":"Years in business (non-negative)."},"taxId":{"type":["string","null"],"description":"Tax ID number."},"clientAdditionalDetails":{"type":["object","null"],"description":"Additional client details."}}},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDownloadReference"}},"error":{"type":"string"}}},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"object","required":["file","documentType"],"properties":{"file":{"type":"string","format":"binary","description":"File to upload."},"documentType":{"type":"string","maxLength":100,"description":"Document type name (must exist for the client module)."},"reportTypeId":{"type":"integer","description":"Optional report type ID."},"friendlyName":{"type":"string","maxLength":500,"description":"Optional display name."},"viewAccess":{"type":"string","maxLength":50,"description":"Optional view access flag/value."}}},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"object","required":["file","documentType"],"properties":{"file":{"type":"string","format":"binary"},"documentType":{"type":"string","maxLength":100},"reportTypeId":{"type":"integer"},"friendlyName":{"type":"string","maxLength":500},"viewAccess":{"type":"string","maxLength":50}}},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"string","enum":["active","notActive","pending"]},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"object","required":["clientId","firstName","lastName","driverType"],"properties":{"clientId":{"type":"integer","description":"Client identifier.","example":1},"firstName":{"type":"string","description":"Driver first name.","example":"John"},"middleName":{"type":["string","null"],"description":"Driver middle name."},"lastName":{"type":"string","description":"Driver last name.","example":"Doe"},"email":{"type":["string","null"],"description":"Driver email address."},"phone":{"type":["string","null"],"description":"Driver phone number."},"dateOfBirth":{"type":["string","null"],"description":"Date of birth (MM-dd-yyyy).","example":"01-15-1990"},"dateOfHire":{"type":["string","null"],"description":"Date of hire (MM-dd-yyyy).","example":"06-01-2020"},"driverType":{"type":"string","description":"Driver type name (resolved via lookup).","example":"Company Driver"},"address1":{"type":["string","null"],"description":"Address line 1."},"address2":{"type":["string","null"],"description":"Address line 2."},"state":{"type":["string","null"],"description":"State name or code (resolved to stateId).","example":"Tennessee"},"city":{"type":["string","null"],"description":"City name (resolved to cityId, requires state).","example":"Nashville"},"zip":{"type":["string","null"],"description":"ZIP code."},"driverLicenceNo":{"type":["string","null"],"description":"Driver license number."},"driverLicenseState":{"type":["string","null"],"description":"License state name or code (resolved to stateId)."},"dlType":{"type":["string","null"],"description":"DL type name (resolved to dlTypeId)."},"cdlOriginalDate":{"type":["string","null"],"description":"CDL original date (MM-dd-yyyy)."}}},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","properties":{"pageIndex":{"type":"integer","description":"Page index (1-based).","default":1},"pageSize":{"type":"integer","description":"Items per page.","default":100},"sortBy":{"type":"integer","description":"Sort field identifier."},"sortOrder":{"type":"integer","description":"Sort order enum (asc/desc)."},"filter":{"type":"object","description":"DriverRequestViewModel filter.","properties":{"clientId":{"type":"integer","description":"Client ID."},"driverId":{"type":"integer","description":"Driver ID filter."},"vehicleId":{"type":["integer","null"],"description":"Vehicle ID filter."},"searchText":{"type":["string","null"],"description":"Free-text search."},"deleted":{"type":"boolean","description":"Include deleted drivers."},"driverStatus":{"type":["integer","null"],"description":"Driver status filter."},"driverTypeId":{"type":"integer","description":"Driver type ID."},"firstNameFilter":{"type":["string","null"]},"middleNameFilter":{"type":["string","null"]},"lastNameFilter":{"type":["string","null"]},"licenseNumber":{"type":["string","null"],"description":"License number filter."},"coverageType":{"type":"integer","description":"Coverage type filter."},"showAllDrivers":{"type":"boolean","description":"Show all drivers flag.","default":false}}}}},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success + data (pageIndex, pageSize, totalRecords, searchResult)."},"children":[]}]}]}]},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"object","required":["clientId","firstName","lastName","driverType"],"properties":{"clientId":{"type":"integer","description":"Client identifier.","example":1},"firstName":{"type":"string","description":"Driver first name.","example":"John"},"middleName":{"type":["string","null"],"description":"Driver middle name."},"lastName":{"type":"string","description":"Driver last name.","example":"Doe"},"email":{"type":["string","null"],"description":"Driver email address."},"phone":{"type":["string","null"],"description":"Driver phone number."},"dateOfBirth":{"type":["string","null"],"description":"Date of birth (MM-dd-yyyy)."},"dateOfHire":{"type":["string","null"],"description":"Date of hire (MM-dd-yyyy)."},"driverType":{"type":"string","description":"Driver type name (resolved via lookup)."},"address1":{"type":["string","null"],"description":"Address line 1."},"address2":{"type":["string","null"],"description":"Address line 2."},"state":{"type":["string","null"],"description":"State name or code."},"city":{"type":["string","null"],"description":"City name (requires state)."},"zip":{"type":["string","null"],"description":"ZIP code."},"driverLicenceNo":{"type":["string","null"],"description":"Driver license number."},"driverLicenseState":{"type":["string","null"],"description":"License state name or code."},"dlType":{"type":["string","null"],"description":"DL type name."},"cdlOriginalDate":{"type":["string","null"],"description":"CDL original date (MM-dd-yyyy)."}}},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"object","required":["vehicleId","driver"],"properties":{"vehicleId":{"type":"integer","format":"int64","description":"Vehicle ID to associate the driver with."},"driver":{"type":"object","required":["firstName","lastName"],"properties":{"driverId":{"type":"integer","description":"Existing driver ID. Omit or use 0 to create new driver.","default":0},"firstName":{"type":"string","description":"Driver first name (required for new drivers)."},"middleName":{"type":["string","null"],"description":"Driver middle name."},"lastName":{"type":"string","description":"Driver last name (required for new drivers)."}}}}},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"object","required":["clientId","effectiveDate","expirationDate"],"properties":{"clientId":{"type":"integer","description":"Client identifier.","example":1},"effectiveDate":{"type":"string","format":"date-time","description":"Policy effective date (cannot be more than 1 year in the past).","example":"2024-01-01T00:00:00Z"},"expirationDate":{"type":"string","format":"date-time","description":"Policy expiration date (must be after effectiveDate).","example":"2025-01-01T00:00:00Z"},"coverageType":{"type":["string","null"],"description":"Coverage type code: PD, NT, OA, PA, CG, AL, GL, WC, TI, DD, VD. Use either this or fullCoverageTypeName.","example":"AL"},"fullCoverageTypeName":{"type":["string","null"],"description":"Full coverage type name for lookup (e.g. 'Physical Damage', 'Auto Liability'). Alternative to coverageType."},"policyNumber":{"type":["string","null"],"description":"Policy number (auto-generated if not provided)."},"policyType":{"type":["integer","null"],"description":"Policy type ID: 1 (ScheduledUnits), 2 (AllUnits), 3 (ScheduledDrivers), 4 (AllDrivers), 5 (AllPowerUnits)."},"policyTypeName":{"type":["string","null"],"description":"Policy type name for lookup. Alternative to policyType."},"insurerId":{"type":["integer","null"],"description":"Insurer ID. Use either insurerId, insurerName, or insurerNAICNumber."},"insurerName":{"type":["string","null"],"description":"Insurer name for lookup."},"insurerNAICNumber":{"type":["string","null"],"description":"Insurer NAIC number for lookup."},"contractId":{"type":["integer","null"],"description":"Contract ID. Use either contractId or contractNo."},"contractNo":{"type":["string","null"],"description":"Contract number for lookup."},"producerName":{"type":["string","null"],"description":"Producer (agent) name for lookup."},"csrName":{"type":["string","null"],"description":"CSR name for lookup."},"stateId":{"type":["integer","null"],"description":"State ID. Use either stateId or stateName."},"stateName":{"type":["string","null"],"description":"State name or code for lookup.","example":"Texas"},"description":{"type":["string","null"],"description":"Policy description."},"annualRate":{"type":["number","null"],"description":"Annual rate for power units (non-negative)."},"monthlyRate":{"type":["number","null"],"description":"Monthly rate for power units (non-negative)."},"nonPowerAnnualRate":{"type":["number","null"],"description":"Annual rate for non-power units."},"nonPowerMonthlyRate":{"type":["number","null"],"description":"Monthly rate for non-power units."},"taxRate":{"type":["number","null"],"description":"Tax rate percentage."},"estimatedPremium":{"type":["number","null"],"description":"Estimated premium."},"unitLimit":{"type":["integer","null"],"description":"Unit limit (non-negative)."},"policyLimit":{"type":["integer","null"],"description":"Policy limit (non-negative)."},"deductibleAmount":{"type":["integer","null"],"description":"Deductible amount."},"eachOccurrence":{"type":["integer","null"],"description":"Each occurrence limit."},"generalAggregate":{"type":["integer","null"],"description":"General aggregate limit."},"personalAdvInjury":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal & advertising injury limit."},"children":[]}]}]}]},"productComOpAgg":{"type":["integer","null"],"description":"Products/completed operations aggregate."},"damageRentedPermises":{"type":["integer","null"],"description":"Damage to rented premises limit."},"medExp":{"type":["integer","null"],"description":"Medical expense limit."},"towingLimit":{"type":["number","null"],"description":"Towing limit."},"limitPerVehicle":{"type":["integer","null"],"description":"Limit per vehicle."},"eachAccidentLimit":{"type":["integer","null"],"description":"Each accident limit (Workers Comp)."},"diseaseEmployeeLimit":{"type":["integer","null"],"description":"Disease employee limit (Workers Comp)."},"diseasePolicyLimit":{"type":["integer","null"],"description":"Disease policy limit (Workers Comp)."},"billingCode":{"type":["integer","null"],"description":"Billing code: 1 (DirectBill), 2 (MonthlyReporting), 3 (AnnuallyBilled), 4 (Quarterly), 5 (Others), 6 (Installments)."},"billingCodeName":{"type":["string","null"],"description":"Billing code name for lookup."},"billingType":{"type":["integer","null"],"description":"Billing type: 1 (Working), 2 (Arrears)."},"billingTypeName":{"type":["string","null"],"description":"Billing type name for lookup."},"billingPayee":{"type":["integer","null"],"description":"Billing payee identifier."},"billingSource":{"type":["integer","null"],"description":"Billing source identifier."},"billingSourceName":{"type":["string","null"],"description":"Billing source name for lookup."},"billingRateType":{"type":["integer","null"],"description":"Billing rate type: 16 (PerPowerUnit), 17 (PerMiles), 18 (PerRevenue), 19 (PerUnit)."},"billingRateTypeName":{"type":["string","null"],"description":"Billing rate type name for lookup."},"installments":{"type":["integer","null"],"description":"Number of installments."},"depositPercentage":{"type":["number","null"],"description":"Deposit percentage."},"separateRateByPowerUnit":{"type":["boolean","null"],"description":"Separate rate by power unit type."},"proRata":{"type":["boolean","null"],"description":"Pro rata billing."},"minimumPremium":{"type":["number","null"],"description":"Minimum premium amount."},"minimumPremiumPercent":{"type":["number","null"],"description":"Minimum premium percentage."},"anyAuto":{"type":["boolean","null"],"description":"Any auto coverage."},"ownedAutosOnly":{"type":["boolean","null"],"description":"Owned autos only coverage."},"hiredAutosOnly":{"type":["boolean","null"],"description":"Hired autos only coverage."},"nonOwnedAutosOnly":{"type":["boolean","null"],"description":"Non-owned autos only coverage."},"scheduledAutos":{"type":["boolean","null"],"description":"Scheduled autos coverage."},"policyOptionId":{"type":["integer","null"],"description":"Policy option: 1 (ClaimsMade), 2 (Occurrence), 3 (Other)."},"generalAggregateLimitId":{"type":["integer","null"],"description":"General aggregate limit: 1 (Policy), 2 (Project), 3 (Location)."},"isCLIncluded":{"type":["boolean","null"],"description":"CL (Contingent Liability) included."},"isAdmitted":{"type":["boolean","null"],"description":"Admitted policy."},"isAdditionalInsured":{"type":["boolean","null"],"description":"Additional insured."},"isWaiver":{"type":["boolean","null"],"description":"Waiver."},"isParentPolicy":{"type":["boolean","null"],"description":"Parent policy."},"cumulative":{"type":["boolean","null"],"description":"Cumulative policy."},"parentPolicyId":{"type":["integer","null"],"description":"Parent policy ID for child policies."},"reportDay":{"type":["integer","null"],"description":"Report day of month."},"generatedDay":{"type":["integer","null"],"description":"Generated day of month."},"renewalDate":{"type":["string","null"],"format":"date-time","description":"Renewal date."},"policyAdditionalDetails":{"type":["object","null"],"description":"Policy additional details."}}},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"object","properties":{"pageIndex":{"type":"integer","description":"Page index (1-based).","default":1},"pageSize":{"type":"integer","description":"Items per page.","default":100},"sortBy":{"type":"integer","description":"Sort field identifier."},"sortOrder":{"type":"integer","description":"Sort order enum (asc/desc)."},"filter":{"type":"object","description":"PolicyRequestViewModel filter.","properties":{"clientId":{"type":"integer","description":"Client ID."},"policyId":{"type":"integer","description":"Policy ID filter."},"searchText":{"type":["string","null"],"description":"Free-text search."},"deleted":{"type":"boolean","description":"Include deleted policies."},"coverageType":{"type":"integer","description":"Coverage type ID."},"status":{"type":"integer","description":"Policy status filter."},"producer":{"type":"integer","description":"Producer filter."},"csr":{"type":"integer","description":"CSR filter."},"effectiveDate":{"type":["string","null"],"format":"date-time"},"expirationDate":{"type":["string","null"],"format":"date-time"},"agencyId":{"type":["string","null"],"description":"Agency ID filter."},"includeChildClientPolicy":{"type":"boolean","description":"Include child client policies."}}}}},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"object","properties":{"clientId":{"type":["integer","null"],"description":"Client identifier."},"effectiveDate":{"type":["string","null"],"format":"date-time","description":"Policy effective date."},"expirationDate":{"type":["string","null"],"format":"date-time","description":"Policy expiration date."},"coverageType":{"type":["string","null"],"description":"Coverage type code: PD, NT, OA, PA, CG, AL, GL, WC, TI, DD, VD."},"fullCoverageTypeName":{"type":["string","null"],"description":"Full coverage type name for lookup. Alternative to coverageType."},"policyNumber":{"type":["string","null"],"description":"Policy number."},"policyType":{"type":["integer","null"],"description":"Policy type ID."},"policyTypeName":{"type":["string","null"],"description":"Policy type name for lookup."},"insurerId":{"type":["integer","null"],"description":"Insurer ID."},"insurerName":{"type":["string","null"],"description":"Insurer name for lookup."},"insurerNAICNumber":{"type":["string","null"],"description":"Insurer NAIC number for lookup."},"contractId":{"type":["integer","null"],"description":"Contract ID."},"contractNo":{"type":["string","null"],"description":"Contract number for lookup."},"producerName":{"type":["string","null"],"description":"Producer name for lookup."},"csrName":{"type":["string","null"],"description":"CSR name for lookup."},"stateId":{"type":["integer","null"],"description":"State ID."},"stateName":{"type":["string","null"],"description":"State name or code for lookup."},"status":{"type":["integer","null"],"description":"Policy status."},"description":{"type":["string","null"],"description":"Policy description."},"annualRate":{"type":["number","null"],"description":"Annual rate for power units."},"monthlyRate":{"type":["number","null"],"description":"Monthly rate for power units."},"nonPowerAnnualRate":{"type":["number","null"],"description":"Annual rate for non-power units."},"nonPowerMonthlyRate":{"type":["number","null"],"description":"Monthly rate for non-power units."},"taxRate":{"type":["number","null"],"description":"Tax rate percentage."},"estimatedPremium":{"type":["number","null"],"description":"Estimated premium."},"unitLimit":{"type":["integer","null"],"description":"Unit limit."},"policyLimit":{"type":["integer","null"],"description":"Policy limit."},"deductibleAmount":{"type":["integer","null"],"description":"Deductible amount."},"eachOccurrence":{"type":["integer","null"],"description":"Each occurrence limit."},"generalAggregate":{"type":["integer","null"],"description":"General aggregate limit."},"personalAdvInjury":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal & advertising injury limit."},"children":[]}]}]}]},"productComOpAgg":{"type":["integer","null"],"description":"Products/completed operations aggregate."},"damageRentedPermises":{"type":["integer","null"],"description":"Damage to rented premises limit."},"medExp":{"type":["integer","null"],"description":"Medical expense limit."},"towingLimit":{"type":["number","null"],"description":"Towing limit."},"limitPerVehicle":{"type":["integer","null"],"description":"Limit per vehicle."},"eachAccidentLimit":{"type":["integer","null"],"description":"Each accident limit (Workers Comp)."},"diseaseEmployeeLimit":{"type":["integer","null"],"description":"Disease employee limit."},"diseasePolicyLimit":{"type":["integer","null"],"description":"Disease policy limit."},"billingCode":{"type":["integer","null"],"description":"Billing code."},"billingCodeName":{"type":["string","null"],"description":"Billing code name for lookup."},"billingType":{"type":["integer","null"],"description":"Billing type."},"billingTypeName":{"type":["string","null"],"description":"Billing type name for lookup."},"billingPayee":{"type":["integer","null"],"description":"Billing payee identifier."},"billingSource":{"type":["integer","null"],"description":"Billing source identifier."},"billingSourceName":{"type":["string","null"],"description":"Billing source name for lookup."},"billingRateType":{"type":["integer","null"],"description":"Billing rate type."},"billingRateTypeName":{"type":["string","null"],"description":"Billing rate type name for lookup."},"installments":{"type":["integer","null"],"description":"Number of installments."},"depositPercentage":{"type":["number","null"],"description":"Deposit percentage."},"separateRateByPowerUnit":{"type":["boolean","null"],"description":"Separate rate by power unit type."},"proRata":{"type":["boolean","null"],"description":"Pro rata billing."},"minimumPremium":{"type":["number","null"],"description":"Minimum premium amount."},"minimumPremiumPercent":{"type":["number","null"],"description":"Minimum premium percentage."},"anyAuto":{"type":["boolean","null"],"description":"Any auto coverage."},"ownedAutosOnly":{"type":["boolean","null"],"description":"Owned autos only coverage."},"hiredAutosOnly":{"type":["boolean","null"],"description":"Hired autos only coverage."},"nonOwnedAutosOnly":{"type":["boolean","null"],"description":"Non-owned autos only coverage."},"scheduledAutos":{"type":["boolean","null"],"description":"Scheduled autos coverage."},"policyOptionId":{"type":["integer","null"],"description":"Policy option."},"generalAggregateLimitId":{"type":["integer","null"],"description":"General aggregate limit type."},"isCLIncluded":{"type":["boolean","null"],"description":"CL included."},"isAdmitted":{"type":["boolean","null"],"description":"Admitted policy."},"isAdditionalInsured":{"type":["boolean","null"],"description":"Additional insured."},"isWaiver":{"type":["boolean","null"],"description":"Waiver."},"isParentPolicy":{"type":["boolean","null"],"description":"Parent policy."},"cumulative":{"type":["boolean","null"],"description":"Cumulative policy."},"parentPolicyId":{"type":["integer","null"],"description":"Parent policy ID."},"reportDay":{"type":["integer","null"],"description":"Report day of month."},"generatedDay":{"type":["integer","null"],"description":"Generated day of month."},"renewalDate":{"type":["string","null"],"format":"date-time","description":"Renewal date."},"policyAdditionalDetails":{"type":["object","null"],"description":"Policy additional details."}}},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":["number","null"]},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"string","enum":["Active","NotActive","Pending"]},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"object","required":["clientId","unit","modelYear","serialNumber"],"properties":{"clientId":{"type":"integer","description":"Client (owner) identifier.","example":1},"serialNumber":{"type":"string","description":"VIN (exactly 17 characters).","minLength":17,"maxLength":17,"example":"1HGBH41JXMN109186"},"unit":{"type":"string","description":"Unit identifier/number.","example":"UNIT-001"},"modelYear":{"type":"integer","description":"Model year (1900-2100).","example":2024},"makes":{"type":["integer","null"],"description":"Make identifier. Use either makes or makeCompanyName."},"makeCompanyName":{"type":["string","null"],"description":"Make name for lookup (e.g. 'International'). Alternative to makes.","example":"International"},"unitType":{"type":["integer","null"],"description":"Unit type identifier. Use either unitType or unitTypeName."},"unitTypeName":{"type":["string","null"],"description":"Unit type name for lookup (e.g. 'Tractor'). Alternative to unitType.","example":"Tractor"},"value":{"type":["number","null"],"description":"Vehicle value (non-negative)."},"licensePlateNo":{"type":["string","null"],"description":"License plate number."},"licensePlateStateName":{"type":["string","null"],"description":"License plate state name or code for lookup."},"model":{"type":["string","null"],"description":"Model name."},"garagingAddress":{"type":["string","null"],"description":"Garaging address."},"gvwr":{"type":["integer","null"],"description":"Gross vehicle weight rating."},"mileage":{"type":["integer","null"],"description":"Mileage (non-negative)."},"driverIDs":{"type":["array","null"],"description":"Assigned driver IDs.","items":{"type":"integer"}},"lienholderIds":{"type":["array","null"],"description":"Lienholder IDs.","items":{"type":"integer"}},"vehicleNotes":{"type":["string","null"],"description":"Vehicle notes."},"certificateNotes":{"type":["string","null"],"description":"Certificate notes."},"effectiveDate":{"type":["string","null"],"format":"date-time","description":"Effective date."},"addedbound":{"type":["string","null"],"format":"date-time","description":"Date vehicle added to fleet (defaults to today)."}}},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"object","properties":{"serialNumber":{"type":["string","null"],"description":"VIN (exactly 17 characters).","minLength":17,"maxLength":17},"unit":{"type":["string","null"],"description":"Unit identifier/number."},"modelYear":{"type":["integer","null"],"description":"Model year (1900-2100)."},"makes":{"type":["integer","null"],"description":"Make identifier."},"makeCompanyName":{"type":["string","null"],"description":"Make name for lookup. Alternative to makes."},"unitType":{"type":["integer","null"],"description":"Unit type identifier."},"unitTypeName":{"type":["string","null"],"description":"Unit type name for lookup. Alternative to unitType."},"value":{"type":["number","null"],"description":"Vehicle value (non-negative)."},"clientId":{"type":["integer","null"],"description":"Client (owner) identifier."},"licensePlateNo":{"type":["string","null"],"description":"License plate number."},"licensePlateStateName":{"type":["string","null"],"description":"License plate state name or code."},"model":{"type":["string","null"],"description":"Model name."},"garagingAddress":{"type":["string","null"],"description":"Garaging address."},"gvwr":{"type":["integer","null"],"description":"Gross vehicle weight rating."},"mileage":{"type":["integer","null"],"description":"Mileage (non-negative)."},"driverIDs":{"type":["array","null"],"description":"Assigned driver IDs.","items":{"type":"integer"}},"lienholderIds":{"type":["array","null"],"description":"Lienholder IDs.","items":{"type":"integer"}},"vehicleNotes":{"type":["string","null"],"description":"Vehicle notes."},"certificateNotes":{"type":["string","null"],"description":"Certificate notes."},"vehicleStatus":{"type":["integer","null"],"description":"Vehicle status."},"deletedDate":{"type":["string","null"],"format":"date-time","description":"Deleted date."},"restoreDate":{"type":["string","null"],"format":"date-time","description":"Restore date."},"effectiveDate":{"type":["string","null"],"format":"date-time","description":"Effective date."},"futureValue":{"type":["number","null"],"description":"Future value (non-negative)."},"billingValue":{"type":["number","null"],"description":"Billing value."}}},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"object","description":"Lienholder with vehicles."},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"integer","format":"int64","minimum":1},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"$ref":"#/components/schemas/PolicyReportRawDataResponse"}}},"id":"schema_67"}},"exampleStore":{"paths/~1v1~1clients~1{id}/get/responses/200/content/application~1json/example":{"value":{"clientName":"Acme Trucking LLC","dbaName":"Acme Trucking","agencyName":"Fleet Insurance Agency","producerName":"John Smith","description":"Regional freight carrier","dot":"123456","address1":"123 Industrial Blvd","city":"Nashville","state":"Tennessee","zip":"37201","mailingAddress1":"123 Industrial Blvd","mailingCity":"Nashville","mailingState":"Tennessee","mailingZip":"37201","parentClient":null,"csrEmail":"csr@acme-trucking.com"},"id":"paths/~1v1~1clients~1{id}/get/responses/200/content/application~1json/example"},"paths/~1v1~1drivers~1{id}/get/responses/200/content/application~1json/example":{"value":{"driverId":1,"clientName":"Acme Trucking LLC","firstName":"John","middleName":"Robert","lastName":"Doe","driverName":"John Robert Doe","email":"john.doe@example.com","phone":"555-123-4567","dateOfBirth":"01-15-1990","address1":"123 Main St","address2":"Suite 100","city":"Nashville","state":"Tennessee","zip":"37201","driverLicenceNo":"D1234567","driverLicenceState":"Tennessee","driverLicenceType":"CDL","dateOfHire":"06-01-2020","driverStatus":"active","driverType":"Company Driver","terminatedDate":null,"createdDate":"2024-01-15T10:30:00Z","modifiedDate":"2024-03-01T14:22:00Z","createdBy":"admin@meshvi.com","modifiedBy":"admin@meshvi.com","cdlOriginalDate":"05-20-2015","oaPolicyName":"AL Policy 2024","oaPolicyAddedDate":"01-15-2024","oafuturePolicyName":"","deletedReason":"","vehicleUnit":"TRK-001","vehicleId":101,"beneficaryFirstName":"Jane","beneficiaryMiddleName":"Marie","beneficiaryLastName":"Doe","beneficiaryAddress":"123 Main St, Nashville TN 37201","medicalCertIssueDate":"03-01-2024","medicalCertExpirationDate":"03-01-2025","sambaVerified":true,"qortaScore":85,"agencyApprovedCoverages":"AL, PD","agencyRejectedCoverages":null,"ssn":"xxx-xx-6789"},"id":"paths/~1v1~1drivers~1{id}/get/responses/200/content/application~1json/example"},"paths/~1v1~1policies~1{id}/get/responses/200/content/application~1json/example":{"value":{"policyId":1001,"policy":"POL-2024-001","clientName":"Acme Trucking LLC","insurerName":"National Insurer Co","insurerNAICNumber":"12345","coverageTypeText":"AL","fullCoverageTypeName":"Auto Liability","policyTypeText":"Scheduled Units","contractNo":"CNT-2024-001","accessPointName":"Direct","policyRenewedSourceText":"Renewal","effectiveDate":"2024-01-01T00:00:00Z","expirationDate":"2025-01-01T00:00:00Z","status":"Active","annualRate":15000,"monthlyRate":1250,"nonPowerAnnualRate":500,"nonPowerMonthlyRate":41.67,"deductibleAmount":1000,"deductibleType":"Per Occurrence","billingRateType":"Per Power Unit","billingFrequency":"Monthly","reportDay":1,"generatedDay":1,"policyRenew":true,"proRata":false,"createdDate":"2024-01-01T10:00:00Z","modifiedDate":"2024-03-01T14:00:00Z","createdBy":"admin@meshvi.com","modifiedBy":"admin@meshvi.com","eachOccurrence":1000000,"generalAggregate":2000000,"unitLimit":50,"policyLimit":1000000,"description":"Auto Liability policy","taxRate":2.5,"numberOfInstallments":12,"depositPercentage":25,"estimatedPremium":18000,"stateName":"Tennessee","towingLimit":5000,"anyAuto":true,"scheduledAutos":true,"minimumPremium":5000},"id":"paths/~1v1~1policies~1{id}/get/responses/200/content/application~1json/example"},"paths/~1v1~1vehicles~1{id}/get/responses/200/content/application~1json/examples/vehicleDetail":{"value":{"id":101,"vin":"1HGBH41JXMN109186","unit":"TRK-001","clientId":1,"clientName":"Acme Trucking LLC","make":"Freightliner","model":"Cascadia","modelYear":2024,"unitType":"Tractor","unitTypeId":1,"unitCategory":"Power Unit","value":125000,"futureValue":110000,"licensePlateNo":"TN-ABC123","licensePlateStateName":"Tennessee","garagingAddress":"123 Industrial Blvd, Nashville TN 37201","vehicleStatus":"Active","effectiveDate":"2024-01-01T00:00:00Z","vehicleNotes":"Primary highway tractor","certificateNotes":null,"gvwr":"80,000 lbs","mileage":45000,"billingValue":125000,"billingProRata":1,"createdDate":"2024-01-15T10:00:00Z","modifiedDate":"2024-06-01T14:30:00Z","createdBy":"admin@meshvi.com","modifiedBy":"admin@meshvi.com"},"key":"vehicleDetail","summary":"Vehicle detail response","id":"paths/~1v1~1vehicles~1{id}/get/responses/200/content/application~1json/examples/vehicleDetail"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meshVI subscription API key. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP header; required at the hosted API edge alongside the Bearer token."},"children":[]}]}]}],"in":"header","paramName":"apiKey"}},"servers":[{"url":"/_mock/apis/meshvi","isMockServer":true,"description":"Mock server"},{"url":"https://uat-verified.meshvi.com","description":"Staging (UAT)"}]},"options":{"corsProxyUrl":"https://cors.redoc.ly","hideSidebar":true,"mockServer":{"url":"/_mock/apis/meshvi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/meshvi.json?download"},{"url":"/_bundle/apis/meshvi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"MeshVI API","description":"API documentation for MeshVI services. Protected routes use application authorization ([APIAuthorize]): a valid Bearer JWT is validated by the API. Calls to the hosted base URL also require an API key in the `apiKey` header, enforced at the API edge. Includes Acord certificate verification and retrieval, client, document (Document Manager v1 list/upload/update/download/delete), driver, policy, vehicle, vehicle and driver coverage assignment, and policy premium report operations for real-time insurance verification and fleet management."}},"baseSlug":"/apis/meshvi","routesMapping":{}}