API reference · Identity & onboarding

Driving licences

POST/accountholder/{type}/{value}/driving/licenceRecord a driving licence for an account holder
GET/accountholder/{type}/{value}/driving/licence/eligibilityAnswer whether an account holder may drive a class
GET/accountholder/{type}/{value}/driving/licencesList a driving licence for an account holder
GET/driving/licence/{id}Fetch one record
PUT/driving/licence/{id}Update one record

POST Record a driving licence for an account holder

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

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: DrivingLicenceRequest · Response: GenericResponseDrivingLicenceResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/driving/licence" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "licenceNumber": "string",
  "issuingAuthority": "string",
  "issuingCountryCode": "string",
  "issuingRegion": {
    "name": "string"
  },
  "licenceStatus": "VALID",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "penaltyPoints": "1",
  "majorOffencesCount": "1",
  "suspensionFrom": "2026-09-25",
  "suspensionTo": "2026-09-25",
  "mobileLicenceAvailable": "true"
}'

{
  "licenceNumber": "string",
  "issuingAuthority": "string",
  "issuingCountryCode": "string",
  "issuingRegion": {
    "name": "string"
  },
  "licenceStatus": "VALID",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "penaltyPoints": "1",
  "majorOffencesCount": "1",
  "suspensionFrom": "2026-09-25",
  "suspensionTo": "2026-09-25",
  "mobileLicenceAvailable": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "licenceNumber": "string",
    "issuingAuthority": "string",
    "issuingCountryCode": "string",
    "issuingRegion": {
      "name": "string"
    },
    "licenceStatus": "VALID",
    "issueDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "penaltyPoints": "1",
    "majorOffencesCount": "1",
    "suspensionFrom": "2026-09-25",
    "suspensionTo": "2026-09-25",
    "mobileLicenceAvailable": "true",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "active": "true",
    "currentlyValid": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "A driving licence recorded successfully"
}

Responses

Status	When
`200`	A driving licence recorded successfully

GET Answer whether an account holder may drive a class

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

Derived from the classes held on the current licence and the licence's own validity. This payload declares no licence number, no penalty points and no address - a fleet operator asking whether someone may drive class C learns that and nothing else.

Headers

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

Path parameters

Name
`type`
`value`

Query parameters

Name	Default
`classCode`	Optional

Example

Response: GenericResponseDrivingLicenceEligibilityResponse

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

{
  "data": {
    "classCode": "string",
    "mayDriveClass": "TRUE",
    "licenceCurrentlyValid": "TRUE",
    "underSuspension": "TRUE",
    "assuranceGrade": "SELF",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z"
  },
  "description": "Driving entitlement answered successfully"
}

Responses

Status	When
`200`	Driving entitlement answered successfully

GET List a driving licence for an account holder

GET /accountholder/{type}/{value}/driving/licences

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListDrivingLicenceResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "licenceNumber": "string",
      "issuingAuthority": "string",
      "issuingCountryCode": "string",
      "issuingRegion": {
        "name": "string"
      },
      "licenceStatus": "VALID",
      "issueDate": "2026-09-25",
      "expiryDate": "2026-09-25",
      "penaltyPoints": "1",
      "majorOffencesCount": "1",
      "suspensionFrom": "2026-09-25",
      "suspensionTo": "2026-09-25",
      "mobileLicenceAvailable": "true",
      "lastCheckedDateTime": "2026-09-25T10:00:00Z",
      "active": "true",
      "currentlyValid": "true",
      "assuranceGrade": "SELF",
      "verificationStatus": "PENDING",
      "verificationMethod": "string",
      "verifierName": {
        "name": "string"
      },
      "verificationDateTime": "2026-09-25T10:00:00Z",
      "expiryDateTime": "2026-09-25T10:00:00Z",
      "disputeStatus": "NONE"
    }
  ],
  "description": "A driving licence fetched successfully"
}

Responses

Status	When
`200`	A driving licence fetched successfully

GET Fetch one record

GET /driving/licence/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseDrivingLicenceResponse

curl -X GET "https://api.bridgemoni.com/driving/licence/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",
    "licenceNumber": "string",
    "issuingAuthority": "string",
    "issuingCountryCode": "string",
    "issuingRegion": {
      "name": "string"
    },
    "licenceStatus": "VALID",
    "issueDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "penaltyPoints": "1",
    "majorOffencesCount": "1",
    "suspensionFrom": "2026-09-25",
    "suspensionTo": "2026-09-25",
    "mobileLicenceAvailable": "true",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "active": "true",
    "currentlyValid": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "A driving licence fetched successfully"
}

Responses

Status	When
`200`	A driving licence fetched successfully

PUT Update one record

PUT /driving/licence/{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: UpdateDrivingLicenceRequest · Response: GenericResponseDrivingLicenceResponse

curl -X PUT "https://api.bridgemoni.com/driving/licence/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 '{
  "licenceNumber": "string",
  "issuingAuthority": "string",
  "issuingCountryCode": "string",
  "issuingRegion": {
    "name": "string"
  },
  "licenceStatus": "VALID",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "penaltyPoints": "1",
  "majorOffencesCount": "1",
  "suspensionFrom": "2026-09-25",
  "suspensionTo": "2026-09-25",
  "mobileLicenceAvailable": "true",
  "active": "true"
}'

{
  "licenceNumber": "string",
  "issuingAuthority": "string",
  "issuingCountryCode": "string",
  "issuingRegion": {
    "name": "string"
  },
  "licenceStatus": "VALID",
  "issueDate": "2026-09-25",
  "expiryDate": "2026-09-25",
  "penaltyPoints": "1",
  "majorOffencesCount": "1",
  "suspensionFrom": "2026-09-25",
  "suspensionTo": "2026-09-25",
  "mobileLicenceAvailable": "true",
  "active": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "licenceNumber": "string",
    "issuingAuthority": "string",
    "issuingCountryCode": "string",
    "issuingRegion": {
      "name": "string"
    },
    "licenceStatus": "VALID",
    "issueDate": "2026-09-25",
    "expiryDate": "2026-09-25",
    "penaltyPoints": "1",
    "majorOffencesCount": "1",
    "suspensionFrom": "2026-09-25",
    "suspensionTo": "2026-09-25",
    "mobileLicenceAvailable": "true",
    "lastCheckedDateTime": "2026-09-25T10:00:00Z",
    "active": "true",
    "currentlyValid": "true",
    "assuranceGrade": "SELF",
    "verificationStatus": "PENDING",
    "verificationMethod": "string",
    "verifierName": {
      "name": "string"
    },
    "verificationDateTime": "2026-09-25T10:00:00Z",
    "expiryDateTime": "2026-09-25T10:00:00Z",
    "disputeStatus": "NONE"
  },
  "description": "A driving licence updated successfully"
}

Responses

Status	When
`200`	A driving licence updated successfully

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