API reference · Identity & onboarding

Vehicles

POST/accountholder/{type}/{value}/vehicleRecord a vehicle for an account holder
GET/accountholder/{type}/{value}/vehiclesList a vehicle for an account holder
GET/vehicle/{id}Fetch one record
PUT/vehicle/{id}Update one record

POST Record a vehicle for an account holder

POST /accountholder/{type}/{value}/vehicle

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: VehicleRequest · Response: GenericResponseVehicleResponse

curl -X POST "https://api.bridgemoni.com/accountholder/value/value/vehicle" \
  -H "Authorization: Bearer $BRIDGEMONI_TOKEN" \
  -H "X-Tenant: $BRIDGEMONI_TENANT" \
  -H "X-Environment: $BRIDGEMONI_ENV" \
  -H "Content-Type: application/json" \
  -d '{
  "plateNumber": "string",
  "vin": "string",
  "make": {
    "name": "string"
  },
  "model": {
    "name": "string"
  },
  "manufactureYear": "1",
  "colour": {
    "name": "string"
  },
  "vehicleClass": "PRIVATE_CAR",
  "registrationAuthority": "string",
  "registrationCountryCode": "string",
  "registrationExpiryDate": "2026-09-25",
  "ownershipType": "OWNED",
  "insurerName": {
    "name": "string"
  },
  "insurancePolicyNumber": "string",
  "insuranceExpiryDate": "2026-09-25",
  "roadworthinessExpiryDate": "2026-09-25"
}'

{
  "plateNumber": "string",
  "vin": "string",
  "make": {
    "name": "string"
  },
  "model": {
    "name": "string"
  },
  "manufactureYear": "1",
  "colour": {
    "name": "string"
  },
  "vehicleClass": "PRIVATE_CAR",
  "registrationAuthority": "string",
  "registrationCountryCode": "string",
  "registrationExpiryDate": "2026-09-25",
  "ownershipType": "OWNED",
  "insurerName": {
    "name": "string"
  },
  "insurancePolicyNumber": "string",
  "insuranceExpiryDate": "2026-09-25",
  "roadworthinessExpiryDate": "2026-09-25"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "plateNumber": "string",
    "vin": "string",
    "make": {
      "name": "string"
    },
    "model": {
      "name": "string"
    },
    "manufactureYear": "1",
    "colour": {
      "name": "string"
    },
    "vehicleClass": "PRIVATE_CAR",
    "registrationAuthority": "string",
    "registrationCountryCode": "string",
    "registrationExpiryDate": "2026-09-25",
    "ownershipType": "OWNED",
    "insurerName": {
      "name": "string"
    },
    "insurancePolicyNumber": "string",
    "insuranceExpiryDate": "2026-09-25",
    "roadworthinessExpiryDate": "2026-09-25",
    "insuranceVerifiedDateTime": "2026-09-25T10:00:00Z",
    "active": "true",
    "insured": "true",
    "roadworthy": "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 vehicle recorded successfully"
}

Responses

Status	When
`200`	A vehicle recorded successfully

GET List a vehicle for an account holder

GET /accountholder/{type}/{value}/vehicles

Headers

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

Path parameters

Name
`type`
`value`

Example

Response: GenericResponseListVehicleResponse

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

