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

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

post

/config/policy/

Authorizations

Body

policyobjectrequired

An object of type Policy

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/' \
  --header 'Content-Type: application/json' \
  --data '{
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    }
  }'

200

400

200

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

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

READ - get a Policy object + latest Revisio

READ - get a Policy object + latest Revisio

get

/config/policy/{policyId}//

Authorizations

Path parameters

policyIdstringrequired

Unique ID of an object

Query parameters

revisionIdstring

An object with id revisionId

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/'

200

400

200

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

UPDATE - 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.

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

/config/policy/{policyId}//

Authorizations

Path parameters

policyIdstringrequired

Unique ID of an object

Body

policyobjectrequired

An object of type Policy

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    }
  }'

200

400

200

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

DELETE - Deletes an existing Policy object, returning a new revision. Deleting a Policy is not possible if it's associated with active DataAgreement.

DELETE - Deletes an existing Policy object, returning a new revision. Deleting a Policy is not possible if it's associated with active DataAgreement.

delete

/config/policy/{policyId}//

Authorizations

Path parameters

policyIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/'

200

400

200

{
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

LIST - returns the current Policy

LIST - returns the current Policy

get

/config/policy/{policyId}/revisions/

Authorizations

Path parameters

policyIdstringrequired

Unique ID of an object

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policy/{policyId}/revisions/'

200

400

200

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

Returns a list of readable Policy objects

LIST - Fetches list of readable Policy objects

get

/config/policies/

Authorizations

Query parameters

revisionIdstring

An object with id revisionId

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/policies/'

200

400

200

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

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

READ - fetches the latest version of an Agreement

READ - fetches the latest version of an Agreement

get

/config/data-agreement/{dataAgreementId}//

Authorizations

Path parameters

dataAgreementIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/'

200

400

200

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": "[Circular Reference]",
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

UPDATE - An existing DataAgreement object is created and returned together with a new Revision

UPDATE - An existing DataAgreement object is created and returned together with a new Revision

put

/config/data-agreement/{dataAgreementId}//

Authorizations

Path parameters

dataAgreementIdstringrequired

Unique ID of an object

Body

dataAgreementobjectrequired

An object of type DataAgreement

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  }'

200

400

200

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": "[Circular Reference]",
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

delete

/config/data-agreement/{dataAgreementId}//

Authorizations

Path parameters

dataAgreementIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreement/{dataAgreementId}/'

200

400

200

