1 of 1

8 Service APIs

This section provides a reference for APIs that should be implemented by this Building Block.

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 Consent Building Block can be found in this GitHub repository.

8.1 API specification

The following is an automated rendition of our latest OpenAPI YAML specification.

8.2 Service APIs

8.3 Audit APIs

8 Service APIs

This section provides a reference for APIs that should be implemented by this Building Block.

The tests for the Consent Building Block can be found in this GitHub repository.

8.1 API specification

The following is an automated rendition of our latest OpenAPI YAML specification.

CREATE - Creates a new Policy object and returns the new object and a PolicyRevision

POSThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/

Body

policy*Policy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

Response

A set consisting of the new Policy object created, together with the initial Revision object.

Body

policyPolicy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

revisionRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

id*string

Example: ""

schemaName*string

This was previously called "schema" but for technical reasons should be called "schemaName"

Example: ""

objectId*string

The PK of the object that was serialized.

Example: ""

signedWithoutObjectIdboolean

Indicates that objectId was left blank in serializedSnapshot when calculating serializedHash. objectId may be subsequently filled in.

Example: ""

serializedSnapshot*string

Revisioned data (serialized as JSON) as a dict {objectData: {...}, schemaName: ..., objectId: ..., signedWithoutObjectId: ..., timestamp: ..., authorizedByIndividual: ..., authorizedByOther: ...}. It contains all the fields of the schema except id, successor, predessorHash and predecessorSignature.

Example: ""

serializedHash*string

Hash of serializedSnapshot (SHA-1)

Example: ""

timestamp*string

Timestamp of when revisioning happened

Example: ""

authorizedByIndividualIndividual (object)

Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent records.

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

authorizedByOtherstring

Reference to an admin user that has created this revision

Example: ""

successorRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

Circular reference to Revision (object) ↩

predecessorHashstring

Tamper-resistent artifact from previous record, copied from serializedHash

Example: ""

predecessorSignaturestring

Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)

Example: ""

Request

Response

READ - get a Policy object + latest Revisio

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/

Path parameters

policyId*string

Unique ID of an object

Query parameters

revisionIdstring

An object with id revisionId

Response

Body

policyPolicy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

revisionRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

id*string

Example: ""

schemaName*string

This was previously called "schema" but for technical reasons should be called "schemaName"

Example: ""

objectId*string

The PK of the object that was serialized.

Example: ""

signedWithoutObjectIdboolean

Indicates that objectId was left blank in serializedSnapshot when calculating serializedHash. objectId may be subsequently filled in.

Example: ""

serializedSnapshot*string

Example: ""

serializedHash*string

Hash of serializedSnapshot (SHA-1)

Example: ""

timestamp*string

Timestamp of when revisioning happened

Example: ""

authorizedByIndividualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

authorizedByOtherstring

Reference to an admin user that has created this revision

Example: ""

successorRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

Circular reference to Revision (object) ↩

predecessorHashstring

Tamper-resistent artifact from previous record, copied from serializedHash

Example: ""

predecessorSignaturestring

Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)

Example: ""

Request

Response

LIST - returns the current Policy

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/revisions/

Path parameters

policyId*string

Unique ID of an object

Query parameters

offsetinteger

Requested index for start of resources to be provided in response requested by client

limitinteger

Requested number of resources to be provided in response requested by client

Response

Body

policyPolicy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

Request

Response

Returns a list of readable Policy objects

LIST - Fetches list of readable Policy objects

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policies/

Query parameters

revisionIdstring

An object with id revisionId

offsetinteger

Requested index for start of resources to be provided in response requested by client

limitinteger

Requested number of resources to be provided in response requested by client

Response

A list of Policy objects readable for the current session's credentials.

Body

policiesarray of one of

itemsone of

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

Request

Response

8.2 Service APIs

CREATE - Creates an Individual in the Consent system

POSThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/

Body

individual*Individual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Response

Body

individualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Request

Response

READ - Fetch an Individual in the Consent system

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/

Path parameters

individualId*string

Unique ID of an object

Response

Body

individualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Request

Response

UPDATE - Updates an Individual in the Consent system

PUThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/

Path parameters

individualId*string

Unique ID of an object

Body

individual*Individual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Response

Body

individualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Request

Response

LIST - lists individuals in the system

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individuals/

Query parameters

