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:

1. Creating a Machine to Machine Client (Application) in the IDS Admin.

2. 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.

get

Query parameters

senderKennitalastringOptional

dateFromstring · date-timeOptional

dateTostring · date-timeOptional

categoryIdstringOptional

typeIdstringOptional

archivedbooleanOptionalDefault: false

orderstring · enumOptionalPossible values:

openedbooleanOptional

pageinteger · int32OptionalDefault: 1

pageSizeinteger · int32OptionalDefault: 15

bookmarkedbooleanOptional

Responses

200

OK

application/json

204

No Content

400

Bad Request

application/json

get

/api/v1/Documents

HTTPcURLJavaScriptPython

GET /api/v1/Documents HTTP/1.1
Host: 
Accept: */*

{
  "documents": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "documentDate": "2025-12-13T16:06:03.146Z",
      "publicationDate": "2025-12-13T16:06:03.146Z",
      "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

get

Path parameters

documentIdstring · uuidRequired

Responses

200

OK

application/json

204

No Content

400

Bad Request

application/json

get

/api/v1/Documents/{documentId}

HTTPcURLJavaScriptPython

GET /api/v1/Documents/{documentId} HTTP/1.1
Host: 
Accept: */*

{
  "fileType": "text",
  "content": "text",
  "htmlContent": "text",
  "urlContent": "text"
}

Read Document

Marks document as read

post

Path parameters

documentIdstring · uuidRequired

Responses

204

No Content

400

Bad Request

application/json

post

/api/v1/Documents/{documentId}/read

HTTPcURLJavaScriptPython

POST /api/v1/Documents/{documentId}/read HTTP/1.1
Host: 
Accept: */*

No content

Archive Document

Sets the documents archived status

post

Path parameters

documentIdstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

archivedbooleanOptional

Responses

204

No Content

400

Bad Request

application/json

post

/api/v1/Documents/{documentId}/archive

HTTPcURLJavaScriptPython

POST /api/v1/Documents/{documentId}/archive HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "archived": true
}

application/jsontext/jsonapplication/*+json

No content

Bookmark Document

Sets the documents bookmarked status

post

Path parameters

documentIdstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

bookmarkedbooleanOptional

Responses

204

No Content

400

Bad Request

application/json

post

/api/v1/Documents/{documentId}/bookmark

HTTPcURLJavaScriptPython

POST /api/v1/Documents/{documentId}/bookmark HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "bookmarked": true
}

application/jsontext/jsonapplication/*+json

No content

Document Types

Returns all document types associated with the organization’s documents

get

Responses

200

OK

application/json

400

Bad Request

application/json

get

/api/v1/Documents/types

HTTPcURLJavaScriptPython

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

get

Responses

200

OK

application/json

400

Bad Request

application/json

get

/api/v1/Documents/categories

HTTPcURLJavaScriptPython

GET /api/v1/Documents/categories HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "name": "text"
  }
]

https://openapi.gitbook.com/o/-MJWAvhHdFCiWEQqlyr6/spec/DocumentsAPI.jsonopenapi.gitbook.com