Skip to main content
POST
vehicles.registration.verify

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
registrationNumber
string
required

Vehicle registration number.

Required string length: 1 - 16
Pattern: ^[A-Z0-9]{4,16}$
includeKeeper
boolean
default:false

Return keeper name and address, which are personal data.

Response

The result

found
boolean
required

Whether the registry returned a vehicle.

registrationNumber
string
required

Registration number.

registeredOn
string<date>

Registration date.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
manufacturer
string

Manufacturer.

model
string

Vehicle model.

fuelType
string

Fuel type.

color
string

Vehicle color.

keeperName
string

Keeper name when requested.

keeperAddress
string

Keeper present address when requested.