offsetinteger

Requested index for start of resources to be provided in response requested by client

limitinteger

Requested number of resources to be provided in response requested by client

Response

Body

individualsarray of one of

itemsone of

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Request

Response

READ - fetches the latest version of a Policy and the presented revisionId of an associated Agreement

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/policy/{policyId}/

Path parameters

policyId*string

Unique ID of an object

Query parameters

revisionIdstring

An object with id revisionId

Response

Body

policyPolicy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

revisionRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

id*string

Example: ""

schemaName*string

This was previously called "schema" but for technical reasons should be called "schemaName"

Example: ""

objectId*string

The PK of the object that was serialized.

Example: ""

signedWithoutObjectIdboolean

Indicates that objectId was left blank in serializedSnapshot when calculating serializedHash. objectId may be subsequently filled in.

Example: ""

serializedSnapshot*string

Example: ""

serializedHash*string

Hash of serializedSnapshot (SHA-1)

Example: ""

timestamp*string

Timestamp of when revisioning happened

Example: ""

authorizedByIndividualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

authorizedByOtherstring

Reference to an admin user that has created this revision

Example: ""

successorRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

Circular reference to Revision (object) ↩

predecessorHashstring

Tamper-resistent artifact from previous record, copied from serializedHash

Example: ""

predecessorSignaturestring

Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)

Example: ""

Request

Response

DELETE - Cascading delete operation for Right To Be Forgotten, deletes all Consent Records that shall not be retained and have a "forgettable" Agreement. May also delete an unsigned Consent Record, for instance in cases where the user exits the signing process. Individual ID supplied as HTTP header.

DELETE - Cascading delete operation for Right To Be Forgotten, deletes all Consent Records that shall not be retained and have a "forgettable" Agreement. May also delete an unsigned Consent Record, for instance in cases where the user exits the signing process. Individual ID supplied as HTTP header.

DELETEhttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/

Response

Request

8.3 Audit APIs

DELETE - Cascading delete operation for Right To Be Forgotten, deletes all Consent Records that shall not be retained and have a "forgettable" Agreement. May also delete an unsigned Consent Record, for instance in cases where the user exits the signing process. Individual ID supplied as HTTP header.

DELETEhttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/

Response

Request

READ - Fetch an Individual in the Consent system

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/

Path parameters

individualId*string

Unique ID of an object

Response

Body

individualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Request

Response

LIST - lists individuals in the system

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individuals/

Query parameters

offsetinteger

Requested index for start of resources to be provided in response requested by client

limitinteger

Requested number of resources to be provided in response requested by client

Response

Body

individualsarray of one of

itemsone of

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Request

Response

CREATE - Creates an Individual in the Consent system

POSThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/

Body

individual*Individual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Response

Body

individualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Request

Response

UPDATE - Updates an Individual in the Consent system

PUThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/

Path parameters

individualId*string

Unique ID of an object

Body

individual*Individual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Response

Body

individualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

Request

Response

LIST - returns the current Policy

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/revisions/

Path parameters

policyId*string

Unique ID of an object

Query parameters

offsetinteger

Requested index for start of resources to be provided in response requested by client

limitinteger

Requested number of resources to be provided in response requested by client

Response

Body

policyPolicy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

Request

Response

Returns a list of readable Policy objects

LIST - Fetches list of readable Policy objects

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policies/

Query parameters

revisionIdstring

An object with id revisionId

offsetinteger

Requested index for start of resources to be provided in response requested by client

limitinteger

Requested number of resources to be provided in response requested by client

Response

A list of Policy objects readable for the current session's credentials.

Body

policiesarray of one of

itemsone of

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

Request

Response

READ - get a Policy object + latest Revisio

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/

Path parameters

policyId*string

Unique ID of an object

Query parameters

revisionIdstring

An object with id revisionId

Response

Body

policyPolicy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

revisionRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

id*string

Example: ""

schemaName*string

This was previously called "schema" but for technical reasons should be called "schemaName"

Example: ""

objectId*string

The PK of the object that was serialized.

Example: ""

signedWithoutObjectIdboolean

Indicates that objectId was left blank in serializedSnapshot when calculating serializedHash. objectId may be subsequently filled in.

Example: ""

serializedSnapshot*string

Example: ""

serializedHash*string

Hash of serializedSnapshot (SHA-1)

