8 Service APIs
This section provides a reference for APIs that should be implemented by this Building Block.
8 Service APIs
This section provides a reference for APIs that should be implemented by this Building Block. The APIs defined here establish a blueprint for how the Building Block will interact with other Building Blocks. Additional APIs may be implemented by the Building Block, but the listed APIs define a minimal set of functionality that should be provided by any implementation of this Building Block.
The GovStack non-functional requirements document provides additional information on how 'adaptors' may be used to translate an existing API to the patterns described here. This section also provides guidance on how candidate products are tested and how GovStack validates a product's API against the API specifications defined here.
The tests for the Consent Building Block can be found in this GitHub repository.
8.1 API specification
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.
8.1.1 Config APIs
CREATE - Creates a new Policy object and returns the new object and a PolicyRevision
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Body
Responses
200
A set consisting of the new Policy object created, together with the initial Revision object.
application/json
400
bad input parameter
post
/config/policy/POST /apis/GovStack/consent-management-bb//config/policy/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 167
{
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}READ - get a Policy object + latest Revisio
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
policyIdstringRequired
Unique ID of an object
Query parameters
revisionIdstringOptional
An object with id revisionId
Responses
200Success
application/json
400
bad input parameter
get
/config/policy/{policyId}/GET /apis/GovStack/consent-management-bb//config/policy/{policyId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}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.
put
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.
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
policyIdstringRequired
Unique ID of an object
Body
Responses
200Success
application/json
400
bad input parameter
put
/config/policy/{policyId}/PUT /apis/GovStack/consent-management-bb//config/policy/{policyId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 167
{
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"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.
delete
DELETE - Deletes an existing Policy object, returning a new revision. Deleting a Policy is not possible if it's associated with active DataAgreement.
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
policyIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
delete
/config/policy/{policyId}/DELETE /apis/GovStack/consent-management-bb//config/policy/{policyId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}LIST - returns the current Policy
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
policyIdstringRequired
Unique ID of an object
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/config/policy/{policyId}/revisions/GET /apis/GovStack/consent-management-bb//config/policy/{policyId}/revisions/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"policy": {
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
}
}LIST - Fetches list of readable Policy objects
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Query parameters
revisionIdstringOptional
An object with id revisionId
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200
A list of Policy objects readable for the current session's credentials.
application/json
400
bad input parameter
get
/config/policies/GET /apis/GovStack/consent-management-bb//config/policies/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"policies": [
{
"id": "",
"name": "",
"version": "",
"url": "",
"jurisdiction": "",
"industrySector": "",
"dataRetentionPeriodDays": "",
"geographicRestriction": "",
"storageLocation": ""
}
]
}READ - fetches the latest version of an Agreement
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
dataAgreementIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
get
/config/data-agreement/{dataAgreementId}/GET /apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": {
"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": ""
}
},
"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": ""
}
},
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}UPDATE - An existing DataAgreement object is created and returned together with a new Revision
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
dataAgreementIdstringRequired
Unique ID of an object
Body
Responses
200Success
application/json
400
bad input parameter
put
/config/data-agreement/{dataAgreementId}/PUT /apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3480
{
"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": {
"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": {
"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": ""
}
},
"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": ""
}
},
"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": {
"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": {
"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": ""
}
},
"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": ""
}
},
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}delete
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
dataAgreementIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
delete
/config/data-agreement/{dataAgreementId}/DELETE /apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}CREATE - A new DataAgreement object is created and returned together with a Revision
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Body
Responses
200Success
application/json
400
bad input parameter
post
/config/data-agreement/POST /apis/GovStack/consent-management-bb//config/data-agreement/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3480
{
"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": {
"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": {
"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": ""
}
},
"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": ""
}
},
"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": {
"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": {
"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": ""
}
},
"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": ""
}
},
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}LIST - fetch all DataAgreements
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/config/data-agreements/GET /apis/GovStack/consent-management-bb//config/data-agreements/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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 an Individual in the Consent system
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Body
Responses
200Success
application/json
400
bad input parameter
post
/config/individual/POST /apis/GovStack/consent-management-bb//config/individual/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}READ - Fetch an Individual in the Consent system
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
individualIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
get
/config/individual/{individualId}/GET /apis/GovStack/consent-management-bb//config/individual/{individualId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}LIST - lists individuals in the system
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/config/individuals/GET /apis/GovStack/consent-management-bb//config/individuals/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"individuals": [
{
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
]
}CREATE - Creates a new Webhook object and returns the new object
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Body
Responses
200
A set consisting of the new Webhook object created, together with the initial Revision object.
application/json
400
bad input parameter
post
/config/webhook/POST /apis/GovStack/consent-management-bb//config/webhook/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}READ - get a Webhook object.
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Path parameters
webhookIdstringRequired
Unique ID of an object
Query parameters
revisionIdstringOptional
An object with id revisionId
Responses
200Success
application/json
400
bad input parameter
get
/config/webhook/{webhookId}/GET /apis/GovStack/consent-management-bb//config/webhook/{webhookId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}UPDATE - Updates an existing Webhook object, returning the updated version.
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Path parameters
webhookIdstringRequired
Unique ID of an object
Body
Responses
200Success
application/json
400
bad input parameter
put
/config/webhook/{webhookId}/PUT /apis/GovStack/consent-management-bb//config/webhook/{webhookId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}{
"webhook": {
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
}DELETE - Deletes an existing Webhook object.
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Path parameters
webhookIdstringRequired
Unique ID of an object
Responses
200Success
No content
400
bad input parameter
delete
/config/webhook/{webhookId}/DELETE /apis/GovStack/consent-management-bb//config/webhook/{webhookId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
LIST - Fetches list of readable Webhook objects
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Query parameters
revisionIdstringOptional
An object with id revisionId
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200
A list of Webhook objects readable for the current session's credentials.
application/json
400
bad input parameter
get
/config/webhooks/GET /apis/GovStack/consent-management-bb//config/webhooks/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"webhooks": [
{
"id": "",
"payloadUrl": "",
"contentType": "",
"disabled": "",
"secretKey": ""
}
]
}8.1.2 Service APIs
CREATE - Creates an Individual in the Consent system
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Body
Responses
200Success
application/json
400
bad input parameter
post
/service/individual/POST /apis/GovStack/consent-management-bb//service/individual/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}READ - Fetch an Individual in the Consent system
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
individualIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
get
/service/individual/{individualId}/GET /apis/GovStack/consent-management-bb//service/individual/{individualId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}UPDATE - Updates an Individual in the Consent system
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
individualIdstringRequired
Unique ID of an object
Body
Responses
200Success
application/json
400
bad input parameter
put
/service/individual/{individualId}/PUT /apis/GovStack/consent-management-bb//service/individual/{individualId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
}LIST - lists individuals in the system
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/service/individuals/GET /apis/GovStack/consent-management-bb//service/individuals/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"individuals": [
{
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
}
]
}READ - fetches the latest version of an Agreement
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
dataAgreementIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
get
/service/data-agreement/{dataAgreementId}/GET /apis/GovStack/consent-management-bb//service/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": {
"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": ""
}
},
"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": ""
}
},
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}READ - fetches the latest version of a Policy and the presented revisionId of an associated Agreement
get
READ - fetches the latest version of a Policy and the presented revisionId of an associated Agreement
Required scopes
This endpoint requires the following scopes:
- : Grants access to org operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
policyIdstringRequired
Unique ID of an object
Query parameters
revisionIdstringOptional
An object with id revisionId
Responses
200Success
application/json
400
bad input parameter
get
/service/policy/{policyId}/GET /apis/GovStack/consent-management-bb//service/policy/{policyId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
}
}LIST - Fetch
Required scopes
This endpoint requires the following scopes:
- : Grants access to data consumer operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/service/verification/data-agreements/GET /apis/GovStack/consent-management-bb//service/verification/data-agreements/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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.
get
LIST - Fetch consent records (latest revision). For a given ConsentRecordFilter, query if consent exists.
Required scopes
This endpoint requires the following scopes:
- : Grants access to data consumer operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/service/verification/consent-records/GET /apis/GovStack/consent-management-bb//service/verification/consent-records/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"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 - Reads a consent record by its ID.
Required scopes
This endpoint requires the following scopes:
- : Grants access to data consumer operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
consentRecordIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
get
/service/verification/consent-record/{consentRecordId}/GET /apis/GovStack/consent-management-bb//service/verification/consent-record/{consentRecordId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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": {
"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": ""
},
"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": {
"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": ""
},
"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.
post
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.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
dataAgreementIdstringRequired
Unique ID of an object
Query parameters
individualIdstringRequired
An object with id individualId
revisionIdstringOptional
An object with id revisionId
Responses
200Success
application/json
400
bad input parameter
post
/service/individual/record/data-agreement/{dataAgreementId}/POST /apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/?individualId=text HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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": {
"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": ""
},
"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": {
"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": ""
},
"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.
get
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.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
dataAgreementIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
get
/service/individual/record/data-agreement/{dataAgreementId}/GET /apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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": {
"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": ""
},
"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.
post
CREATE - Gets a DRAFT (unsaved) ConsentRecord and Signature objects (without a PK) for a given dataAgreementId.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Query parameters
individualIdstringRequired
An object with id individualId
dataAgreementIdstringRequired
An object with id dataAgreementId
revisionIdstringOptional
An object with id revisionId
Responses
200Success
application/json
400
bad input parameter
post
/service/individual/record/consent-record/draft/POST /apis/GovStack/consent-management-bb//service/individual/record/consent-record/draft/?individualId=text&dataAgreementId=text HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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": {
"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": ""
},
"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": ""
}
}CREATE - Creates a paired ConsentRecord and Signature object. Returns the same objects with the PK defined.
post
CREATE - Creates a paired ConsentRecord and Signature object. Returns the same objects with the PK defined.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Body
Responses
200Success
application/json
400
bad input parameter
post
/service/individual/record/consent-record/POST /apis/GovStack/consent-management-bb//service/individual/record/consent-record/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4851
{
"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": {
"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": ""
}
},
"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": {
"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": ""
},
"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": {
"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": ""
}
},
"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": {
"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": ""
},
"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": {
"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": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"predecessorHash": "",
"predecessorSignature": ""
},
"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.
get
LIST - Fetches all current unambiguous consent records stored for Individual ID. Individual ID supplied as HTTP header.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/service/individual/record/consent-record/GET /apis/GovStack/consent-management-bb//service/individual/record/consent-record/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"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": ""
}
}
]
}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.
put
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.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
consentRecordIdstringRequired
Unique ID of an object
Body
Responses
200Success
application/json
400
bad input parameter
put
/service/individual/record/consent-record/{consentRecordId}/PUT /apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4532
{
"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": {
"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": ""
}
},
"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": {
"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": ""
},
"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": {
"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": ""
}
},
"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": {
"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": ""
},
"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": {
"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": ""
},
"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.
post
CREATE - Creates and returns a Signature object for the Consent Record with a payload ready for signing. Signature object fieldset is restricted.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
consentRecordIdstringRequired
Unique ID of an object
Body
Responses
200Success
application/json
400
bad input parameter
post
/service/individual/record/consent-record/{consentRecordId}/signature/POST /apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/signature/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 320
{
"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.
put
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.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
consentRecordIdstringRequired
Unique ID of an object
Body
Responses
200Success
application/json
400
bad input parameter
put
/service/individual/record/consent-record/{consentRecordId}/signature/PUT /apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/signature/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 320
{
"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 consent records given to a particular agreement. Individual ID supplied as HTTP header.
get
LIST - Fetches all consent records given to a particular agreement. Individual ID supplied as HTTP header.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
dataAgreementIdstringRequired
Unique ID of an object
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/service/individual/record/data-agreement/{dataAgreementId}/all/GET /apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/all/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"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.
delete
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.
Required scopes
This endpoint requires the following scopes:
- : Grants access to specific individual read/write operations
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Responses
200Success
No content
400
bad input parameter
delete
/service/individual/record/DELETE /apis/GovStack/consent-management-bb//service/individual/record/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
8.1.3 Audit APIs
LIST - fetch ConsentRecord objects
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/audit/consent-records/GET /apis/GovStack/consent-management-bb//audit/consent-records/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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": {
"id": "",
"schemaName": "",
"objectId": "",
"signedWithoutObjectId": "",
"serializedSnapshot": "",
"serializedHash": "",
"timestamp": "",
"authorizedByIndividual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": ""
},
"authorizedByOther": "",
"successor": "[Circular Reference]",
"predecessorHash": "",
"predecessorSignature": ""
},
"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
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Path parameters
consentRecordIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
get
/audit/consent-record/{consentRecordId}/GET /apis/GovStack/consent-management-bb//audit/consent-record/{consentRecordId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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": {
"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": ""
},
"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.
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Query parameters
offsetintegerOptional
Requested index for start of resources to be provided in response requested by client
limitintegerOptional
Requested number of resources to be provided in response requested by client
Responses
200Success
application/json
400
bad input parameter
get
/audit/data-agreements/GET /apis/GovStack/consent-management-bb//audit/data-agreements/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": ""
}
},
"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.
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Available scopes:
- : Grants global read access
- : Grants global write access
- : Grants access to org operations
- : Grants access to data consumer operations
- : Grants access to specific individual read/write operations
- : Grants access to specific auditor read operations
Path parameters
dataAgreementIdstringRequired
Unique ID of an object
Responses
200Success
application/json
400
bad input parameter
get
/audit/data-agreement/{dataAgreementId}/GET /apis/GovStack/consent-management-bb//audit/data-agreement/{dataAgreementId}/ HTTP/1.1
Host: app.swaggerhub.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"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": {
"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": {
"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": ""
}
},
"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": ""
}
},
"lifecycle": {
"id": "",
"name": ""
},
"signature": {
"id": "",
"payload": "",
"signature": "",
"verificationMethod": "",
"verificationPayload": "",
"verificationPayloadHash": "",
"verificationArtifact": "",
"verificationSignedBy": "",
"verificationSignedAs": "",
"verificationJwsHeader": "",
"timestamp": "",
"signedWithoutObjectReference": "",
"objectType": "",
"objectReference": ""
}
}
}Last updated
Was this helpful?