{
  "data": [
    {
      "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
      "plateNumber": "string",
      "vin": "string",
      "make": {
        "name": "string"
      },
      "model": {
        "name": "string"
      },
      "manufactureYear": "1",
      "colour": {
        "name": "string"
      },
      "vehicleClass": "PRIVATE_CAR",
      "registrationAuthority": "string",
      "registrationCountryCode": "string",
      "registrationExpiryDate": "2026-09-25",
      "ownershipType": "OWNED",
      "insurerName": {
        "name": "string"
      },
      "insurancePolicyNumber": "string",
      "insuranceExpiryDate": "2026-09-25",
      "roadworthinessExpiryDate": "2026-09-25",
      "insuranceVerifiedDateTime": "2026-09-25T10:00:00Z",
      "active": "true",
      "insured": "true",
      "roadworthy": "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 vehicle fetched successfully"
}

Responses

Status	When
`200`	A vehicle fetched successfully

GET Fetch one record

GET /vehicle/{id}

Headers

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

Path parameters

Name
`id`

Example

Response: GenericResponseVehicleResponse

curl -X GET "https://api.bridgemoni.com/vehicle/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",
    "plateNumber": "string",
    "vin": "string",
    "make": {
      "name": "string"
    },
    "model": {
      "name": "string"
    },
    "manufactureYear": "1",
    "colour": {
      "name": "string"
    },
    "vehicleClass": "PRIVATE_CAR",
    "registrationAuthority": "string",
    "registrationCountryCode": "string",
    "registrationExpiryDate": "2026-09-25",
    "ownershipType": "OWNED",
    "insurerName": {
      "name": "string"
    },
    "insurancePolicyNumber": "string",
    "insuranceExpiryDate": "2026-09-25",
    "roadworthinessExpiryDate": "2026-09-25",
    "insuranceVerifiedDateTime": "2026-09-25T10:00:00Z",
    "active": "true",
    "insured": "true",
    "roadworthy": "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 vehicle fetched successfully"
}

Responses

Status	When
`200`	A vehicle fetched successfully

PUT Update one record

PUT /vehicle/{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: UpdateVehicleRequest · Response: GenericResponseVehicleResponse

curl -X PUT "https://api.bridgemoni.com/vehicle/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 '{
  "plateNumber": "string",
  "vin": "string",
  "make": {
    "name": "string"
  },
  "model": {
    "name": "string"
  },
  "manufactureYear": "1",
  "colour": {
    "name": "string"
  },
  "vehicleClass": "PRIVATE_CAR",
  "registrationAuthority": "string",
  "registrationCountryCode": "string",
  "registrationExpiryDate": "2026-09-25",
  "ownershipType": "OWNED",
  "insurerName": {
    "name": "string"
  },
  "insurancePolicyNumber": "string",
  "insuranceExpiryDate": "2026-09-25",
  "roadworthinessExpiryDate": "2026-09-25",
  "active": "true"
}'

{
  "plateNumber": "string",
  "vin": "string",
  "make": {
    "name": "string"
  },
  "model": {
    "name": "string"
  },
  "manufactureYear": "1",
  "colour": {
    "name": "string"
  },
  "vehicleClass": "PRIVATE_CAR",
  "registrationAuthority": "string",
  "registrationCountryCode": "string",
  "registrationExpiryDate": "2026-09-25",
  "ownershipType": "OWNED",
  "insurerName": {
    "name": "string"
  },
  "insurancePolicyNumber": "string",
  "insuranceExpiryDate": "2026-09-25",
  "roadworthinessExpiryDate": "2026-09-25",
  "active": "true"
}

{
  "data": {
    "reference": "b3f1c2d4-5e6a-4b7c-8d9e-0f1a2b3c4d5e",
    "plateNumber": "string",
    "vin": "string",
    "make": {
      "name": "string"
    },
    "model": {
      "name": "string"
    },
    "manufactureYear": "1",
    "colour": {
      "name": "string"
    },
    "vehicleClass": "PRIVATE_CAR",
    "registrationAuthority": "string",
    "registrationCountryCode": "string",
    "registrationExpiryDate": "2026-09-25",
    "ownershipType": "OWNED",
    "insurerName": {
      "name": "string"
    },
    "insurancePolicyNumber": "string",
    "insuranceExpiryDate": "2026-09-25",
    "roadworthinessExpiryDate": "2026-09-25",
    "insuranceVerifiedDateTime": "2026-09-25T10:00:00Z",
    "active": "true",
    "insured": "true",
    "roadworthy": "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 vehicle updated successfully"
}

Responses

Status	When
`200`	A vehicle updated successfully

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