8 Service APIs
This section provides a reference for APIs that should be implemented by this Building Block.
The APIs defined here establish a blueprint for how the Building Block will interact with other Building Blocks. Additional APIs may be implemented by the Building Block, but the listed APIs define a minimal set of functionality that should be provided by any implementation of this Building Block.
The GovStack non-functional requirements document provides additional information on how 'adaptors' may be used to translate an existing API to the patterns described here. This section also provides guidance on how candidate products are tested and how GovStack validates a product's API against the API specifications defined here.
The tests for the Digital Registries Building Block can be found in this GitHub repository.
The Digital Registries Building Block may contain multiple registries/databases. The dynamic nature of the database structure requires a standard set of automatically generated APIs for all databases hosted on the platform. The system generates default API method endpoints automatically after each publication of the database schema. A new API service version is generated after each schema publish. Database schema version and API versions are in sync.
The naming convention and structure of the API endpoint are the following:
/{information type}/{registry acronym or code}/{version}/{API method as a name}.
Example 1: /api/data/cr/1.0/create
Example 2: /api/v1/database/modify
Each registry contains a unique set of data and the Building Block enables an Analyst to change the data storage structure/schema on the fly. In the following example API descriptions are generated for one example dataset for the Postpartum Infant Care Program registry, where the Caretaker and infant child are registered and a registration ID is issued.

