Search…
Personal Representative Public

About

A service that is responsible for giving third party service providers information about personal representatives and their rights

Context

The purpose of the Public API for the Personal Representative Database is to allow Service providers ,that are unable or unwilling to use Digital Iceland’s login service, to get information about personal representatives and their clients to give the personal representative access to services on behalf of the client according to the rights given in the contract and connection.
The API allows service providers to get information about possible rights as well as the connections a single personal representative has to clients.
The service providers are required to use secure logins and only query by logged in users.

Example of connections

Personal representative
Represented person
Rights
1122334459
1223455569
health-data, personal-data, limited-financial-data
1020304059
0203050569
limited-health-data

JSON expample of connection

1
{
2
"personalRepresentativeTypeCode": "personal_representative_for_disabled_person",
3
"nationalIdPersonalRepresentative": "0123456789",
4
"nationalIdRepresentedPerson": "0123456789",
5
"rights": ["health", "finance"]
6
}
Copied!

Access

The PublicAPI is only accessible through X-Road security servers and only to machine clients with specific scope

Scope

1
@island.is/auth/personal-representative-public
Copied!

X-Road setup

Urls for X-Road setup are as follows

OpenAPI URL

OpenAPI documentation and demoing at

Development

Initial setup

We are using the same service library and database as auth-api and therefore this step by step represents that First, make sure you have docker, then run:
1
yarn dev-services services-auth-api
Copied!
Then run the migrations:
1
yarn nx run services-auth-api:migrate
Copied!
You can serve this service locally by running:
1
yarn start services-personal-representative-public
Copied!
Api open api specs will now be accessible at
1
http://localhost:3378
Copied!

Testing

You can run tests for this service locally by running:
1
yarn test services-personal-representative-public
Copied!

Getting started

1
yarn start services-personal-representative-public
Copied!

Project owner

  • Réttindagæsla velferðarráðuneytisins

Code owners and maintainers