Prerequisites
To access the Accreditation findCustomer 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 accreditation customer API from the Accreditation Service
The accreditation findCustomer API is exposed from the Accreditation controller from the NHVR Portal - Accreditation Service.
Every call to the accreditation findCustomer 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 accreditations-customer endpoint uses the GET method and passes in an optional query parameter accreditationSchemaId (number)
https://api-public.nhvr.gov.au/accred/accreditations-customer
Specification
The full accreditation findCustomer API specification is available on the NHVR Developer Platform: AccreditationController.accreditation-customer.
The return results schema is provided below for quick reference:
{
"data": [
{
"id": 1,
"accreditationSchemeId": 1,
"accreditationNumber": "NHVAS12345",
"rCN": 12345669,
"workflowState": 4,
"outcome": null,
"primaryContactFirstName": "AutoAccreditation",
"primaryContactLastName": "Readonly",
"status": "Current",
"customerAccountName": "Automated Test For update account",
"waOperatorNumber": null,
"customerAccountId": 3,
"workflowStateMass": null,
"workflowStateMaintenance": 5,
"workflowStateBFM": 7,
"workflowStateAFM": 2,
"workflowStateDLM": null,
"workflowStateGSA": null,
"workflowStateFatigue": null,
"accreditationMassStatus": "Not Established",
"accreditationDLMStatus": null,
"accreditationMaintenanceStatus": "Current",
"accreditationBFMStatus": "Expired",
"accreditationGSAStatus": null,
"accreditationFatigueStatus": null,
"accreditationMassExpiry": "2025-01-01T00:00:00.000Z",
"accreditationBFMExpiry": "2023-10-07T00:00:00.000Z",
"accreditationMaintenanceExpiry": "2025-02-01T00:00:00.000Z",
"accreditationAFMExpiry": "2025-01-01T00:00:00.000Z",
"accreditationDLMExpiry": null,
"accreditationExpiry": "2030-10-28T00:00:00.000Z",
"accreditationMassCancelled": null,
"accreditationBFMCancelled": null,
"accreditationMaintenanceCancelled": null,
"accreditationAFMCancelled": null,
"accreditationDLMCancelled": null,
"accreditationGSACancelled": null,
"accreditationFatigueCancelled": null,
"accreditationMassNextAudit": null,
"accreditationMaintenanceNextAudit": "2024-11-30T00:00:00.000Z",
"accreditationBFMNextAudit": null,
"accreditationAFMNextAudit": "2024-12-31T00:00:00.000Z",
"accreditationDLMNextAudit": null,
"accreditationMassEstablish": null,
"accreditationMaintenanceEstablish": null,
"accreditationBFMEstablish": null,
"accreditationAFMEstablish": null,
"accreditationDLMEstablish": null,
"accreditationGSAExpiry": null,
"accreditationGSAEstablish": null,
"accreditationGSANextAudit": null,
"accreditationFatigueExpiry": null,
"accreditationFatigueEstablish": null,
"accreditationFatigueNextAudit": null,
"accreditationAFMStatus": "Current",
"cntVeh": 7,
"cntDriver": 1,
"cntEmployees": 0,
"cntVehicleDefect": 0,
"cntComp": 7,
"cntApp": 16,
"cntOrder": 4,
"cntAudit": 2,
"cntFlags": 0,
"cntNotices": 0,
"cntCars": 1,
"cntSfis": 0,
"fileList": null,
"operationsAccountId": 1
}
],
"count": 1,
"filter": {
"limit": 50,
"skip": 0
},
"views": [],
"selectedView": {
"queryTypename": "AccreditationViewCustomer",
"queryViewSystemId": 0,
"queryViewAccountId": 0,
"name": "Default view",
"description": "Default view automatically created",
"locked": false
"autoSave": false,
"archived": false,
"id": 35,
"viewType": "User"
}
}