Digital Registries Building Block is expected to host the following API services for each database hosted on the platform.
The API is built using a representational state transfer (REST) software architectural style and described in Open API 3 standard using YAML (a human-readable data-serialization language). Request and response body is in JSON (lightweight data-interchange format).
8.1 Administrative/Analyst Functions
Searches (Regex supported) and returns multiple records as an array-list.
Field for searching random string type data from database
JohnField name that user wishes to filter
FirstNameHow user wishes to order the data
descendingResult page number
1Number of results on one page
10Example of searchable database field. If more searchable fields are in DB, then more similar fields will follow in input
Value can be in any supported format, for an example 'string'Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesGET /data/{registryName}/{versionNumber} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Accept: */*
{
"count": 1,
"next": 1,
"previous": "https://example.com",
"results": [
{
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
]
}Searches and returns one record.
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesRecord not found
POST /data/{registryName}/{versionNumber}/read HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"query": {
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
}
}{
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
}Updates one existing record in the registry database.
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesPUT /data/{registryName}/{versionNumber}/update HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 265
{
"query": {
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
},
"write": {
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
}
}No content
Updates multiple records in the registry database that match the input query.
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesPUT /data/{registryName}/{versionNumber}/updateEntries HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 265
{
"query": {
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
},
"write": {
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
}
}No content
API updates existing record if matching with input parameters is successful. If record is not found the API will create a new record.
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesPOST /data/{registryName}/{versionNumber}/updateOrCreate HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 265
{
"query": {
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
},
"write": {
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
}
}{
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
}8.2 Applicant Functions
Searches records based on input parameters and returns boolean answer (true/false).
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesPOST /data/{registryName}/{versionNumber}/exists HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"query": {
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
}
}{
"answer": {
"status": true,
"message": "Object found from database"
}
}Delete record.
ID of the citizen that needs to be deleted from the Registry data query API
ID1Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesDELETE /data/{registryName}/{versionNumber}/{id}/delete HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Accept: */*
No content
Searches and returns one record’s one field value.
Primary key field
DB-1Data format. Endpoint: /data/DB/1.0/DB-1/read-value/First%20name.json
First nameData format. Endpoint: /data/DB/1.0/DB-1/read-value/First%20name.json
jsonFormat is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesGET /data/{registryName}/{versionNumber}/{uuid}/readValue/{field}.{ext} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Accept: */*
textAllows a user to see who has read their personal data.
User's personal unique identifier
EE378129277266Database acronym
MCTSFormat is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesSuccess Response
Invalid ID supplied
Person requests not found
GET /data/mypersonalDataUsage?userId=EE378129277266&databaseId=MCTS HTTP/1.1
Host:
Information-Mediator-Client: text
Accept: */*
[
{
"id": "1234567",
"readerId": "EE37819285773",
"readerInitials": "JD",
"readerInstitutionId": "EE70049837",
"readerInstitutionName": "East Hospital",
"readerApplicationName": "East Hospital healthcare back office",
"searchDateTime": "2017-07-21T17:32:28Z",
"refrences": []
}
]API endpoint that allows user to get database information with schema
Id of the database that schema is requested
1Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/eregistrations-devGET /database/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Accept: */*
{
"id": 353,
"version": "2.7",
"name": "MCTS",
"description": "Database holding information about MCTS objects",
"institution": "Ministry of Social Affairs",
"numberFormat": "{code}{indexNoByCode}",
"schema": {
"id": 85,
"name": "Mother and Child",
"code": "MCTS",
"databases": [
{
"id": 353,
"version": "2.7",
"name": "MCTS",
"description": "Database holding information about MCTS objects",
"institution": "Ministry of Social Affairs",
"numberFormat": "{code}{indexNoByCode}",
"schema": {
"id": 85,
"name": "Mother and Child",
"code": "MCTS",
"databases": [
"[Circular Reference]"
],
"groupId": 10,
"order": 76,
"dataIndexIncrement": 3
},
"schemaTags": [
{
"name": "",
"path": "/Child/Citizenship",
"isFulltext": true
}
],
"schemaFlags": [
{
"name": "mandatory",
"path": "/ID"
}
],
"fieldsUniques": [
[
""
]
],
"isDraft": false,
"isDisabled": false,
"isArchived": false,
"modifiedAt": "2021-10-03T08:35:01.775915Z",
"byUserName": "ingmar.dev",
"byUserAuthId": 1,
"byOnBehalfOfUserAuthId": 0,
"byOnBehalfOfUserName": null,
"genericServices": [
{
"serviceId": 1,
"name": "data-create",
"isVisible": true,
"usedCount": 0
}
],
"dataIndexIncrement": 0,
"hasLogo": false
}
],
"groupId": 10,
"order": 76,
"dataIndexIncrement": 3
},
"schemaTags": [
{
"name": "",
"path": "/Child/Citizenship",
"isFulltext": true
}
],
"schemaFlags": [
{
"name": "mandatory",
"path": "/ID"
}
],
"fieldsUniques": [
[
""
]
],
"isDraft": false,
"isDisabled": false,
"isArchived": false,
"modifiedAt": "2021-10-03T08:35:01.775915Z",
"byUserName": "ingmar.dev",
"byUserAuthId": 1,
"byOnBehalfOfUserAuthId": 0,
"byOnBehalfOfUserName": null,
"genericServices": [
{
"serviceId": 1,
"name": "data-create",
"isVisible": true,
"usedCount": 0
}
],
"dataIndexIncrement": 0,
"hasLogo": false
}API endpoint that allows user to delete database schema
Id of the database that schema is requested
1Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/eregistrations-devSuccess
DELETE /database/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Accept: */*
Success
SuccessAPI endpoint that allows user to create or modify database schema
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/eregistrations-devGroup name where this schema is located
TestCatalog name where this schema is located
Mother and ChildShort code of the database
MCRSuccess
POST /database/modify HTTP/1.1
Host:
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 518
{
"groupName": "Test",
"catalogName": "Mother and Child",
"code": "MCR",
"schema": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"triggers": [
{
"conditions": [
{
"logic": "==",
"value": "",
"gate": "&&"
}
],
"actions": [
{
"type": "set-value",
"value": "MCTS{indexNoByCode}",
"field_id": 1
}
]
}
],
"primaryKey": true,
"readOnly": true,
"description": "Registration ID",
"example": "MCTS31",
"id": 1
},
"child": {
"type": "string",
"properties": {
"id": {
"type": "string",
"description": "Child ID",
"example": "ID2",
"id": 13
}
}
}
},
"incrementIndex": 20,
"required": [
"ID"
]
}
}Success
{
"type": "object",
"properties": {
"ID": {
"type": "string",
"triggers": [
{
"conditions": [
{
"logic": "==",
"value": "",
"gate": "&&"
}
],
"actions": [
{
"type": "set-value",
"value": "MCTS{indexNoByCode}",
"field_id": 1
}
]
}
],
"primaryKey": true,
"readOnly": true,
"description": "Registration ID",
"example": "MCTS31",
"id": 1
},
"child": {
"type": "string",
"properties": {
"id": {
"type": "string",
"description": "Child ID",
"example": "ID2",
"id": 13
}
}
}
},
"incrementIndex": 20,
"required": [
"ID"
]
}API endpoint that allows user to get information about all databases
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/eregistrations-devGET /databases HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Accept: */*
{
"id": 85,
"name": "Mother and Child",
"code": "MCTS",
"databases": [
{
"id": 353,
"version": "2.7",
"name": "MCTS",
"description": "Database holding information about MCTS objects",
"institution": "Ministry of Social Affairs",
"numberFormat": "{code}{indexNoByCode}",
"schema": {
"id": 85,
"name": "Mother and Child",
"code": "MCTS",
"databases": [
{
"id": 353,
"version": "2.7",
"name": "MCTS",
"description": "Database holding information about MCTS objects",
"institution": "Ministry of Social Affairs",
"numberFormat": "{code}{indexNoByCode}",
"schema": "[Circular Reference]",
"schemaTags": [
{
"name": "",
"path": "/Child/Citizenship",
"isFulltext": true
}
],
"schemaFlags": [
{
"name": "mandatory",
"path": "/ID"
}
],
"fieldsUniques": [
[
""
]
],
"isDraft": false,
"isDisabled": false,
"isArchived": false,
"modifiedAt": "2021-10-03T08:35:01.775915Z",
"byUserName": "ingmar.dev",
"byUserAuthId": 1,
"byOnBehalfOfUserAuthId": 0,
"byOnBehalfOfUserName": null,
"genericServices": [
{
"serviceId": 1,
"name": "data-create",
"isVisible": true,
"usedCount": 0
}
],
"dataIndexIncrement": 0,
"hasLogo": false
}
],
"groupId": 10,
"order": 76,
"dataIndexIncrement": 3
},
"schemaTags": [
{
"name": "",
"path": "/Child/Citizenship",
"isFulltext": true
}
],
"schemaFlags": [
{
"name": "mandatory",
"path": "/ID"
}
],
"fieldsUniques": [
[
""
]
],
"isDraft": false,
"isDisabled": false,
"isArchived": false,
"modifiedAt": "2021-10-03T08:35:01.775915Z",
"byUserName": "ingmar.dev",
"byUserAuthId": 1,
"byOnBehalfOfUserAuthId": 0,
"byOnBehalfOfUserName": null,
"genericServices": [
{
"serviceId": 1,
"name": "data-create",
"isVisible": true,
"usedCount": 0
}
],
"dataIndexIncrement": 0,
"hasLogo": false
}
],
"groupId": 10,
"order": 76,
"dataIndexIncrement": 3
}Searches (Regex supported) and returns multiple records as an array-list.
Field for searching random string type data from database
JohnField name that user wishes to filter
FirstNameHow user wishes to order the data
descendingResult page number
1Number of results on one page
10Example of searchable database field. If more searchable fields are in DB, then more similar fields will follow in input
Value can be in any supported format, for an example 'string'Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesGET /data/{registryName}/{versionNumber} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Accept: */*
{
"count": 1,
"next": 1,
"previous": "https://example.com",
"results": [
{
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
]
}Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesPOST /data/mcts/createEntries HTTP/1.1
Host:
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 639
{
"write": [
{
"content": {
"start": "2021-10-03T07:03:36Z",
"expiry": "2021-10-03T07:03:36Z",
"child": {
"citizenId": "ID2",
"firstName": "Usha",
"lastNames": "Bajaj",
"birthdate": "2021-10-03T07:03:36Z",
"address": "Longroad 123, Welltown, Ethiopia",
"nationality": "ET",
"birthCertificate": {
"url": "text",
"originalName": "text",
"type": "text"
},
"gender": "Male"
},
"caretaker": {
"citizenId": "ID1",
"firstName": "Sowmya",
"lastNames": "Bajaj",
"birthdate": "2021-10-03T07:03:36Z",
"phone": "+3725278511",
"email": "[email protected]",
"picture": {
"url": "text",
"originalName": "text",
"type": "text"
},
"citizenIdDoc": {
"url": "text",
"originalName": "text",
"type": "text"
}
},
"paymentId": "text"
}
}
]
}{
"receive": [
{
"content": {
"id": "MCTS31",
"start": "2021-10-03T07:03:36Z",
"expiry": "2021-10-03T07:03:36Z",
"child": {
"citizenId": "ID2",
"firstName": "Usha",
"lastNames": "Bajaj",
"birthdate": "2021-10-03T07:03:36Z",
"address": "Longroad 123, Welltown, Ethiopia",
"nationality": "ET",
"birthCertificate": {
"url": "text",
"originalName": "text",
"type": "text"
},
"gender": "Male"
},
"caretaker": {
"citizenId": "ID1",
"firstName": "Sowmya",
"lastNames": "Bajaj",
"birthdate": "2021-10-03T07:03:36Z",
"phone": "+3725278511",
"email": "[email protected]",
"picture": {
"url": "text",
"originalName": "text",
"type": "text"
},
"citizenIdDoc": {
"url": "text",
"originalName": "text",
"type": "text"
}
},
"paymentId": "text"
},
"createdAt": "2025-11-15T02:06:39.303Z",
"modifiedAt": "2025-11-15T02:06:39.303Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
]
}Searches and returns one record.
Format is: INSTANCE/CLASS/MEMBER/SUBSYSTEM
eGovStack/GOV/90000009/digitalregistriesRecord not found
POST /data/{registryName}/{versionNumber}/read HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Information-Mediator-Client: text
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"query": {
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
}
}{
"content": {
"id": "EE378627348834",
"firstName": "John Helmut",
"lastName": "Smith Carry",
"birthCertificateId": "RR-1234567889"
}
}Last updated
Was this helpful?