---
id: service-agreement-read
title: "Read data agreement"
description: "This endpoint is used to read the data agreement defined by the organisation in consent building block."
sidebar_label: "Read data agreement"
hide_title: true
hide_table_of_contents: true
api: eJztXN1yG7eSfpWuubGUGlE/tmSHderU0pId03FirX7i2kSuBJxpkogwwATAkGJUvDtPso+2T7LVAOaXI1mKdc7F2c2FQ3IGjUaju9H9dUO3UYom0Ty3XMloGF3MuQGUaa64tMANFAZTsAo0shTsHCFllgGbacQMpYUUp1xiCpOVe6r0jEluGJEDLiFR0tBrk4KLlMsZTIRKrgdRHKkctXttnEbDyKBe8ARHJd0zZGkURznTLEOL2kTDX247vF5K/keBMD4BNQUmQU1+x8RGccTpac7sPIojyTKMhhFxXREfE2mNfxRcYxoNrS4wjkwyx4xFw9vIrnIaYqzmchat15/pZZPTSgw9P9jbo/8lSlqUlj6yPBc8cavZ/d0Qc7cNetxi5gbmmhZtuSfTYqkxb7UMy62gH05aL8YdKYxkYzeIJ8alcXthckz4NPDlZASGy5lAyAudK4Ng58xCwiRMsNwpt9sDgBG0pnWqIPkCtWECmEz7hpESfJMxufoGuEz5gqcFE8SLVsVsDqxN8gwTpdPBlYzi6GZHKrvD5Q4JZcIMRsMpEwab2/RLFNgmvfCfThqSiN2GaCUE6kstWt9/JCWIo1wJnqyiOBJsOS3Ea2a4ieIoQztX6cfppSPNEssX9GGq9AytZRNB3wSfYrJKBEaf485G8nRTa9zwjNloGEVxhDcsy91eHh2+eLl/cHCAr5KXyfPJ5HlykLx68e3BxrZG6zgiaXOvTQ+jvj/YG+xtkLqYIwRSpAWWTLytG1bBcs4T2iKNCfLcaRLNYYiPWpDj3qW2p/P2SApYj2tToe35IpnLsw9Ex7mbeihsZWxFeqcybknr+BSk8m9xuVBigel2eza3+V+cjt76mvmCbg27TurU/Q6FTFEHIbsNaFuXmTMhaJqZWqCWmA4APs1RQqKRWfKbrON4YydhwSwaC37y0iRLlz3lQniXjVNWCAsLJgqMwZlvy1GzNCNfzSSkmPAUaXQyZ3KGwC258R7HL3CBwlvvXY7rtLS3h5m39FZaaPH0Nvby5d5+r43JO7Sjn/RJkKSTReVO+jWJZBZeeTpb/qlpxyV92OLejU+VEGrpnT9mC9TgaTsNLfqtrn/2ubW5Ge7uhl8Gicp2c80XLFnt3LHuU9QZk6QaZLrMNrV9gXrV9kEIpy2lpfgiBjNXhUhBKku/MVqN1+WgjWQdYHmGtKDfC81NyhP7KLm+udzg/H2T0Jrih7QwVq/OMbFKP5z0O2TCzhOmcdMpBpJgPM117M7/M6QQgit5ipqr9IStTGM6Li3OUN813/Ojw+405FVAl0Qhd1TJgFOivI6jGaqZZvmcJ2dIq/l64X1XUQTdILmOI2OVZjP8oPwp81WznHtaIEpi6ziyc67TU6btipZ9PmeOaD3LRCmBTN41jQ/7NsJfnUJONL2Nm0B1vQ47NrJW80lhsblRTGtGBlFFekyIj1MXsnZ9Y89+sYpkGb+1j2dDFoM3LLFiBUsK2Ti9KQQmFtPBY/1rk4Onj2UOe/xse5UwPnm84/1xk/e2p63Ix+TzgEtjmUwQrtxEVxEoDVcRm+GVc/stQg9l4m0hBMjGpHWUu7nm+tsGi844UBpu+YLb1cNVNmxqxzRqSlUA05oqYRZnSq8evtBT1EbJnlUdB1L9E5lE5Y/YU+1zvM5qiAaUauv2sjvReh1v2lVbjRue6F47vd86P3BjaaUtavdZW5uJRGN6gtP+mPmOE+T5yaf9Hy4//bx6fX16+OG7F/riv87eDZ8Pjz8MX+0NQyC3uS0aU3L5TPh8nDu183bm89AnYOJgeExrc14J4eMUznDGjfVJ/PCoN1w5d5M7Ttx/n7um9yQe8ModB2V2+OBQvxyw7s0nv0imY+ENas308sFS39Q+RwUmRKZyIVX4vVNBK7sgcMbEr2oi+MzH87s+g2EJPV1wy8SvFEuQHsMu5MVE8ORXy8y1H8wtz5jF6h3iSxYZnRlhEkqAO5OUCTZzhtOexGXo1SR+8MYkpAvN1PuvS+oHR4VkVBiEHZDkp3ed3/jVqEInWH4rCAD5NYBN9TJpgD/ew/tR+NZ+32lvztkJs1/D7oVPphCUrGJkhJPT8Qg05ko77Z6hJHwMU2BTi5rAk9PxKAocnBdZxvTqQYk0TXd5JiDXasEdBteYzlA242c1MRhPFtAmLWxogZpPuUf5mFxBuYfoYyXyd+Rp+EwyW2gnm5ud6fVOplIU5AaqJxsOonzi8KnCzpXmJPMQg6lpJ1HeqgYYCJl5MmcOgQxpasKMI5YVwvJcIFRsme17s9Umkw/Eo9hKKHeGmcZYLyzvuLxmdn48rYb1/PqOmXnnCTGG6euV4zVDY1mWP33kdtgXuX10QqpEnTND2MKEJdekCkZlCKPTcQUYG1hyO1eFJTiWp7B1+v12DClKZb3eMUt7tAKmERhcRalmU3sVxcAHOAAGtTrY4OUpFVyhBUom6k0ut8VDGVKsAG+4scY914wCooHz60HUD5bM7WAwWPea0JRLJiAQrNgzbm9i54ytLhJnsAYYvD//+CMY1JyJEmVRU5hyFKmB256NH8JgMIjhDpXoeep1q+fBiE5pltieR6Uq9Tx6vzTvkKWoY6i0LLzmF/nJb61XiTOcokaZYHjFW9PFKm//0H5tPYDzIJGWmCj1HsDYH3GVKbW94ASnipRGruycdIlk368SW6QTc0fdqZ8lHM3VJtoslWBDA9ybapV5XCVs86SwDkbz0zhPvGQ6NYMNf/cw9cLV+/nku4R/5O/f/vzm7OI/z99/OxgM7neLJTNzZuYe9vPEy6Cglli9ohA+eZeN3M5R9ygPJUW9OhAQq64fe3gGnx4cHu5/Wy3jYO9gMzgcwRKF2LmWainBE6x9hT8YfXxQ1qEG8BMTPPU4phnCxeuTAbiKVcZncwcZ4U3OZIqpc0RgipxONkxbqwxUDY1FjaVzY5BxyTMmwKCTbT06DACJCRrD9GrQFdDp0ziaMR2skgmxaqi+qW2mA6GlHu4JCu32ujZE7xs7Or/j9OHGhW0OVpY1/RAa8DLjMs4671ipO6cevFq2PzlInqcv8HB61KfvvetO9Cq3FbhE2l+u2ymAKzhh5YHdCVI/VNM+V9pdTOkqvyKaG7V1iwWKpVsiKqH2ljBJcYrfkhh4xmYYN6wXbdLlrzr6H8xfytPhNa6Gfx79cD3tE/VrTFjhTk7gLmmcctTP6OT0BJ2BsNUG4uo8j/fKDCR6WNa54HAYNsb7Y94Nc4bEZ5LL2QDG7RCNdba4EkXsUWN3WpZOrUoMKeioOXcIgVDqmrS3yCuPtioDXZ+IwDWumv6yCjF7mJJK7jyEsaTFFwP3ChMNVOiZcXCRiQmJdYgKyCKb0BmLGeMCWJpqNAYN7ARZMjCS5WaurBfrhMvUkKjbnv6JJBxcn/XxzQx1rqnuvwFvPTMtORK+5jeCJjIxMLDqGmV9gBbGKdX4BAwaclkbHtOr9ugRGfJ9aNvZ6O0FvB2/+XAyhPNw9vkquEbhMYQ5z2GCdokhHGhmGw3ByjSs3U/VyNDKczhRMkEtTTh7uKE5cMGkdcp4HPJyX982AzhVxvCJwOrcumos5SqCXQqEkfJri1fRhqDqQ/krnJRw/pUq26UubR7v7XiQHLyTRnfTgv7MiBaD95/OmweUd26wdfb2+OXh/qErPNVJy4MXcLB38GJnb39n//Bif2/4fG+4t/fzZlRe0i0tIHCWFFqjJKioYazcyGfWmXxVOwvbaRRw+8xnGkQN9U6ulZqWId5dke9XwrZjmTokzXg77x7US2ZA4NTCRDB5XZ4mPaGAG01ve16J6zoGeAwYu+DGwzp3g+weSwSX1vezHdJAaiH5qdL2am9KGL6c7CpqQE0NDurI+nO1nD65/4U09+ioJ80dgVllGRLIW/kL2PV5bhVelYbTiLA6sh/AJ3Spba2BvxfGenmJ0s/4sEu5kLz2O1vMAxnbJKHqNTgLQoEt74cCIENRX3jgvXzwOdr5nJgO90anQKgSo022B76SFZpcHqzBmx5lozvIk3QeQ+Kyr9XHVD1D1NTgVbXZZPNU3PjZyrONPCtFk0vXThHkxD1SkWq2lDFFutwaDyG4nQ64QxXuO7/OipRbNuGCWx//JyrLmSXPTg4iVOa/DLS3kLH7e7s+jU+H/pAJTqztMxx2Xm9CKeXyUCccZIpa14ktNwA115CTEqnCtJTJ2TnZfIs1D7HXTVBfRB0d68feDuBDOQ6MdcCnn6Y1wwC6rxlnS2U3S8YkFYB5yBRgqfT1VKilcSrX7Rww3iKpDYJJyxPIkJFJGb+VXlf75ed7Wkqv5BCqyG82KZIHgZlllxQ4nHtk+J4a08NKwIWPQjy1dm8O8bvZfvPYom9oO4ijqoC+ASA+riB77zmR3r8mX/98XG9FT/mFGk9NaKgoZ+5OIx7dfHDnRCWpu6YK7TEnzMwniun0DnD+kbMGqpCWZKHQop8FX15TOcpRzs+b9bMvlzovmmlN6CH9SJROx51ewVQlRej8JQKTMs8anY6f1a3DJvanHuUGBEOUzb4eOSP9OHeFlq+2nFDf+fcwmZ7F/L+t/NNshQKhKui8p//67K7QeATfOLSKJ9/UR6gPjhOW+yJVJ2oPTePGt6yvQkT9zJSd2Vot67TSIdem8CmVVbC/fVc674zsYNvHKAQEXMkrOTLUylml5FeRKRIKaJS+iqh6XmQU+9Sc1+gxhUk8RYocqF3/MU1G3JXD3KpCz46Xp+u59x/Jbp19af4nE/xPTM8D5BF+9T+GStg/seTVmwtUEXezfeKuHuI7MLh7g7rTEHWJFW2JI38V+UoD+S1M5pInTFBHpKHWh8a2MFeJuGow1cqguvPWjZqb4XEjs3pMb8iD+9epZHb6fWV8QYerfKmyiDpfdWrxBIW65ly8O1VPQt9a/pNl8uO0J4XvUfmQlzCRFMJ3erctYFDTo7jeFBODfxQ+uZxgXZzyFakek/pKiZbmgKk/orZC6Y5KA9u+hufLd6M8FytfzztmUjkd5n/6U8C1AVFUTjgojN9cvIWzt8fw6uWrwwHAuHFvhYWW9VAobeMOeJNgbsEU3ouNqWG4Jazm91IAoTuo41f+UuXivs8bgnsX6hV9e751/m60s/+vA8ecjpV+nnRszvIcHWIxtg0HMz7/CK+O9vbh8uLYt6iUvdYBLP2TihHjCrz0prNpDQE6HZ/U7Rblbao2qY+EgjzK/7w4fLHPDvAIXx4efbu3t7f/4pBN9jaLi2dN2IaVVxwIlvZWSgXigEP4xLiKBEhZyoPSs9bK2BvRwBfuwUzbhD2qAEIRzt68vVG+EHusiRgmOKJiwgdMmKL/+jj9fZj2Js83FchDoRqNQ0VsXdlyEUUDO/CQU6JyXiINHWNr83/++LJ5k9W+mtbjeIWtJUKqCA+m2jNd6XF4cOetGtcjSE4qukXhYsZ2nFj/4PMX3yne0+NY9zBR8ERtK87eDl4eHu1tU9O+5rggyMLv+7QQgs7uucP+Kd4hwi/83cM2/QmjEyAvHL7t70v2DNx/1KXFZkyHWit9rFLXMUefm32Snzc7qtpRWj2672ZDtckv9vbWPeR7dKTWi9c9C1+ve3bgUtZep0c0L/4Pi+YMQ9ZJ0NlUFXJTQIePvPD67yWgsjfBQVmowU3TkZFP0gvtuvl/uY1GOf8e6eNn6lV/jUyjHhV27n6hVbMZIRxRG4EkeWSh0yaaoRMH3WIeRrsBRtulGGynciW7t517zWufQS36L0yfYKbCKsI9u/qiV4qZ2mE5H/CZZtIOuNpdHETEffciDpuVuF4PGeMf91D6XIvIh4Nug0tB1SCQ/yFc4vYyrq9xj4IVlx3InXz8dOzq02Tr1B/gFdS1+dRdIeTqf2vR+Q38NJBRsWbiToIpvymbiH7zPMJvsCWV9cVyqxn3BZ2cJbgdAw5mgw7ZIYSBf1upQpNEdq5x9fffXKTeVInbaOK+vS3PvvefLjbX5g6FUGYPfZiOPU8p8ExJRosJqCTozNNFBG5AHb7Q1kVrd+1tqko7Dz0xrkuB7Me3Qv1HtaX1lvDv6p/aulC/vGFT1SDY+p9//Pe2byo5X2LKzdznGXgTGlC6JegKUfb9zKhdDFsYB2+J6Y6hjhXks7K9xa7KujYVmSjmC1clXNtCymfUuQ5LSq2tb4dS1GOWq9Tn4kqoGaceB5RsInxVjgpc7v4rKZSrSDiA09eGHBFWWJX5fM5VDri7jOQ2LDRtzYrQl+A6C8Ed92WNSVBTmpSoB+7meYLS98eXVpCzZI5w4C5ctGW+XC4HzD0eKD3bDWPN7ofx8Zsfz9/s0Jh1DW3V+0C2U0K7pXVVd1ZdyjF4Ptj3N52NzZhs8EN/rGETbO1csapOj3/h35gIGm7xxu7mgnHZuAfrPesvUX0ZoO1bozgadv9qxOc4mitjadjtLUVxl1qs1/TzHwVq5+/jaME09/VMcsDc0Oe0HzpoSmXrLJya23DnH7boXU/pOCV5TefmfPh8TX514w9fuBpBcArEoH+LvEtuG+M3Dvh182z67g05KBa8V+25r53nDh8aAH6bt64T9yzQv42LXe0hfyP1/B5Xf69e90/uHFC5Pf82SYoA3/8FTuD1Iw==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read data agreement</h1>

