> For the complete documentation index, see [llms.txt](https://specs.govstack.global/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://specs.govstack.global/registration/7-service-apis.md).

# 8 Service APIs

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](https://govstack.gitbook.io/specification/v/1.0/architecture-and-nonfunctional-requirements/6-onboarding) 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 Registration Building Block can be found in [this GitHub repository](https://github.com/GovStackWorkingGroup/bb-registration/tree/main/test/openAPI).

## 8.1 Online Registration e-services

The available services (i.e. registration processes) and form definitions within such a service can be accessed:

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/services" method="get" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/services/{serviceId}" method="get" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/services/{serviceId}/eForms" method="get" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/eForms/{eFormId}" method="get" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

### 8.1.2 Generic Registration Steps

Going through the registration process as an applicant requires multiple steps available via API endpoints:

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/services/{serviceId}/applications" method="post" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/documents" method="post" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

## 8.2 Processing of Registrations

Operators can access and process existing application files:

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/applications" method="get" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/applications/{fileId}" method="get" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/applications/{fileId}" method="put" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/tasks" method="get" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/tasks/{taskId}" method="get" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

{% openapi src="/files/XwYcKOjA4Ez47TxTAyXs" path="/tasks/{taskId}/complete" method="post" %}
[GovStack\_Registration\_BB\_API.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-af3995f1111ec3ecefc4f6531ae84ab3d00ee5ee%2FGovStack_Registration_BB_API.json?alt=media)
{% endopenapi %}

## 8.3 Development Platform

Currently there are no specifications for API endpoints to manage and design services and workflows.

### Statistics

The statistics API gives Building Block operational statistics, that reference the number of processed applications (per operator, registration, service, date):

{% openapi src="/files/hjflBo2gcZ9lIkcozaiP" path="/data/statistics" method="get" %}
[GovStack\_Registration\_BB\_API\_statistics.json](https://36213314-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpWfQREyQcAzEDeSlmUvc%2Fuploads%2Fgit-blob-5fce491bf32d2e2cc0bcb44fd47575e5292d64c0%2FGovStack_Registration_BB_API_statistics.json?alt=media)
{% endopenapi %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://specs.govstack.global/registration/7-service-apis.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.