# 8 Service APIs ## 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](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 Consent Building Block can be found in [this GitHub repository](https://github.com/GovStackWorkingGroup/bb-consent/tree/main/test). ## 8.1 API specification The following is an automated rendition of the [OpenAPI YAML specification contained in this release](https://github.com/GovStackWorkingGroup/bb-consent/tree/v23Q4/api/consent-openapi.yaml). You can see the latest unreleased version of the OpenAPI specification in [the main branch of our GitHub repository](https://github.com/GovStackWorkingGroup/bb-consent/blob/main/api/consent-openapi.yaml). ### 8.1.1 Config APIs {% openapi src="" path="/config/policy/" method="post" %} {% endopenapi %} {% openapi src="" path="/config/policy/{policyId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/config/policy/{policyId}/" method="put" %} {% endopenapi %} {% openapi src="" path="/config/policy/{policyId}/" method="delete" %} {% endopenapi %} {% openapi src="" path="/config/policy/{policyId}/revisions/" method="get" %} {% endopenapi %} {% openapi src="" path="/config/policies/" method="get" %} {% endopenapi %} {% openapi src="" path="/config/data-agreement/{dataAgreementId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/config/data-agreement/{dataAgreementId}/" method="put" %} {% endopenapi %} {% openapi src="" path="/config/data-agreement/{dataAgreementId}/" method="delete" %} {% endopenapi %} {% openapi src="" path="/config/data-agreement/" method="post" %} {% endopenapi %} {% openapi src="" path="/config/data-agreements/" method="get" %} {% endopenapi %} {% openapi src="" path="/config/individual/" method="post" %} {% endopenapi %} {% openapi src="" path="/config/individual/{individualId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/config/individuals/" method="get" %} {% endopenapi %} {% openapi src="" path="/config/webhook/" method="post" %} {% endopenapi %} {% openapi src="" path="/config/webhook/{webhookId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/config/webhook/{webhookId}/" method="put" %} {% endopenapi %} {% openapi src="" path="/config/webhook/{webhookId}/" method="delete" %} {% endopenapi %} {% openapi src="" path="/config/webhooks/" method="get" %} {% endopenapi %} ### 8.1.2 Service APIs {% openapi src="" path="/service/individual/" method="post" %} {% endopenapi %} {% openapi src="" path="/service/individual/{individualId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/individual/{individualId}/" method="put" %} {% endopenapi %} {% openapi src="" path="/service/individuals/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/data-agreement/{dataAgreementId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/policy/{policyId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/verification/data-agreements/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/verification/consent-records/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/verification/consent-record/{consentRecordId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/data-agreement/{dataAgreementId}/" method="post" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/data-agreement/{dataAgreementId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/consent-record/draft/" method="post" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/consent-record/" method="post" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/consent-record/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/consent-record/{consentRecordId}/" method="put" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/consent-record/{consentRecordId}/signature/" method="post" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/consent-record/{consentRecordId}/signature/" method="put" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/data-agreement/{dataAgreementId}/all/" method="get" %} {% endopenapi %} {% openapi src="" path="/service/individual/record/" method="delete" %} {% endopenapi %} ### 8.1.3 Audit APIs {% openapi src="" path="/audit/consent-records/" method="get" %} {% endopenapi %} {% openapi src="" path="/audit/consent-record/{consentRecordId}/" method="get" %} {% endopenapi %} {% openapi src="" path="/audit/data-agreements/" method="get" %} {% endopenapi %} {% openapi src="" path="/audit/data-agreement/{dataAgreementId}/" method="get" %} {% endopenapi %} --- # Agent Instructions: 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: ``` GET https://consent.govstack.global/8-service-apis.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.