Prerequisites
To access the permit controller permitPrimarySASTokenById method you need to establish an API user to access the NHVR Developer Platform. For a step by step guide see Logging into the Developer Platform.
Using the permit download permit API
The permit permitPrimarySASTokenId API is exposed from the Permit controller from the NHVR Portal - Access Service.
Every call to the permit permitPrimarySASTokenId API should include the following headers:
Header | Value | Note |
Content-Type | 'application/json' | All calls are made using JSON data structures |
Ocp-Apim-Subscription-Key | Your subscription key for the NHVR Portal API | The subscription key uniquely identifies you to the NHVR Portal API |
The findById endpoint uses the GET method and has one path parameter id which is required to perform a download of a specific permit.
https://api-public.nhvr.gov.au/access/permits/primarySASToken/{id}
Specification
The full permit permitPrimarySASTokenById API specification is available on the NHVR Developer Platform: PermitController.permitPrimarySASTokenById
The return results schema is provided below for quick reference:
The uri when pasted into the browser will download the permit pdf from the blob-storage.
{
"token": "st=2025-11-27T04%3A41%3A09Z&se=2025-11-27T05%3A06%3A09Z&sp=racwdl&sv=2018-03-28&sr=b&sig=y%2FAykhs7EWq6AgeDjGBgBQnWl9PKSzUJi0yxLjxK%2FV8%3D",
"storageUri": "https://nhvrappsqa.blob.core.windows.net/permit",
"containerName": "permit",
"blobName": "operations8053Permit_8053V1_07Jul25.pdf",
"uri": "https://nhvrappsqa.blob.core.windows.net/permit/operations8053Permit_8053V1_07Jul25.pdf?st=2025-11-27T04%3A41%3A09Z&se=2025-11-27T05%3A06%3A09Z&sp=racwdl&sv=2018-03-28&sr=b&sig=y%2FAykhs7EWq6AgeDjGBgBQnWl9PKSzUJi0yxLjxK%2FV8%3D"
}