Example: ""

timestamp*string

Timestamp of when revisioning happened

Example: ""

authorizedByIndividualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

authorizedByOtherstring

Reference to an admin user that has created this revision

Example: ""

successorRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

Circular reference to Revision (object) ↩

predecessorHashstring

Tamper-resistent artifact from previous record, copied from serializedHash

Example: ""

predecessorSignaturestring

Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)

Example: ""

Request

Response

CREATE - Creates a new Policy object and returns the new object and a PolicyRevision

POSThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/

Body

policy*Policy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

Response

A set consisting of the new Policy object created, together with the initial Revision object.

Body

policyPolicy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

revisionRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

id*string

Example: ""

schemaName*string

This was previously called "schema" but for technical reasons should be called "schemaName"

Example: ""

objectId*string

The PK of the object that was serialized.

Example: ""

signedWithoutObjectIdboolean

Indicates that objectId was left blank in serializedSnapshot when calculating serializedHash. objectId may be subsequently filled in.

Example: ""

serializedSnapshot*string

Example: ""

serializedHash*string

Hash of serializedSnapshot (SHA-1)

Example: ""

timestamp*string

Timestamp of when revisioning happened

Example: ""

authorizedByIndividualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

authorizedByOtherstring

Reference to an admin user that has created this revision

Example: ""

successorRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

Circular reference to Revision (object) ↩

predecessorHashstring

Tamper-resistent artifact from previous record, copied from serializedHash

Example: ""

predecessorSignaturestring

Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)

Example: ""

Request

Response

READ - fetches the latest version of a Policy and the presented revisionId of an associated Agreement

GEThttps://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/policy/{policyId}/

Path parameters

policyId*string

Unique ID of an object

Query parameters

revisionIdstring

An object with id revisionId

Response

Body

policyPolicy (object)

A policy governs Data Agreements in the realm of an organisation that is often referred to as "data controller" (GDPR) and owner of referencing Data Agreements.

id*string

Example: ""

name*string

Name of the policy

Example: ""

version*string

Version of the policy

Example: ""

url*string

Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time.

Example: ""

jurisdictionstring

Example: ""

industrySectorstring

Example: ""

dataRetentionPeriodDaysinteger

Example: ""

geographicRestrictionstring

Example: ""

storageLocationstring

Example: ""

revisionRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

id*string

Example: ""

schemaName*string

This was previously called "schema" but for technical reasons should be called "schemaName"

Example: ""

objectId*string

The PK of the object that was serialized.

Example: ""

signedWithoutObjectIdboolean

Indicates that objectId was left blank in serializedSnapshot when calculating serializedHash. objectId may be subsequently filled in.

Example: ""

serializedSnapshot*string

Example: ""

serializedHash*string

Hash of serializedSnapshot (SHA-1)

Example: ""

timestamp*string

Timestamp of when revisioning happened

Example: ""

authorizedByIndividualIndividual (object)

id*string

The unique ID of an Individual row.

Example: ""

externalIdstring

Reference to another foundational/functional ID, which is likely PII

Example: ""

externalIdTypestring

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

Example: ""

identityProviderIdstring

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

Example: ""

authorizedByOtherstring

Reference to an admin user that has created this revision

Example: ""

successorRevision (object)

A generic revision model captures the serialized contents of any shema's single row. This is then subject to 1) cryptographic signature and 2) auditing.

Aside from "successor" column, a revision should be considered locked.

Circular reference to Revision (object) ↩

predecessorHashstring

Tamper-resistent artifact from previous record, copied from serializedHash

Example: ""

predecessorSignaturestring

Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)

Example: ""

Request

Response

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individuals/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "individuals": [
    {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    }
  ]
}

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "individual": {
        "id": ""
      }
    }),
});
const data = await response.json();

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "individual": {
        "id": ""
      }
    }),
});
const data = await response.json();

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": ""
  }
}

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/revisions/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  }
}

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policies/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "policies": [
    {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    }
  ]
}

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": ""
      }
    }),
});
const data = await response.json();

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

const response = await fetch('https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/policy/{policyId}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "policy": {
    "id": "",
    "name": "",
    "version": "",
    "url": "",
    "jurisdiction": "",
    "industrySector": "",
    "dataRetentionPeriodDays": "",
    "geographicRestriction": "",
    "storageLocation": ""
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}