Technical connection: Provide live endpoints

Overview

Purpose of this step

When you have provided your live endpoints, they will be added to your organisation’s record. This will enable you to send and receive requests through the pensions dashboards ecosystem. You will also associate your live endpoints with your vouching scheme’s holdernames. You will do this on the connection portal.

Who completes this step?

• primary business contact

Read the full list of roles and responsibilities.

Before you begin

Before you can complete the live endpoints process, you need to have identified:

• live endpoint URLs for find, view and PAT refresh
• view and PAT refresh endpoints that will be associated with the holdernames for the first pension provider or scheme

What you need to do in this step

1. Provide the URLs for your organisation’s find, view and PAT refresh endpoints.
2. Associate the holdernames for the vouching scheme to the view and PAT refresh endpoints.

1. Provide the URLs for your organisation’s find, view and PAT refresh endpoints

You must provide the URLs for your:

• find endpoint – this allows you to receive the find requests which are initiated by the pension finder service (PFS)
• view endpoint – this allows a dashboard to retrieve pension details on behalf of a requesting party
• PAT refresh endpoint – this allows the protection API token (PAT) to be refreshed and a new PAT to be obtained

You must provide at least one find, one view and one PAT refresh endpoint for your organisation’s connection. The view and PAT refresh endpoints are then associated to holdernames, which are at pension provider or scheme level.

We will soon provide an API for the PAT refresh endpoint. In the meantime, you can

enter the address of your old PAT refresh API if you built this based on the old standards. Alternatively, you can simply enter dummy data.

You can add up to 6 additional endpoints across find, view and PAT refresh as part of this process. If you need more than this, you can add them as part of the ‘additional endpoints’ process after your organisation has completed technical connection.

You may need to talk to your technical team to obtain these endpoints. 

You can read more about endpoints in the technical standards. 

2. Associate the holdernames for the first pension provider or scheme to the view and PAT refresh endpoints

You must select for each holdername:

• the view endpoint to be associated with the holdername
• the PAT refresh endpoint to be associated with the holdername

This tells the pensions dashboards ecosystem where to send requests for each holdername for the first pension provider or scheme.

You do not associate find endpoints with schemes, as these are at an organisational level only.

What happens next

Once you submit, your endpoints will automatically be added and associated to your holdernames.

Your primary technical contact will download your live cryptographic materials (certificates and keys).

Adding additional pension providers and schemes

Once you have completed the connection journey for the vouching scheme, you will be able to add additional pension providers and schemes. This process will associate holdernames to the view and PAT refresh endpoints.

Support