{
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

CREATE - A new DataAgreement object is created and returned together with a Revision

CREATE - A new DataAgreement object is created and returned together with a Revision

post

/config/data-agreement/

Authorizations

Body

dataAgreementobjectrequired

An object of type DataAgreement

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreement/' \
  --header 'Content-Type: application/json' \
  --data '{
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  }'

200

400

200

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": "[Circular Reference]",
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

LIST - fetch all DataAgreements

LIST - fetch all DataAgreements

get

/config/data-agreements/

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/data-agreements/'

200

400

200

{
  "dataAgreement": [
    {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

CREATE - Creates an Individual in the Consent system

CREATE - Creates an Individual in the Consent system

post

/config/individual/

Authorizations

Body

individualobjectrequired

An object of type Individual

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/individual/' \
  --header 'Content-Type: application/json' \
  --data '{
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    }
  }'

200

400

200

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

READ - Fetch an Individual in the Consent system

READ - Fetch an Individual in the Consent system

get

/config/individual/{individualId}//

Authorizations

Path parameters

individualIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/individual/{individualId}/'

200

400

200

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

LIST - lists individuals in the system

LIST - lists individuals in the system

get

/config/individuals/

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/individuals/'

200

400

200

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

CREATE - Creates a new Webhook object and returns the new object

CREATE - Creates a new Webhook object and returns the new object

post

/config/webhook/

Authorizations

Body

webhookobjectrequired

An object of type Webhook

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhook/' \
  --header 'Content-Type: application/json' \
  --data '{
    "webhook": {
      "id": "",
      "payloadUrl": "",
      "contentType": "",
      "disabled": "",
      "secretKey": ""
    }
  }'

200

400

200

{
  "webhook": {
    "id": "",
    "payloadUrl": "",
    "contentType": "",
    "disabled": "",
    "secretKey": ""
  }
}

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

READ - get a Webhook object.

READ - get a Webhook object.

get

/config/webhook/{webhookId}//

Authorizations

Path parameters

webhookIdstringrequired

Unique ID of an object

Query parameters

revisionIdstring

An object with id revisionId

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhook/{webhookId}/'

200

400

200

{
  "webhook": {
    "id": "",
    "payloadUrl": "",
    "contentType": "",
    "disabled": "",
    "secretKey": ""
  }
}

UPDATE - Updates an existing Webhook object, returning the updated version.

UPDATE - Updates an existing Webhook object, returning the updated version.

put

/config/webhook/{webhookId}//

Authorizations

Path parameters

webhookIdstringrequired

Unique ID of an object

Body

webhookobjectrequired

An object of type Webhook

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhook/{webhookId}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "webhook": {
      "id": "",
      "payloadUrl": "",
      "contentType": "",
      "disabled": "",
      "secretKey": ""
    }
  }'

200

400

200

{
  "webhook": {
    "id": "",
    "payloadUrl": "",
    "contentType": "",
    "disabled": "",
    "secretKey": ""
  }
}

DELETE - Deletes an existing Webhook object.

DELETE - Deletes an existing Webhook object.

delete

/config/webhook/{webhookId}//

Authorizations

Path parameters

webhookIdstringrequired

Unique ID of an object

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhook/{webhookId}/'

200

400

200

No body

Returns a list of readable Webhook objects

LIST - Fetches list of readable Webhook objects

get

/config/webhooks/

Authorizations

Query parameters

revisionIdstring

An object with id revisionId

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//config/webhooks/'

200

400

200

{
  "webhooks": [
    {
      "id": "",
      "payloadUrl": "",
      "contentType": "",
      "disabled": "",
      "secretKey": ""
    }
  ]
}

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

8.1.2 Service APIs

CREATE - Creates an Individual in the Consent system

CREATE - Creates an Individual in the Consent system

post

/service/individual/

Authorizations

Body

individualobjectrequired

An object of type Individual

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/' \
  --header 'Content-Type: application/json' \
  --data '{
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    }
  }'

200

400

200

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

READ - Fetch an Individual in the Consent system

READ - Fetch an Individual in the Consent system

get

/service/individual/{individualId}//

Authorizations

Path parameters

individualIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/'

200

400

200

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

UPDATE - Updates an Individual in the Consent system

UPDATE - Updates an Individual in the Consent system

put

/service/individual/{individualId}//

Authorizations

Path parameters

individualIdstringrequired

Unique ID of an object

Body

individualobjectrequired

An object of type Individual

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/{individualId}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    }
  }'

200

400

200

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

LIST - lists individuals in the system

LIST - lists individuals in the system

get

/service/individuals/

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individuals/'

200

400

200

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

READ - fetches the latest version of an Agreement

READ - fetches the latest version of an Agreement

get

/service/data-agreement/{dataAgreementId}//

Authorizations

Path parameters

dataAgreementIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/data-agreement/{dataAgreementId}/'

200

400

200

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": "[Circular Reference]",
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

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

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

get

/service/policy/{policyId}//

Authorizations

Path parameters

policyIdstringrequired

Unique ID of an object

Query parameters

revisionIdstring

An object with id revisionId

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/policy/{policyId}/'

200

400

200

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

LIST - Fetch

LIST - Fetch

get

/service/verification/data-agreements/

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/verification/data-agreements/'

200

400

200

