PPSR user onboarding guide

Set up your access to the new PPSR early so there is one

thing less to worry about on 1 October!!

From 10 – 26 September you will be able to access the new PPSR website at:

https://ppsr.companiesoffice.govt.nz/ to:

1. create your RealMe login (if you haven’t got one already)

2. set up your new PPSR online services account and direct debit

3. invite other users to your new PPSR organisation account

4. manage your user permissions and

5. subscribe to the new PPSR API (if you haven’t done so already).

2

PPSR user onboarding guide

Purpose

The purpose of this document is to assist you with onboarding to the new PPSR that will launch on 1 October 2018.

This guide provides step-by-step instructions on how to set up your new PPSR online services account, direct debit,

and subscribe to the new PPSR API (if you haven’t done so already).

Executive Summary

New login

To access the new PPSR website and API each user will require a RealMe login that will replace your PPSR user ID and password. Think of the RealMe login as a ‘key’ to your account. Your PPSR organisation account concept still remains; you’re just changing your individual key to access it.

Note, you don’t need to verify your identity with RealMe, you just need a RealMe username and password. You can use your existing RealMe login or create a new one via the new PPSR website when registering your new online services account.

New online services account and direct debit

All existing PPSR API users will need to create a new PPSR online services account and set up direct debit on the

new PPSR website.

To assist you with early onboarding, the new PPSR website will be available to the public from 10 – 26 September

at https://ppsr.companiesoffice.govt.nz/ for this purpose only.

Alternatively, you can set up your PPSR user account after the launch; however, we encourage you to do this early

to ensure uninterrupted access to the new PPSR from day one.

Your financing statements

We will migrate your financing statement and secured party group (SPG) data (including all PINs and passwords) to

the new register during the cutover weekend. If you manage your financing statements manually on the PPSR

website you will be required to add your SPGs to ‘My Portfolio’ section on the dashboard after 1 October (once the

data is migrated) by providing the ID and password.

Business as usual till 5pm Friday 28 September

You can continue to search the PPSR and manage your financing statements at www.ppsr.govt.nz or via G2B until

5pm on Friday 28 September. The PPSR will not be available until we switch over to the new PPSR system on

Monday 1 October.

PPSR website address

After the go-live the old PPSR website’s URL: www.ppsr.govt.nz will automatically redirect you to

https://ppsr.companiesoffice.govt.nz/

3

PPSR user onboarding process

Setting up your new PPSR online services account

If you are the first administrator for your organisation:

1. From 10 Sep go to https://ppsr.companiesoffice.govt.nz/ and click ‘login’ or ‘create’ top right corner

2. Login with your existing RealMe login, or create a new one. If you don’t yet have a RealMe login, please see

the ‘Creating a RealMe login’ section on page 7 for help creating one.

3. When you login to the PPSR with RealMe for the first time, you’ll be given two options. As you’re creating a

new online services account, select ‘I don’t have an activation code’ and click ‘Register new user’.

4

4. If you will be inviting others to use the account or if you are an API customer, make sure, at the top of the

page, ‘I want to create a PPSR organisation account’ is ticked

5. Complete your user details, and confirm that you have read, and agree, to the terms and conditions, and

privacy statement. Then complete your organisation’s details.

6. To set up your direct debit (mandatory for all API customers), from the dashboard menu click on ‘My Tools’

and under ‘Invoices and Payments’ select ‘Set Up My Direct Debit’.

If you would like us to use your existing direct debit authority and if you are using the same bank account

number, please email to revenue@mbie.govt.nz once you have saved your direct debit details, and we will

transfer this direct debit authority for you. Alternatively, once you have set up your new direct debit,

complete and email us the new direct debit authority form that has been emailed to you.

7. To add an organisation user, from the dashboard menu click on ‘My Tools’ and under ‘Account’ select ‘My

Organisation Details’. Click on the ‘Add organisation user’ button in the right bottom corner of the screen.

8. Enter the name and contact details for the user you wish to add and click on the ‘Create user’ button. An

activation code will be emailed to the new organisation user.

9. The invited user will show in status ‘pending’ until they activate their account. Refer to steps 11 – 14 for the

user activation process. To view user status, from the dashboard menu click on ‘My Tools’ and under

‘Account’ select ‘My Organisation Details’ then scroll down to the ‘List of users for this Organisation’ at the

5

bottom of the screen to see the status. If you click on the user’s name, there is an option to resend

(regenerate) a new activation code.

10. User permissions. Organisation users, by default, will have access to all PPSR services. To manage their

permissions, from the dashboard menu click on ‘My Tools’ and under ‘Account’ select ‘My Organisation

Details’ then click on the user’s name at the bottom of the screen.

11. All users can search and view financing statements. To remove a user’s permission to create and maintain

secured party group and/or financing statement, click ‘Manage organisation user’ and remove the

appropriate permission. It is not recommended to remove user permissions for the user who will subscribe

