8 Service APIs
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
Was this helpful?
23Q4.1
This section provides a reference for APIs that should be implemented by this Building Block.
Last updated
Was this helpful?
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.
The following is an automated rendition of the OpenAPI YAML specification contained in this release.
You can see the latest unreleased version of the OpenAPI specification in the main branch of our GitHub repository.
READ - get a Policy object + latest Revisio
Unique ID of an object
An object with id revisionId
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/'{
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}DELETE - Deletes an existing Policy object, returning a new revision. Deleting a Policy is not possible if it's associated with active DataAgreement.
Unique ID of an object
curl -L \
--request DELETE \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/'{
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}LIST - returns the current Policy
Unique ID of an object
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/revisions/'{
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
}
}LIST - Fetches list of readable Policy objects
An object with id revisionId
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policies/'{
"policies": [
{
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
}
]
}A list of Policy objects readable for the current session's credentials.
READ - fetches the latest version of an Agreement
Unique ID of an object
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/'{
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}Unique ID of an object
curl -L \
--request DELETE \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/'{
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}LIST - fetch all DataAgreements
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreements/'{
"dataAgreement": [
{
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
]
}READ - Fetch an Individual in the Consent system
Unique ID of an object
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/individual/{individualId}/'{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}LIST - lists individuals in the system
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/individuals/'{
"individuals": [
{
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
]
}READ - get a Webhook object.
Unique ID of an object
An object with id revisionId
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhook/{webhookId}/'{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}DELETE - Deletes an existing Webhook object.
Unique ID of an object
curl -L \
--request DELETE \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhook/{webhookId}/'No body
LIST - Fetches list of readable Webhook objects
An object with id revisionId
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhooks/'{
"webhooks": [
{
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
]
}A list of Webhook objects readable for the current session's credentials.
READ - Fetch an Individual in the Consent system
Unique ID of an object
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/'{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}LIST - lists individuals in the system
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individuals/'{
"individuals": [
{
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
]
}READ - fetches the latest version of an Agreement
Unique ID of an object
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/data-agreement/{dataAgreementId}/'{
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}READ - fetches the latest version of a Policy and the presented revisionId of an associated Agreement
Unique ID of an object
An object with id revisionId
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/policy/{policyId}/'{
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}LIST - Fetch
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/verification/data-agreements/'{
"dataAgreements": [
{
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
]
}LIST - Fetch consent records (latest revision). For a given ConsentRecordFilter, query if consent exists.
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/verification/consent-records/'{
"consentRecords": [
{
"id": "",
"dataAgreement": "[Circular Reference]",
"dataAgreementRevision": "[Circular Reference]",
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
]
}READ - Reads a consent record by its ID.
Unique ID of an object
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/verification/consent-record/{consentRecordId}/'{
"consentRecord": {
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}CREATE - For a particular Individual and a particular Agreement, create a new Consent Record pointing to the current Revision of a given Agreement. Individual ID supplied as HTTP header.
Unique ID of an object
An object with id individualId
An object with id revisionId
curl -L \
--request POST \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/?individualId=text'{
"consentRecord": {
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}READ - Individual ID supplied as HTTP header. Fetches the current ConsentRecord for an Agreement. There should be one unambiguous ConsentRecord for an Individual and an Agreement.
Unique ID of an object
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/'{
"consentRecord": {
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
}CREATE - Gets a DRAFT (unsaved) ConsentRecord and Signature objects (without a PK) for a given dataAgreementId.
An object with id individualId
An object with id dataAgreementId
An object with id revisionId
curl -L \
--request POST \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/draft/?individualId=text&dataAgreementId=text'{
"consentRecord": {
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}LIST - Fetches all current unambiguous consent records stored for Individual ID. Individual ID supplied as HTTP header.
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/'{
"consentRecords": [
{
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
]
}LIST - Fetches all consent records given to a particular agreement. Individual ID supplied as HTTP header.
Unique ID of an object
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/all/'{
"consentRecords": [
{
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
]
}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.
curl -L \
--request DELETE \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/'No body
LIST - fetch ConsentRecord objects
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//audit/consent-records/'{
"consentRecords": [
{
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
]
}READ
Unique ID of an object
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//audit/consent-record/{consentRecordId}/'{
"consentRecord": {
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
}LIST - fetch all Agreements stored in the system.
Requested index for start of resources to be provided in response requested by client
Requested number of resources to be provided in response requested by client
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//audit/data-agreements/'{
"dataAgreements": [
{
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
]
}READ - fetch a single Agreement.
Unique ID of an object
curl -L \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//audit/data-agreement/{dataAgreementId}/'{
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
}CREATE - Creates a new Policy object and returns the new object and a PolicyRevision
An object of type Policy
curl -L \
--request POST \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/' \
--header 'Content-Type: application/json' \
--data '{
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
}
}'{
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}A set consisting of the new Policy object created, together with the initial Revision object.
UPDATE - Updates an existing Policy object, returning the updated version and a new revision. Updating a Policy must not affect existing active references in DataAgreement, the new Revision should be specified for Agreement.
Unique ID of an object
An object of type Policy
curl -L \
--request PUT \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/' \
--header 'Content-Type: application/json' \
--data '{
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
}
}'{
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}UPDATE - An existing DataAgreement object is created and returned together with a new Revision
Unique ID of an object
An object of type DataAgreement
curl -L \
--request PUT \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/' \
--header 'Content-Type: application/json' \
--data '{
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
}'{
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}CREATE - A new DataAgreement object is created and returned together with a Revision
An object of type DataAgreement
curl -L \
--request POST \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreement/' \
--header 'Content-Type: application/json' \
--data '{
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
}'{
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}CREATE - Creates an Individual in the Consent system
An object of type Individual
curl -L \
--request POST \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/individual/' \
--header 'Content-Type: application/json' \
--data '{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}'{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}CREATE - Creates a new Webhook object and returns the new object
An object of type Webhook
curl -L \
--request POST \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhook/' \
--header 'Content-Type: application/json' \
--data '{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}'{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}A set consisting of the new Webhook object created, together with the initial Revision object.
UPDATE - Updates an existing Webhook object, returning the updated version.
Unique ID of an object
An object of type Webhook
curl -L \
--request PUT \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhook/{webhookId}/' \
--header 'Content-Type: application/json' \
--data '{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}'{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}CREATE - Creates an Individual in the Consent system
An object of type Individual
curl -L \
--request POST \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/' \
--header 'Content-Type: application/json' \
--data '{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}'{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}UPDATE - Updates an Individual in the Consent system
Unique ID of an object
An object of type Individual
curl -L \
--request PUT \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/' \
--header 'Content-Type: application/json' \
--data '{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}'{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}CREATE - Creates a paired ConsentRecord and Signature object. Returns the same objects with the PK defined.
An object of type ConsentRecord
An object of type Signature
curl -L \
--request POST \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/' \
--header 'Content-Type: application/json' \
--data '{
"consentRecord": {
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}'{
"consentRecord": {
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}UPDATE* - Update a particular Consent Record, generating a new Revision object. Individual ID supplied as HTTP header. Note that updating a signed Consent Record invalidates its signature. Field set subject to update is restricted.
Unique ID of an object
An object of type ConsentRecord
curl -L \
--request PUT \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/' \
--header 'Content-Type: application/json' \
--data '{
"consentRecord": {
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
}'{
"consentRecord": {
"id": "",
"dataAgreement": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": {
"id": "",
"version": "",
"controller": {
"id": "",
"name": "",
"url": ""
},
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
},
"purpose": "",
"lawfulBasis": "",
"dataUse": "",
"dpia": "",
"active": "",
"forgettable": "",
"compatibleWithVersion": "[Circular Reference]",
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"dataAgreementRevision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"dataAgreementRevisionHash": "",
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"optIn": "",
"state": "",
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
},
"revision": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}CREATE - Creates and returns a Signature object for the Consent Record with a payload ready for signing. Signature object fieldset is restricted.
Unique ID of an object
An object of type Signature
curl -L \
--request POST \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/signature/' \
--header 'Content-Type: application/json' \
--data '{
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}'{
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}UPDATE - Updates a Signature object for a Consent Record. This is used to add a signature to an existing unsigned Signature object. Consent BB is responsible for updating the Consent Record state. Signature object fieldset is restricted.
Unique ID of an object
An object of type Signature
curl -L \
--request PUT \
--url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/signature/' \
--header 'Content-Type: application/json' \
--data '{
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}'{
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}