# PPSR

## Overview

The Personal Property Securities Register (PPSR) is a national online register managed by the federal government. Individuals and organisations can use the PPSR to register and search for debts and other security interests in personal property such as cars, boats and artworks.

In our context you are able to generate a standard report by sending the following params to the certificates endpoint.

```
v2/certificates/generate
```

```json
{
     "rego": "BMT038",
     "state": "VIC",
     "type": "ppsr"
}
```

The response will contain structured information about the certificate as well as the PDF itself under the URL parameter. 

```json
{
    "success": true,
    "certificate": {
        "id": "be5ae7cd-c54e-43c5-afdf-1febda8b40ba",
        "vin": "WVWZZZAWZKU065305",
        "rego": "BMT038",
        "rego_state": "VIC",
        "url": "https://storage.googleapis.com/ag-ppsr/be5ae7cd-c54e-43c5-afdf-1febda8b40ba/report.pdf",
        "certificate_created_at": "2023-11-21T09:06:51.000Z",
        "year": "2019",
        "make": "VOLKS",
        "model": "POLO",
        "body_type": "CAR/SEDAN",
        "colour": "WHITE",
        "has_safety_recalls": false,
        "has_secured_parties": true,
        "has_stolen_records": false,
        "has_written_off_records": false
    }
}
```

If you wish to view an example PPSR you can find one below.

{% file src="<https://4010475651-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFaCA1JqFKRrqIB0EfZlZ%2Fuploads%2FugywrpmEbYyjxNor8Nkm%2FPPSR%20Example.pdf?alt=media&token=21ba5184-abff-4ba1-9fb1-e7626cb04b47>" %}
Example PPSR Report
{% endfile %}

### PPSR Updates

To request updates for a Personal Property Securities Register (PPSR) certificate, utilize the endpoint `/v2/certificates/{id}/updates` by substituting `{id}` with the unique certificate ID you received upon generation. This allows you to check for any changes to the PPSR.

Within the `updates`object you will have received two fields

* `has_expired`which will indicate if the PPSR record is now out of date
* `has_changed`which will indicate if there has been an update to the status of the vehicle since the original PPSR was generated
* The remaining data in the `certificate`object contains the details from the initially generated PPSR certificate as the `id`

{% hint style="info" %}
If has\_changed is true, to get the updated values from PPSR, PPSR requires that a new certificate be generated. It is not possible to get the updates without generating a new certificate.
{% endhint %}

```json
{
  "success": true,
  "updates": {
    "has_expired": true,
    "has_changed": true,
    "certificate": {
      "id": "d94f4418-0574-48c2-b837-a2c15b16313d",
      "body_type": "CAR/STATION WAGON",
      "colour": "BLUE",
      "make": "SUBARU",
      "model": "OUTBACK",
      "rego": "1CF6ER",
      "rego_state": "VIC",
      "year": "2015",
      "has_safety_recalls": true,
      "has_secured_parties": true,
      "has_stolen_records": true,
      "has_written_off_records": true,
      "url": "string"
    }
  }
}
```