API reference · Identity & onboarding

Driving licence classes

POST/accountholder/{type}/{value}/driving/licence/classRecord a licence class for an account holder
GET/accountholder/{type}/{value}/driving/licence/classesList a licence class for an account holder
GET/driving/licence/class/{id}Fetch one record
PUT/driving/licence/class/{id}Update one record

POST Record a licence class for an account holder

POST /accountholder/{type}/{value}/driving/licence/class

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`type`
`value`

Example

Request body: DrivingLicenceClassRequest · Response: GenericResponseDrivingLicenceClassResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/driving/licence/class" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "licenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "classCode": "string",
  "classDescription": "string",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "restrictionCodes": "string"
}'

{
  "licenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "classCode": "string",
  "classDescription": "string",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "restrictionCodes": "string"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "licenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "classCode": "string",
    "classDescription": "string",
    "validFrom": "2026-09-25",
    "validTo": "2026-09-25",
    "restrictionCodes": "string",
    "active": "true",
    "currentlyValid": "true"
  },
  "description": "A licence class recorded successfully"
}

Responses

Status	When
`200`	A licence class recorded successfully

GET List a licence class for an account holder

GET /accountholder/{type}/{value}/driving/licence/classes

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListDrivingLicenceClassResponse

curl -X GET "https://api.bridgemoni.com/accountholder/value/value/driving/licence/classes" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "licenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "classCode": "string",
      "classDescription": "string",
      "validFrom": "2026-09-25",
      "validTo": "2026-09-25",
      "restrictionCodes": "string",
      "active": "true",
      "currentlyValid": "true"
    }
  ],
  "description": "A licence class fetched successfully"
}

Responses

Status	When
`200`	A licence class fetched successfully

GET Fetch one record

GET /driving/licence/class/{id}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live

Path parameters

Name
`id`

Example

Response: GenericResponseDrivingLicenceClassResponse

curl -X GET "https://api.bridgemoni.com/driving/licence/class/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV"

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "licenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "classCode": "string",
    "classDescription": "string",
    "validFrom": "2026-09-25",
    "validTo": "2026-09-25",
    "restrictionCodes": "string",
    "active": "true",
    "currentlyValid": "true"
  },
  "description": "A licence class fetched successfully"
}

Responses

Status	When
`200`	A licence class fetched successfully

PUT Update one record

PUT /driving/licence/class/{id}

Headers

Name	Notes
`Authorization`	Bearer token
`X-Tenant`	Your tenant
`X-Environment`	test or live
`Content-Type`	application/json

Path parameters

Name
`id`

Example

Request body: UpdateDrivingLicenceClassRequest · Response: GenericResponseDrivingLicenceClassResponse

curl -X PUT "https://api.bridgemoni.com/driving/licence/class/b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "licenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "classCode": "string",
  "classDescription": "string",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "restrictionCodes": "string",
  "active": "true"
}'

{
  "licenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
  "classCode": "string",
  "classDescription": "string",
  "validFrom": "2026-09-25",
  "validTo": "2026-09-25",
  "restrictionCodes": "string",
  "active": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "licenceReference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "classCode": "string",
    "classDescription": "string",
    "validFrom": "2026-09-25",
    "validTo": "2026-09-25",
    "restrictionCodes": "string",
    "active": "true",
    "currentlyValid": "true"
  },
  "description": "A licence class updated successfully"
}

Responses

Status	When
`200`	A licence class updated successfully

Generated from the OpenAPI document. Branch on the HTTP status: there is no machine-readable error code on the wire. Errors