<MethodEndpoint method={"get"} path={"/service/data-agreement/{dataAgreementId}"}></MethodEndpoint>



This endpoint is used to read the data agreement defined by the organisation in consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreement (based on ISO 27560) retrieved successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"type":"object","properties":{"restrictions":{"type":"array","items":{"type":"object","description":"List of restrictions","x-not-in-database":false,"properties":{"credDefId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"},"schemaId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}}}}}]},"description":"Data attributes contain specifications of exactly what is collected.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revision</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

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.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"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.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n  {\n    \"dataAgreement\": {\n      \"id\": \"65471222e8c7c3bb3c2c8492\",\n      \"version\": \"1.0.0\",\n      \"controllerId\": \"string\",\n      \"controllerUrl\": \"string\",\n      \"controllerName\": \"string\",\n      \"policy\": {\n        \"id\": \"65471222e8c7c3bb3c2c7701\",\n        \"name\": \"Default data policy\",\n        \"version\": \"1.0.0\",\n        \"url\": \"https://example.com/privacy-policy\",\n        \"jurisdiction\": \"EU\",\n        \"industrySector\": \"Healthcare\",\n        \"dataRetentionPeriodDays\": 365,\n        \"geographicRestriction\": \"EU\",\n        \"storageLocation\": \"EU\",\n        \"thirdPartyDataSharing\": true\n      },\n      \"dataAttributes\": [\n        {\n          \"id\": \"65471222e8c7c3bb3c2c8501\",\n          \"name\": \"Name\",\n          \"description\": \"Full name of the individual\",\n          \"sensitivity\": false,\n          \"category\": \"Personal\",\n          \"scope\": \"read\",\n          \"restrictions\": [\n            {\n              \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n              \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n            }\n          ]\n        }\n      ],\n      \"purpose\": \"string\",\n      \"purposeDescription\": \"string\",\n      \"lawfulBasis\": \"\",\n      \"methodOfUse\": \"\",\n      \"dpiaDate\": \"\",\n      \"dpiaSummaryUrl\": \"string\",\n      \"signature\": {\n        \"id\": \"65471222e8c7c3bb3c2c5501\",\n        \"payload\": \"{...}\",\n        \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n        \"verificationMethod\": \"Ed25519Signature2020\",\n        \"verificationPayload\": \"{...}\",\n        \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n        \"verificationArtifact\": \"\",\n        \"verificationSignedBy\": \"did:key:z6Mkf...\",\n        \"verificationSignedAs\": \"individual\",\n        \"verificationJwsHeader\": \"\",\n        \"timestamp\": \"2024-01-15T10:30:00Z\",\n        \"signedWithoutObjectReference\": false,\n        \"objectType\": \"revision\",\n        \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n      },\n      \"active\": \"\",\n      \"forgettable\": \"\",\n      \"compatibleWithVersionId\": \"string\",\n      \"lifecycle\": \"draft\",\n      \"dataUsingServices\": [\n        null\n      ],\n      \"openApiSpecification\": {},\n      \"dataSources\": [\n        null\n      ]\n    },\n    \"revision\": {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    }\n  }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Resource not found

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>