Skip to main content

Read data policy

GET 
/service/policy/:policyId

This endpoint is used to read latest version of data policy defined in the organisation in the consent building block.

Request​

Path Parameters

    policyId stringrequired

    Unique ID of an object

Query Parameters

    revisionId stringrequired

    An object with ID revisionId

Responses​

Response Headers
    Schema
      policy object

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

      id string
      name stringrequired

      Name of the policy

      version string

      Version of the policy (it can follow the semver format)

      url stringrequired

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

      jurisdiction string

      Jurisdiction

      industrySector string

      Industry sector

      dataRetentionPeriodDays integer

      Data retention period in days

      geographicRestriction string

      Geographic restriction

      storageLocation string

      Storage location

      thirdPartyDataSharing boolean

      Third party data sharing

      revision object

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

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

      id stringrequired

      Revision ID

      schemaName stringrequired

      Possible values: [dataAgreement, policy, dataAgreementRecord]

      Previously "schema" but for technical reasons should be called "schemaName"

      objectId stringrequired

      The PK of the object that was serialised

      objectData stringrequired

      The object that is serialised

      signedWithoutObjectId boolean

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

      serizalizedSnapshot stringrequired

      Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785. It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.

      serializedHash stringrequired

      Hash of serizalizedSnapshot (SHA-1)

      timestamp stringrequired

      Timestamp of when revisioning happened. It should be ISO 8601 UTC date time

      authorizedByIndividualId string

      Individual ID

      authorizedByOtherId string

      Reference to an admin user that has created this revision

      successorId string

      If this revision is no longer the latest revision, refer to its successor

      predecessorHash string

      Tamper-resistent artifact from previous record, copied from serializedHash

      predecessorSignature string

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

    Loading...
    Last updated on