Personal Property Registry API

• baseRegistrationNumber
• registrationType
• createDateTime

Retrieve a list of all Financing Statement registrations either created or added by the account ID submitting the request, sorted by most recent first.

If no Financing Statements exist for the account and empty array is returned.

Financing Statements that have expired or been discharged more than 30 days prior to the submission of the request, and registrations associated with such historical Financing Statements, are excluded from the results.

Use the Add or Delete Account Registrations endpoints to add or remove registrations created with another account.

Created for use by the PPR Application. Use this endpoint to add a Financing Statement created by another account to the List account Registrations results.

Attempting to add a duplicate registration number returns a 409 Conflict status.

Attempting to add registration number with restricted access returns a 403 Forbidden status.

A registration number which does not exist, has expired, or has been discharged returns a 404 Not Found status.

• Secured parties
• Debtors
• Vehicles
• General collateral

Retrieve by amendment registration number an Amendment Statement. The account ID used to submit the request must match the account ID used to create the Amendment Statement identified by the amendment registration number. The Amendment registration must be a change to the Financing Statement identified by the registration_num path parameter.

Retrieve by change registration number a Change Statement. The account ID used to submit the request must match the account ID used to create the Change Statement identified by the change registration number. The Change registration must be a change to the Financing Statement identified by the registration_num path parameter.

Retrieve by registration number a list of all debtor names associated with a Financing Statement. The account ID used to submit the request must match the account ID used to create the Financing Statement identified by the registration number. All existing debtor names are included in the response, including those for removed debtors. The list of names is sorted by the order they were submitted.

Background: this endpoint is used by the PPR application to help the user identify a debtor for an amendment, change, discharge, or renewal registration. This extra piece of information helps prevent mistakes creating registrations on the wrong Financing Statement.

Retrieve by discharge registration number a Discharge Statement. The account ID used to submit the request must match the account ID used to create the Discharge Statement identified by the discharge registration number. The Discharge registration must be a change to the Financing Statement identified by the registration_num path parameter.

Renew a Financing Statement by extending the expiry date. Court order information is required and should only be included when submitting a renewal for a Repairer's Lien (RL) registration type. The Court Order Date must be between the base registration creation date and the request date. Specify lifeYears or lifeInfinite for all registration types except RL. Registrations with an infinite life cannot be renewed.

A Debtor name is required as an additional check on the Financing Statement registration number.

Retrieve by renewal registration number a Renewal Statement. The account ID used to submit the request must match the account ID used to create the Renewal Statement identified by the renewal registration number. The Renewal registration must be a change to the Financing Statement identified by the registration_num path parameter.

Use this endpoint to look up a party code for a registration Secured Party. You can then provide a party code instead of a name and address when submitting registration requests. This endpoint finds the party code, name and address details of all the branches that belong to a head office. Search either by business name or by head office code. A party code is a concatenation of head office and branch codes. A head office code may be between 0 (or 0000) and 9999.

If the nameOrCode path parameter value is three or more characters long and all digits, the query is by code; otherwise it is by head office business name.

The response is an empty array if no matches are found.

Search Step 1

• REGISTRATION_NUMBER - Search by Financing Statement, Amendment Statement, or Change Statement Registration Number (exact match)
• MHR_NUMBER - Search by Manufactured Home Registration Number (exact match)
• BUSINESS_DEBTOR - Search by business debtor name
• INDIVIDUAL_DEBTOR - Search by individual debtor name
• SERIAL_NUMBER - Search by vehicle collateral serial number
• AIRCRAFT_DOT - Search by aircraft airframe DOT number for aircraft registered in Canada

• returnedResultsSize - the number of results returned.
• totalResultsSize - the number of matches found in the Registry.
• maxResultsSize - the Registry upper limit on number of results returned.

Search Step 2

2021-01-14T21:08:32Z

2021-02-16T07:59:59+00:00

Search add endpoint to get account search history:

1. Add GET /ppr/api/v1/search-history

2. Update schema searchQueryResults: add exactResultsSize and selectedResultsSize.

Search update search results detail:

1. Replace PUT /ppr/api/v1/searches/{searchId} with POST /ppr/api/v1/search-results/{searchId}.

2. Add support to format response data as a PDF: allow request header Accept=application/pdf.

3. Update response to include summary information with schema searchDetailResults.

4. Update financingStatementWithChanges schema: add matchType property.

