hub.eb?material_id=782

Create and configure API Keys for the DVLA Data Connectors


The DVLA Vehicle Enquiry Data Connector can be downloaded in the Verj.io Studio and used in a Form's server events to connect to the UK Driver & Vehicle Licensing Agency's Vehicle Enquiry Service.

In order to connect to the Vehicle Enquire Service at runtime however, an API key must be configured in the Verj.io Runtime Environment that the Form is running in.

Register for an API key at register-for-ves.driver-vehicle-licensing.api.gov.uk. An email containing your API key will be sent upon a successful registration.

You can use this key with the DVLA Vehicle Enquiry Data Connector, along with configuring the DVLA environment to use:

  1. Go to the Data Connector section of the Verj.io Administration Application.
  2. Click + to add a New Data Connector Configuration and name it: DVLA.
  3. Click + to add a Data Connector Property.
    1. Property Name: key.
    2. Property Value: <Your DVLA API key>.
  4. Click + to add a Data Connector Property.
    1. Property Name: baseUri.
    2. Property Value: the environment URI:
      • test: https://uat.driver-vehicle-licensing.api.gov.uk/
      • production: https://driver-vehicle-licensing.api.gov.uk/
  5. Click OK.

If you are also using the DVLA Keeper At Date Of Event Data Connector you also need to register for a KADOE API key and user credentials at https://register-for-kadoe.driver-vehicle-licensing.api.gov.uk/. An email containing your API key and user details will be sent upon a successful registration.

Add this API key and your user details to your DVLA Data Conntector Configuration:

  1. Click on the DVLA Data Connector Configuration.
  2. Click + to add a Data Connector Property.
    1. Property Name: kadoeKey.
    2. Property Value: <Your KADOE API key>.
  3. Click + to add a Data Connector Property.
    1. Property Name: username.
    2. Property Value: <Your DVLA username>.
  4. Click + to add a Data Connector Property.
    1. Property Name: email.
    2. Property Value: <Registered email address>.
  5. Click OK.

Click here for further information about configuring a Data Connector.

Related