{
  "dataAgreements": [
    {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

LIST - Fetch consent records (latest revision). For a given ConsentRecordFilter, query if consent exists.

LIST - Fetch consent records (latest revision). For a given ConsentRecordFilter, query if consent exists.

get

/service/verification/consent-records/

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/verification/consent-records/'

200

400

200

{
  "consentRecords": [
    {
      "id": "",
      "dataAgreement": "[Circular Reference]",
      "dataAgreementRevision": "[Circular Reference]",
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

READ - Reads a consent record by its ID.

READ - Reads a consent record by its ID.

get

/service/verification/consent-record/{consentRecordId}//

Authorizations

Path parameters

consentRecordIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/verification/consent-record/{consentRecordId}/'

200

400

200

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": "[Circular Reference]",
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

CREATE - For a particular Individual and a particular Agreement, create a new Consent Record pointing to the current Revision of a given Agreement. Individual ID supplied as HTTP header.

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

/service/individual/record/data-agreement/{dataAgreementId}//

Authorizations

Path parameters

dataAgreementIdstringrequired

Unique ID of an object

Query parameters

individualIdstringrequired

An object with id individualId

revisionIdstring

An object with id revisionId

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/?individualId=text'

200

400

200

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": "[Circular Reference]",
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

READ - Individual ID supplied as HTTP header. Fetches the current ConsentRecord for an Agreement. There should be one unambiguous ConsentRecord for an Individual and an Agreement.

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

/service/individual/record/data-agreement/{dataAgreementId}//

Authorizations

Path parameters

dataAgreementIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/'

200

400

200

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": "[Circular Reference]",
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }
}

CREATE - Gets a DRAFT (unsaved) ConsentRecord and Signature objects (without a PK) for a given dataAgreementId.

CREATE - Gets a DRAFT (unsaved) ConsentRecord and Signature objects (without a PK) for a given dataAgreementId.

post

/service/individual/record/consent-record/draft/

Authorizations

Query parameters

individualIdstringrequired

An object with id individualId

dataAgreementIdstringrequired

An object with id dataAgreementId

revisionIdstring

An object with id revisionId

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/draft/?individualId=text&dataAgreementId=text'

200

400

200

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": "[Circular Reference]",
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "signature": {
    "id": "",
    "payload": "",
    "signature": "",
    "verificationMethod": "",
    "verificationPayload": "",
    "verificationPayloadHash": "",
    "verificationArtifact": "",
    "verificationSignedBy": "",
    "verificationSignedAs": "",
    "verificationJwsHeader": "",
    "timestamp": "",
    "signedWithoutObjectReference": "",
    "objectType": "",
    "objectReference": ""
  }
}

CREATE - Creates a paired ConsentRecord and Signature object. Returns the same objects with the PK defined.

CREATE - Creates a paired ConsentRecord and Signature object. Returns the same objects with the PK defined.

post

/service/individual/record/consent-record/

Authorizations

Body

consentRecordobjectrequired

An object of type ConsentRecord

signatureobjectrequired

An object of type Signature

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/' \
  --header 'Content-Type: application/json' \
  --data '{
    "consentRecord": {
      "id": "",
      "dataAgreement": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": "[Circular Reference]",
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "dataAgreementRevision": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": "[Circular Reference]",
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }'

200

400

200

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": "[Circular Reference]",
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  },
  "signature": {
    "id": "",
    "payload": "",
    "signature": "",
    "verificationMethod": "",
    "verificationPayload": "",
    "verificationPayloadHash": "",
    "verificationArtifact": "",
    "verificationSignedBy": "",
    "verificationSignedAs": "",
    "verificationJwsHeader": "",
    "timestamp": "",
    "signedWithoutObjectReference": "",
    "objectType": "",
    "objectReference": ""
  }
}

LIST - Fetches all current unambiguous consent records stored for Individual ID. Individual ID supplied as HTTP header.

LIST - Fetches all current unambiguous consent records stored for Individual ID. Individual ID supplied as HTTP header.

get

/service/individual/record/consent-record/

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/'

200

400

200

{
  "consentRecords": [
    {
      "id": "",
      "dataAgreement": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": "[Circular Reference]",
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "dataAgreementRevision": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": "[Circular Reference]",
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

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.

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

/service/individual/record/consent-record/{consentRecordId}//

Authorizations

Path parameters

consentRecordIdstringrequired

Unique ID of an object

Body

consentRecordobjectrequired

An object of type ConsentRecord

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/' \
  --header 'Content-Type: application/json' \
  --data '{
    "consentRecord": {
      "id": "",
      "dataAgreement": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": "[Circular Reference]",
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "dataAgreementRevision": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": "[Circular Reference]",
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  }'

200

400

200

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": "[Circular Reference]",
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  },
  "revision": {
    "id": "",
    "schemaName": "",
    "objectId": "",
    "signedWithoutObjectId": "",
    "serializedSnapshot": "",
    "serializedHash": "",
    "timestamp": "",
    "authorizedByIndividual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "authorizedByOther": "",
    "successor": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": "[Circular Reference]",
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "predecessorHash": "",
    "predecessorSignature": ""
  }
}

CREATE - Creates and returns a Signature object for the Consent Record with a payload ready for signing. Signature object fieldset is restricted.

CREATE - Creates and returns a Signature object for the Consent Record with a payload ready for signing. Signature object fieldset is restricted.

post

/service/individual/record/consent-record/{consentRecordId}/signature/

Authorizations

Path parameters

consentRecordIdstringrequired

Unique ID of an object

Body

signatureobjectrequired

An object of type Signature

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/signature/' \
  --header 'Content-Type: application/json' \
  --data '{
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }'

200

400

200

{
  "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.

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

/service/individual/record/consent-record/{consentRecordId}/signature/

Authorizations

Path parameters

consentRecordIdstringrequired

Unique ID of an object

Body

signatureobjectrequired

An object of type Signature

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/consent-record/{consentRecordId}/signature/' \
  --header 'Content-Type: application/json' \
  --data '{
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }'

200

400

200

{
  "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.

LIST - Fetches all consent records given to a particular agreement. Individual ID supplied as HTTP header.

get

/service/individual/record/data-agreement/{dataAgreementId}/all/

Authorizations

Path parameters

dataAgreementIdstringrequired

Unique ID of an object

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/data-agreement/{dataAgreementId}/all/'

200

400

200

{
  "consentRecords": [
    {
      "id": "",
      "dataAgreement": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": "[Circular Reference]",
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "dataAgreementRevision": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": "[Circular Reference]",
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

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

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

/service/individual/record/

Authorizations

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//service/individual/record/'

200

400

200

No body

8.1.3 Audit APIs

LIST - fetch ConsentRecord objects

LIST - fetch ConsentRecord objects

get

/audit/consent-records/

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//audit/consent-records/'

200

400

200

{
  "consentRecords": [
    {
      "id": "",
      "dataAgreement": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": {
          "id": "",
          "version": "",
          "controller": {
            "id": "",
            "name": "",
            "url": ""
          },
          "policy": {
            "id": "",
            "name": "",
            "version": "",
            "url": "",
            "jurisdiction": "",
            "industrySector": "",
            "dataRetentionPeriodDays": "",
            "geographicRestriction": "",
            "storageLocation": ""
          },
          "purpose": "",
          "lawfulBasis": "",
          "dataUse": "",
          "dpia": "",
          "active": "",
          "forgettable": "",
          "compatibleWithVersion": "[Circular Reference]",
          "lifecycle": {
            "id": "",
            "name": ""
          },
          "signature": {
            "id": "",
            "payload": "",
            "signature": "",
            "verificationMethod": "",
            "verificationPayload": "",
            "verificationPayloadHash": "",
            "verificationArtifact": "",
            "verificationSignedBy": "",
            "verificationSignedAs": "",
            "verificationJwsHeader": "",
            "timestamp": "",
            "signedWithoutObjectReference": "",
            "objectType": "",
            "objectReference": ""
          }
        },
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "dataAgreementRevision": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": {
          "id": "",
          "schemaName": "",
          "objectId": "",
          "signedWithoutObjectId": "",
          "serializedSnapshot": "",
          "serializedHash": "",
          "timestamp": "",
          "authorizedByIndividual": {
            "id": "",
            "externalId": "",
            "externalIdType": "",
            "identityProviderId": ""
          },
          "authorizedByOther": "",
          "successor": "[Circular Reference]",
          "predecessorHash": "",
          "predecessorSignature": ""
        },
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "dataAgreementRevisionHash": "",
      "individual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "optIn": "",
      "state": "",
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

READ

READ

get

/audit/consent-record/{consentRecordId}//

Authorizations

Path parameters

consentRecordIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//audit/consent-record/{consentRecordId}/'

200

400

200

{
  "consentRecord": {
    "id": "",
    "dataAgreement": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "dataAgreementRevision": {
      "id": "",
      "schemaName": "",
      "objectId": "",
      "signedWithoutObjectId": "",
      "serializedSnapshot": "",
      "serializedHash": "",
      "timestamp": "",
      "authorizedByIndividual": {
        "id": "",
        "externalId": "",
        "externalIdType": "",
        "identityProviderId": ""
      },
      "authorizedByOther": "",
      "successor": {
        "id": "",
        "schemaName": "",
        "objectId": "",
        "signedWithoutObjectId": "",
        "serializedSnapshot": "",
        "serializedHash": "",
        "timestamp": "",
        "authorizedByIndividual": {
          "id": "",
          "externalId": "",
          "externalIdType": "",
          "identityProviderId": ""
        },
        "authorizedByOther": "",
        "successor": "[Circular Reference]",
        "predecessorHash": "",
        "predecessorSignature": ""
      },
      "predecessorHash": "",
      "predecessorSignature": ""
    },
    "dataAgreementRevisionHash": "",
    "individual": {
      "id": "",
      "externalId": "",
      "externalIdType": "",
      "identityProviderId": ""
    },
    "optIn": "",
    "state": "",
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }
}

LIST - fetch all Agreements stored in the system.

LIST - fetch all Agreements stored in the system.

get

/audit/data-agreements/

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//audit/data-agreements/'

200

400

200

{
  "dataAgreements": [
    {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": {
        "id": "",
        "version": "",
        "controller": {
          "id": "",
          "name": "",
          "url": ""
        },
        "policy": {
          "id": "",
          "name": "",
          "version": "",
          "url": "",
          "jurisdiction": "",
          "industrySector": "",
          "dataRetentionPeriodDays": "",
          "geographicRestriction": "",
          "storageLocation": ""
        },
        "purpose": "",
        "lawfulBasis": "",
        "dataUse": "",
        "dpia": "",
        "active": "",
        "forgettable": "",
        "compatibleWithVersion": "[Circular Reference]",
        "lifecycle": {
          "id": "",
          "name": ""
        },
        "signature": {
          "id": "",
          "payload": "",
          "signature": "",
          "verificationMethod": "",
          "verificationPayload": "",
          "verificationPayloadHash": "",
          "verificationArtifact": "",
          "verificationSignedBy": "",
          "verificationSignedAs": "",
          "verificationJwsHeader": "",
          "timestamp": "",
          "signedWithoutObjectReference": "",
          "objectType": "",
          "objectReference": ""
        }
      },
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    }
  ]
}

READ - fetch a single Agreement.

READ - fetch a single Agreement.

get

/audit/data-agreement/{dataAgreementId}//

Authorizations

Path parameters

dataAgreementIdstringrequired

Unique ID of an object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.swaggerhub.com/apis/GovStack/consent-management-bb//audit/data-agreement/{dataAgreementId}/'

200

400

200

{
  "dataAgreement": {
    "id": "",
    "version": "",
    "controller": {
      "id": "",
      "name": "",
      "url": ""
    },
    "policy": {
      "id": "",
      "name": "",
      "version": "",
      "url": "",
      "jurisdiction": "",
      "industrySector": "",
      "dataRetentionPeriodDays": "",
      "geographicRestriction": "",
      "storageLocation": ""
    },
    "purpose": "",
    "lawfulBasis": "",
    "dataUse": "",
    "dpia": "",
    "active": "",
    "forgettable": "",
    "compatibleWithVersion": {
      "id": "",
      "version": "",
      "controller": {
        "id": "",
        "name": "",
        "url": ""
      },
      "policy": {
        "id": "",
        "name": "",
        "version": "",
        "url": "",
        "jurisdiction": "",
        "industrySector": "",
        "dataRetentionPeriodDays": "",
        "geographicRestriction": "",
        "storageLocation": ""
      },
      "purpose": "",
      "lawfulBasis": "",
      "dataUse": "",
      "dpia": "",
      "active": "",
      "forgettable": "",
      "compatibleWithVersion": "[Circular Reference]",
      "lifecycle": {
        "id": "",
        "name": ""
      },
      "signature": {
        "id": "",
        "payload": "",
        "signature": "",
        "verificationMethod": "",
        "verificationPayload": "",
        "verificationPayloadHash": "",
        "verificationArtifact": "",
        "verificationSignedBy": "",
        "verificationSignedAs": "",
        "verificationJwsHeader": "",
        "timestamp": "",
        "signedWithoutObjectReference": "",
        "objectType": "",
        "objectReference": ""
      }
    },
    "lifecycle": {
      "id": "",
      "name": ""
    },
    "signature": {
      "id": "",
      "payload": "",
      "signature": "",
      "verificationMethod": "",
      "verificationPayload": "",
      "verificationPayloadHash": "",
      "verificationArtifact": "",
      "verificationSignedBy": "",
      "verificationSignedAs": "",
      "verificationJwsHeader": "",
      "timestamp": "",
      "signedWithoutObjectReference": "",
      "objectType": "",
      "objectReference": ""
    }
  }
}