User profile / Notendaupplýsingar
Introduction
The User Profile API is now accessible via Straumurinn (X-Road). This service is a REST API that provides access to user profiles on Island.is. A user profile contains the following information
nationalId
- Users national idemail
- Users email addressmobilePhoneNumber
- Users mobile phone numberlocale
- Users preferred locale setting,"en" "is"
mobilePhoneNumberVerified
- Has the user verified their mobile phone number via two-factor authenticationemailVerified
- Has the user verified their email address via two-factor authenticationdocumentNotifications
- Boolean indicating if user has document notifications turned on or offemailNotifications
- Boolean indicating if user has email notifications turned on or offprofileImageUrl
- Link to the users profile imageneedsNudge
- Boolean indicating if the users should be nudged to update their user profile informationlastNudge
- Date of when the user was last nudged to update their user profile informationnextNudge
- Date of when the user will be nudged next to update their user profile informationisRestricted
- The user has not been nudged to update their user profile information since the migration of user profiles to island.is
Access for Government Organisations
Government organisations can integrate with this service by:
Creating a Machine to Machine Client (Application) in the IDS Admin.
Requesting access for this client to the user profile API endpoints via Island.is support.
Available Endpoints
Once access is granted, organisations can use the following API endpoints:
GET
/v2/users/{national-id}
– Fetch a specific user's profile using their national ID. The query parameter clientType can be ignored.GET
/v2/users/{to-national-id}/actor-profiles/{from-national-id}
– Retrieve actor profiles.
API Documentation
The full OpenAPI Documentation for this service is available here.
Last updated
Was this helpful?