to the PPSR API; as otherwise, this will block access to the related API operations.

Here are the PPSR services that will be restricted for the user, should you remove one of the two

permissions.

GROUP_SPG_CREATE_MAINTAIN GROUP_FS_CREATE_MAINTAIN

Create new secured party group Create financing statement

Maintain secured party group Amend financing statement

Transfer financing statement Discharge financing statement

Change secured party group password Renew financing statement

Request financing statements PINs report Sub/unsubordinate financing statement

Email secured party group password Change financing statement/debtor PIN

Remove secured party group from My Portfolio Accept change demand

6

As an invited organisation user:

12. Once you receive an activation code via email (that will look like this):

13. Go to https://ppsr.companiesoffice.govt.nz/ and click ‘login’ or ‘create’ top right corner

14. Login with your existing RealMe login, or create a new one. If you don’t yet have a RealMe login, please see

the ‘Creating a RealMe login’ section on page 7 for help creating one.

15. Once you’ve logged in, click on ‘I have an activation code’ option, and enter the activation code sent to you

by email.

16. Check your user details, amend if necessary, confirm that you have read, and agree, to the terms and

conditions, and save your details.

7

Creating a new RealMe login

If you don’t have a RealMe login, follow the below steps to create a new login via the new PPSR website.

1. Complete your contact details, including your RealMe username

2. Enter your RealMe password

3. Choose and answer three security questions

8

4. Add a secret PIN (optional)

5. Prove you're a human

6. Accept the RealMe terms of use

9

For assistance please call 0508 777 746. Calls are free within New Zealand. We’re open from 8.30am–5pm

Monday to Thursday, and from 9am-5pm Fridays. From overseas please call +64 3 962 2618.

10

Subscribing to the PPSR API

If you use a software product to connect directly to the PPSR (rather than using the PPSR website), there may be an additional step required for setting up. This direct connection is known as an ‘API’, previously referred to as the ‘G2B’ connection. Check with your software provider whether you need to subscribe to the PPSR’s API and provide an access token.

All PPSR transactions via PPSR software will be linked to an associated PPSR user, with all fees billed to the organisation's direct debit account.

The RealMe login serves as a link between your PPSR organisation account and the API; so if this user is deleted, you will lose your connection to the API! We recommend, therefore, that this user be an administrator, as the last admin user cannot be removed from an organisation. Also, it’s best not to remove any of the user permissions for this user, as this will block access to the related API operations.

If you have PPSR software that requires you to enter an access token:

1. Prior to go-live an administrator, i.e. a technical API representative within your organisation, must go to the

PPSR API page at the API Explorer and log in with the same RealMe login used to create your PPSR user

account. (This may already have been done during PPSR sandbox testing). The user created in the PPSR

must belong to an organisation account.

2. The API Explorer site has full instructions on how to subscribe to an API.

3. Before your subscription request can be approved you will need to supply a copy of the current API Access

Agreement. This agreement replaces the ‘G2B Access Agreement’ used for customers who started using

PPSR earlier than 2015.

There’s minimal difference to the previous G2B Access Agreement, mostly, the removal of platform specific

terminology, making it more broadly applicable to all MBIE APIs instead of specifically G2B. Read more

about the detail of the changes and how to supply a new agreement here.

You will be asked to sign a new MBIE API Access Agreement if you only have an older G2B Access

Agreement at the time you subscribe to the PPSR API.

4. The access credentials you’ll need to enter into your software are found in the My Subscriptions screen of

the API Explorer site. The first time you visit this screen you’ll need to use the ‘Generate keys’ buttons to

create credentials for the sandbox test environment and the production system.

11

5. If your software requires ‘Consumer Key’ and ‘Consumer Secret’ values, copy and paste these from the

production keys section.

6. If your software requires an access token, you will need to generate a non-expiring token. Enter a ‘Validity

Time’ of -1 and click the ‘Re-generate’ button. Then copy and paste the ‘Access Token’ value into your

software.

If you use PPSR software that does not require API access tokens:

7. Some software will automatically link to your PPSR account. This is known as a ‘three-legged’

authentication model. Ask your software provider if you are not sure whether this applies to you.

In this model you do not need to subscribe to the API yourself. On first use of the software product there

will be a one-off process for linking to your PPSR account. The software will present you with a RealMe

login page. Log in with the same RealMe login used to create your PPSR user account. The user created in

the PPSR must belong to an organisation account.

8. You will be presented with a consent screen to confirm that the software is permitted to submit PPSR

transactions on your behalf. Once you agree to this, your software will be linked to your PPSR account – no

further logins or setup is required.

For assistance with your API subscription, please get in touch with our dedicated API Support team at

https://support.api.business.govt.nz

Software providers requiring more detail about API authentication and PPSR organisation options for users can

refer to the PPSR API Authentication Options & User Scenarios before building PPSR software products.