To make any request to the Blue Flag API, you must first sign-up for an account.

If you want to, you can now make test requests for free in our sandbox environment at any time. To do this, visit our guide on how to generate sandbox keys.

If you want to access pricing and live API data, you must verify your email and submit a full application form. To do this, visit our guide on how to submit an application. Pricing will then be instantly displayed upon submission.

Please note: Only company email addresses will be shown pricing, free domain email addresses will not be shown the pricing.

We will verify your company ABN details and when approved you will receive a confirmation email. You will now be able to add funds to your account, create live API keys and make requests to the live API.

Please note: Your keys and tokens will only display once in the developer portal . It is important that you store these as soon as you generate them.

The Blue Flag API (Application Program Interface), allows you to connect your software to our data.

Our Sandbox environment emulates the behaviour of our production API. It allows your developers to integrate and test at no cost.

To access the Blue Flag API sandbox, you will need to follow these steps:

1 Navigate to the 'API Keys' in your developer Portal

2 Click 'Create Sandbox API Key' button

3 Name your API key and click 'Create & View'

4 Save your API key somewhere safe and click 'Done'

WARNING: Your API Key will only display once when created. Please store this securely as we cannot show it to you again for security reasons. If a new key is required, your integrations will also need updating.

Genuine vehicle information is not available in Sandbox (test) mode. Instead, use any of the following test vehicles. All requests for these vehicles are free and must me made to the sandbox environment: https://sandbox.blueflag.com.au

When you’re ready to take your integration live, please make requests to https://api.blueflag.com.au with a LIVE KEY rather than your sandbox key. Live request will not work if your integration is still using your test keys.

To make any requests to the Blue Flag API, you must first sign-up for an account.

Once you have signed up, you must complete the application form to gain access to pricing and live data. You can access the application form here.

As some of the data we provide is from government sources, we need to verify that all users have a current ABN. Please ensure you select 'Company' from the drop down menu which will allow you to enter your ABN.

We will also need your company name, address and phone number. The business case for using the API data will also need to be complete.

Upon receiving your application submission, we will verify your ABN and company details. You will receive a confirmation email that your application is being reviewed. The approval process usually takes less than one day and you will receive an email when complete.

Please note: If any details from the form are missing, this will slow down the process.

Using cURL

The simplest approach is to make a request in your terminal using curl. The example below shows how you can retrieve VIN Decoder from a registration plate and state entry. This uses the vin_decoder endpoint.

Example request:

curl "https://sandbox.blueflag.com.au/vin_decoder?vin=KMHH351EMKU00TEST" \-H "Authorization: secret_SANDBOX_f1nlZOh0Xr1JvMgJy0d0l9i5JybnBEAYfl7isuU0_o-1GkBsaN8f"

Replace the example sandbox key in the request above with the sandbox key you generated in step 2 and paste the snippet in your terminal. This will send a request to our API using VIN Decoder for the plate TEST00 in the state of VIC .

You will get the JSON response for this request as per below:

{ "request_id": "baf6dcfb-0a34-4881-9365-87dffc9d1e31", "result": { "vin": "KMHH351EMKU00TEST", "make": "Hyundai", "model": "i30", "series": "PD2", "variant": "Active", "build_year": 2019, "model_year": 2019, "body_style": "Hatchback", "doors": 4, "seats": 5, "fuel": { "type": "Petrol" }, "drive": "FWD", "engine": { "cylinders": 4, "size_litres": 2 }, "transmission": { "type": "Auto" } }}

Using Postman

You can make a request to the Blue Flag API is using Postman. This tool lets you make HTTP requests using a graphical user interface. You can specify the request URL, parameters, headers etc.

Example request:

curl "https://sandbox.blueflag.com.au/vin_decoder?vin=KMHH351EMKU00TEST" \-H "Authorization: secret_SANDBOX_f1nlZOh0Xr1JvMgJy0d0l9i5JybnBEAYfl7isuU0_o-1GkBsaN8f"

1 Create a New Collection by pressing the '+' Button and name it.

2 Click 'Add a request' and select a name for it.

3 Enter in the URL from the example request above.

4 Click the 'Headers' tab

5 Enter in the word 'Authorization' underneath the KEY column.

6 Paste your Secret Sandbox key underneath the VALUE column.

7 To make the request, click 'Send'.

You will then get the JSON response for this request as below: