Skip to content

MeshVI API (1.0.0)

API documentation for MeshVI services. These endpoints require API authorization ([APIAuthorize]) via Bearer token. Includes Acord certificate verification and retrieval, client, driver, policy, and vehicle operations for real-time insurance verification and fleet management.

Download OpenAPI description
meshvi.json
meshvi.yaml
Languages
Servers
Mock server
https://docs.meshvi.com/_mock/apis/meshvi
Production
https://verified.meshvi.com

Certificates

Certificate verification and retrieval (Acord).

Operations

Clients

Client CRUD and search.

Operations

Search clients

Request

Paginated search of clients with filtering and sorting. Supports page, limit, sort, and filters (name, dot, agencyId, producerId, parentClientId, deleted, clientTypeId, acordEnabled).

Security
BearerAuth
Query
pageinteger>= 1

Page number (1-based).

Default 1
limitinteger[ 1 .. 1000 ]

Items per page (1-1000).

Default 100
sortstring

Sort field (e.g. -clientName for descending).

namestring

Filter by client name (partial match).

dotstring

Filter by DOT number.

agencyIdinteger or null

Filter by agency ID.

producerIdinteger or null

Filter by producer ID.

parentClientIdinteger or null

Filter by parent client ID.

deletedboolean or null

Filter by deleted status.

clientTypeIdinteger or null

Filter by client type ID.

acordEnabledboolean or null

Filter by ACORD enabled.

curl -i -X GET \
  'https://docs.meshvi.com/_mock/apis/meshvi/v1/clients?page=1&limit=100&sort=string&name=string&dot=string&agencyId=0&producerId=0&parentClientId=0&deleted=true&clientTypeId=0&acordEnabled=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of clients.

Create client

Request

Creates a new client. Required: clientName, agencyId. Optional: producerId and other client fields.

Security
BearerAuth
Bodyapplication/jsonrequired
clientNamestringrequired
Example: "Acme Trucking"
agencyIdintegerrequired
Example: 1
producerIdinteger or null
Example: 1
curl -i -X POST \
  https://docs.meshvi.com/_mock/apis/meshvi/v1/clients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientName": "Acme Trucking",
    "agencyId": 1,
    "producerId": 1
  }'

Responses

Client created successfully.

Get client detail

Request

Retrieves client details by ID.

Security
BearerAuth
Path
idintegerrequired

Client ID.

curl -i -X GET \
  'https://docs.meshvi.com/_mock/apis/meshvi/v1/clients/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Client details.

Update client

Request

Updates an existing client. Only provided fields are updated.

Security
BearerAuth
Path
idintegerrequired

Client identifier.

Bodyapplication/jsonrequired
clientNamestring
Example: "Acme Trucking"
agencyIdinteger or null
Example: 1
producerIdinteger or null
Example: 1
curl -i -X PUT \
  'https://docs.meshvi.com/_mock/apis/meshvi/v1/clients/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientName": "Acme Trucking",
    "agencyId": 1,
    "producerId": 1
  }'

Responses

Client updated successfully.

Drivers

Driver search and list.

Operations

Policies

Policy CRUD and search.

Operations

Vehicles

Vehicle certificate operations.

Operations