5. Add GET /ppr/api/v1/searches/{searchId} to fetch previous search detail results (for a limited time).

Search change POST /ppr/api/v1/searches no results response:

Change the HTTP status response code to 201 (success) when no matches are found for the search criteria. The response does not include any results and totalResultsSize is 0.

Search add endpoint to support UI autosave of search selection:

1. Update PUT /ppr/api/v1/searches/{searchId}

2. Update searchSummaryInformation schema: add "selected" property.

Update Financing Statement schema: add registrationDescription, registrationAct, statusType, dischargeDateTime, courtOrderInformation.

Update Renewal Statement schema: add lifeYears.

Add GET, PATCH /ppr/api/v1/user-profile for maintaining user UI preferences.

API Specification updates from search implementation.

Add GET /ppr/api/v1/party-codes/head-offices/{nameOrCode}

Update examples.

Update search registration types add TA TG TM

Update GET account financing statement list.

New GET individual registration JSON and PDF:

GET /ppr/api/v1/financing-statements/{registration_num}/amendments/{amendment_registration_num}

GET /ppr/api/v1/financing-statements/{registration_num}/changes/{change_registration_num}

GET /ppr/api/v1/financing-statements/{registration_num}/discharges/{discharge_registration_num}

GET /ppr/api/v1/financing-statements/{registration_num}/renewals/{renewal_registration_num}

New GET account registrations list. /ppr/api/v1/financing-statements/registrations

Update examples.

Add GET /api/v1/financing-statements/{registration_num}/debtorNames.

Replace baseDebtor and baseDebtorName with debtorName.

Add financingStatement.otherTypeDescription.

Add POST /ppr/api/v1/financing-statements/registrations/{registration_num}

Add DELETE /ppr/api/v1/financing-statements/registrations/{registration_num}

Add GET /ppr/api/v1/party-codes/accounts

Update change registration responses to return a verification statement.

Add GET /ppr/api/v1/financing-statements/registrations/{registration_num}

Remove create Change Registration, create and maintain a draft of a Change Registration.

Add registrationsTable and miscellaneousPreferences to the UserProfile schema (expand PPR UI user preference settings).

Add authorizationReceived to financingStatement, amendmentStatement, dischargeStatement, and renewalStatement schemas.

Remove 4000 character limit on single general collateral description.

Update vehicle collateral, general collateral and party descriptions.

Remove general and vehicle collateral schema anyOf, allOf required conditions to resolve a gateway specification rendering issue.

Add callbackURL request parameter to the /ppr/api/v1/search-results/{searchId} endpoint.

Remove upper limit of 1000 on search results.

Adjust individual and business debtor search algorithms.

Fix search result report requests not working with partial selection data.

Specification updates to renewalStatement and searchQuery schema descriptions.

Fix Infinite Renewal report error.

Allow secured party, debtor names with single quotation marks, commas.

Change debtor business name search minimum length to 2 characters.

Correct/change search result report Amendment Registration badges/labels: ADDED, AMENDED, DELETED, NAME CHANGED, ADDRESS CHANGED.

Correct Amendment Registration conditional former name values.

Correct Financing Statement consolidated view of amended general collateral: only include descriptionAdd and descriptionDelete together when adding 1 item and deleting 1 item.

Specification updates to the vehicleCollateral schema definition: remove EV; do not allow AP with new registrations.

Handle search result reports with few results but a large data size (large number of serial collateral). Generate the report as part of Search Step 2, return an ACCEPTED response, retrieve the report with a subsequent GET.

Add query parameters to GET /ppr/api/v1/financing-statements/registrations to filter results. Filter by clientReferenceId, registrationNumber, or startDateTime and endDateTime. Use to check the status of specific account registrations.

Add crown charge registrations type TO (TOBACCO TAX ACT) and SV (SPECULATION AND VACANCY TAX ACT).

Re-organize large search result report with more than 700 registrations into sub-reports to improve performance.

Add three transition related properties to the financingStatement model. Transition registrations are active registrations which were re-registered in the electronic registry. If the financing statement is for one of these registrations, three additional properties are conditionally included in a response: transitionDescription, transitionDate, and transitionNumber..

Update API specification property lengths.

Add Large Search Reports section.

Add section Reports for Registrations With a Large Data Size.

Update API specification vehicleCollateral model/schema description regarding required properties.