Organization Documents API
Used by organizations to query and fetch documents that are registered to their national ID. The API is only available through Straumurinn (X-Road)
Authentication
The Island.is Authentication Service with client credentials flow is used for authentication.
Organizations can integrate with this service by:
Creating a Machine to Machine Client (Application) in the IDS Admin.
Requesting API access for the client via Island.is support.
API
Document List
Returns a list of documents registered to the organization. A maximum of 100 items can be retrieved in each request.
false115OK
No Content
Bad Request
GET /api/v1/Documents HTTP/1.1
Host:
Accept: */*
{
"documents": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"documentDate": "2025-11-20T12:48:06.714Z",
"publicationDate": "2025-11-20T12:48:06.714Z",
"senderNationalId": "text",
"senderName": "text",
"subject": "text",
"categoryId": "text",
"opened": true,
"bookmarked": true,
"urgent": true,
"replyable": true
}
],
"unreadCount": 1,
"totalCount": 1
}Get Document
Retrieves the document and its contents. Three content types are supported, only one content type is used per document.
content is a base64 string of the documents content
htmlContent is plaintext HTML
urlContent is a URL linking to the document
OK
No Content
Bad Request
GET /api/v1/Documents/{documentId} HTTP/1.1
Host:
Accept: */*
{
"fileType": "text",
"content": "text",
"htmlContent": "text",
"urlContent": "text"
}Document Types
Returns all document types associated with the organization’s documents
OK
Bad Request
GET /api/v1/Documents/types HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"name": "text"
}
]Document Categories
Returns all document categories associated with the organization’s documents
OK
Bad Request
GET /api/v1/Documents/categories HTTP/1.1
Host:
Accept: */*
[
{
"id": "text",
"name": "text"
}
]Last updated
Was this helpful?