---
id: service-agreement-list
title: "List all active data agreements"
description: "This endpoint is used to list all active data agreements by the organisation in consent building block. The results are returned with pagination."
sidebar_label: "List all active data agreements"
hide_title: true
hide_table_of_contents: true
api: eJztO+1u3DiSr1LQnzgLWf5InMw0Fotz4mSmM5mkz3Ym2BkHCVsqdXNMkVqScrs36H/3JPdo9ySLIqnPlh07yQGHxc2PjFsSq4rF+q7i5yhDk2peWq5kNInOl9wAyqxUXFrgBiqDGVgFghsLTAhgqeVXCBmzDNhCIxYorYH5GuwSQekFk9wwAgdcQqqkQWlhXnGRcbmAuVDpZQLnSwSNphLWANP0t620xAxW3C6hZAsuHYwkiiNVonY/plk0iQzqK57icY36NTc2iqOSaVagRW2iyR+fB7s6lqDmf2JqPfjpCWi84saDjCNO3/yjQr2O4kiyAqNJ1PtA4z8qrjGLJjkTBuPIpEssWDT5HNl1SZ8bq7lcRJtNPMT9pirmqEHloDFVOjPETXPJS8iVHux0jBCV5wbtnYjg0uICtaciLBe84HYIuk/hr+yaF1UBcoxSfzBQoqMVk3sRQphyVgkbTQ72N5sPtNaUJBKGvj7c36f/pUpalJb+ZGUpeOr4sfenIeo+d6CXmkTBcr+aJLCRAveEWyxMhwx/5lEcWW4FPTjpLtniw7FsBZoE1zIujZNqU2LK80AYMYiB4XIhEMpKl8og2CWzkDIJc6xl3ulNAnAMPbROqSS/Qm2YACazsWWkTn8pmFz/BbjM+BXPKiaIFq2qxRJYH+SpO67kQkZxdL0rld3lcpfYM2cGm1Nqj+2PKJBNeuP/OulwInYnopUQqN9p0fv9hqQqjkoleEqSJNgqr8QzZriJ4qhAu1TZ2/ydA+0tRRRHudILtJbNBf0SPMd0nQqMPsSDI+XZtkq55QWz0SSK4givWVG6s3xy9PjpweHhIf6QPk0fzeeP0sP0h8c/Hm4da7SJI+I29+J0N+gHyX6yvwWKrFYARVJgyVj2ZcMqWC15SkekMUVeOkkiHIboaBk5Hd1qH930xGNxshHW9aHQ8XwRzLvT1wTHWex2KewUbE1ypwpuSep4DlL5r7i8UuIKs4d9bO7wv4iOvvoWfEG2JkNDOnPPoZIZ6sBkdwB97TJLclJzhIW6QvIoCcD7JUpINTJLHogNfFfsOCyYRWPBI69VsnZ+ORfCfRXMGVwxUWEMTn17Lo9lBXk9JiHDlGdIq9MlkwsEbskhOig9/CDwCoXX3psM16zWt7upt/RaWmnx/XXs6dP9g1EdkzdIxzjok8BJx4vGnIxLEvEsfPL9dPm3rh7X8GGHezOeKyHUyht/LK5Qg4ftJLQa17px7EtrSzPZ2wtPklQVe6XmVyxd796w7xnqgkkSDVJdZrvSfoV63bdBCLOe0GpkWQxmqSqRgVSWnjHajZflII2kHWB5gbShPyvNTcZTey++vni3RfmrLqANRR1ZZaxen2Fqlb476J+RCbtMmcZtoxhAgvEwN7GLBE6RYgiu5Aw1V9kJW5vRgGQU36MnR0M0ZFUo+PFAKf7hKiMFzgjyJo4WqBaalUueniLt5tuZ91MDkULjBuQmjoxVmi3wtfJe5puwnHlYIGpgmziyS66zGdN2Tds+WzIHtMUyV0ogkzehsbrCbVfJdQYlwfQ6bgLUzSac2LG1ms8ri92DYlozUogmlGNCvM1dSD+0jSPnxRqQdfzWd8+GNAavWWrFGlYUsnH6UghMLWbJfe1rl4LvH8scjdjZ/i5henJ/w/tmm/a+pW3Axy5D4dJYJlOEC4foIgKl4SJiC7xwZr8H6K5EvKyEANlB2ka523tuf22R6JQDpeGWX3G7vrvIhkMdqEYLqQlgeqhSZnGh9PruG52hNkqO7Op5ADWOyKSqvMeZksnfVnSCAbXYurMcInKJ4lCv+mLcsUS36unt2klJuk8sO9Bu07Y+EanG7ATz8Zj5Bg/y6OT9wa/v3v++fnY5O3r902N9/vfTnyePJs9fT37Yn9R56daxaMzI5DNBsR6X3Imd1zOfiH4HIg4nz2lvziohvM3hFBfcWF/kmDwZDVfOHHJHifvvw1D1vosFvHDuoM4O7xzq1ws2o/nkF8EMNLwDrZte3pnr29LnoMCcwDQmpAm/d5si1R4IXDDxUc0FX/h4fs9nMCylt1fcMvGRYgmSY9iDspoLnn60zFz6xdzygllsviG6ZFWQzwhIKAEeIKkTbOYUp4/EZegNEr94CwnJQjf1/npO/eqgEI8qg7ALkuz0nrMbH42qdIr1r4oKIB9DMa7dJi3w7j18H4Vf/e+d9JacnTD7LeSe+2QKQckmRkY4mU2PQWOptJPuBUqqH2IGLLeoqXgymx5HgYKzqiiYXt8pkSZ0704FlFpdcVfN7KCjWmbAamIwHiygTXu1oSvUPOeYUYGHyTXUZ4g+ViJ7R5aGLySzlXa8ud7NL3cLlaEgM9C82TIQ9RtXn6rsUmlOPA8xmMoHifJOs8BAyMzTJeNUgw1pasqMA1ZUwvJSIDRkmYe3ZqtdIu9Yj2JroZwPM521nlnecHnJHDycNctGnv7MzHLwhgjD7Nna0Vqgsawov3/kdjQWub11TGpYXTJDtYU5Sy9JFIwqEI5n06b0blylWlUWmASewc7sl4cxZCiV9XLHLJ3R2hXPGVxEmWa5vYhi4AkmwKAVBxusPKWCa7RAyUR7yPWx+FKGFGvAa26sce81o4AocXY9sPrOnPmcJMlmVIVyLpmAALAhz7iziZ0xtrpKncIaYPDq7O0bMKg5E3WVReWQcxSZgc8jBz+BJEliuEEkRt562Rp5cUxemqV25FUtSiOvXq3Mz8gy1DE0UhY+85t874/Wi8Qp5qhRphg+8dp0vi77D/qfbRI4CxzpsYlS7wSm3sU1qtS3gnPMFQmNXNslyRLxflwkdkgmlg66Ez9LdTTX5emTVBcbOsW9XKvC11XCMc8r68poHo2zxCumM5Ns2bu7iReuXy3nP6X8LX/18vcXp+f/efbqxyRJbjeLNTFLZpa+7OeB10FBy7F2RyF88iYbuV2iHhEeSopGZSBUrIZ27O4ZfHZ4dHTwY7ONw/3D7eDwGFYoxO6lVCsJHmBrK7xj9PFB3dFL4DcmeObrmGYC589OqCfHDRR8sXQlI7wumczqjpypSvJsmPV2GaAa18/TWBs3BgWXvGACDDretqvDApCYojFMr5Mhg2bfx9BMybFKJsS6I/qm1ZlBCS3z5Z4g0O6sW0X0tnEg87tOHq5d2ObKyrKFH0IDXmdcxmnnDTt1furOu2UH88P0UfYYj/InY/I+uu9Ur0vbFJdI+ut9OwFwDSdsLLDzIO1LlY+Z0uFmalP5DdHccV+2WIBYmyWCEnpvKZMUp/gjiYEXbIFxR3vRpkP6Gtd/Z/oynk0ucT3555NfL/MxVj/DlFXOcwJ3SWPOUT8gz+kBOgVh662Kq7M83iozkOjLss4EB2fYWe/dvFvmFIkvJJeLBKb9EI0NjrhhReyrxs5b1katSQwp6GgpdxUCodQlSW9VNhZtXQe6PhGBS1x37WUTYo4QJZXcvQthaY8uBu4TJjpVoQfGlYtMTJVYV1EJ7eoYsGBcAMsyjcaggd3ASwZGstIslfVsnXPpW9p9S/+dOBxMn/XxzQJ1qWmCYqu89cD0+Ej1NX8QhMjEwMCqS5StA62ME6rpCRg0xg0KjIr28T0y5NuqbafHL8/h5fTF65MJnAXf57vgGoWvISx5CXO0KwzhQDfb6DBWZmHvHlUnQ6v9cKpkilqa4Hu4IRx4xaR1wvg85OW+v20SmClj+Fxg47cuOlu5iGCPAmGk/NriRbTFqNYpf4OREs6+uhmYIEvb7r0fD5KBd9wYHlqQnwXBYvDq/VnXQYWBlZ3Tl8+fHh0cucZTm7TceQOH+4ePd/cPdg+Ozg/2J4/2J/v7v29H5TXcWgMCZWmlNUoqFXWUlRv5wDqVb3pn4TiNAm4f+EyDoKHeLbVSeR3i3RT5fmPZdiozV0kzXs+HjnrFDAjMLcwFk5e1NxkJBdxq+trTSlS3McB9irF+cujWIruvJYJL68fJDmkgjZD81kh7czZ1Gb5GdhF1Sk0dCtrI+kOznTG+f0Wa++TJSJp7DGZdFEhF3sZewJ7Pc5vwqlacToQ14H0C79Gltq0E/lkZ6/klajvjwy7lQvLW7uwwX8h4SBxqPoPTwBTY8XYoFGRYMwoWrHywOX4EKibn3pkUCF1itOnDxHeywpDLnSV426JsTQeFCTuyGBJXY6M+ppkZoqEGL6rdIZvvRY3HVvs2sqwUTa7cOEXgE/eVikyzlYwp0uXW+BKCO+lQd2jCfWfXWZVxy+ZccOvj/1QVJbNk2clAhM78lwvtvcrY7bNd76eziXcywYj1bYarnbeHUHO5dupUB8lR6zax5QagpRpKEiJVmZ4wOT0nne+R5kvs7RDUF6uOjvTnXg/gdb0OjHWFT4+mhyGB4Wd+xrKeZimYpAYwD5kCrJS+zIVaGSdyw8kB4zWSxiCYtDyFAhmplPFH6WV1nH9+pqW2Sq5CFfnDJkHyRWBm2TsKHM58ZfiWHtPdWsCVj0I8tP5sDtG7PX5z36ZvGDuIo6aBvlVAvF9D9lY/kd2+J9//vN9sxUj7JecSTRioqDEP0Yh7Dx/ciKgGdROqMB5zwsxyrpjObijO3xNrgApZDRYqLcZJ8O01VaI8LvlZt3/25VbneTetCTOkbwnSbDqYFcxUWjl18QDmdZ51PJs+aIewTey9HuUGVIaoh6F95Yzk48w1Wr5Zc0J/599DZUY28/+68r+mKxQI9UTPNQzqyfbbJrJn7VdbTX/v8mZs0ZWM7mh5r3EfHCQNqYfSQHerB0ShskxMBwMLN8E7p487I/FOlYBdMS7CHHMD+/CoBk60fg1wItpQf5ryPgn1zH47n+YiBnr4ZdhvBiTXk/s9buxv4mjJzCyELaMB401JFs99/eoBla+awGeIwlkDj+UNXtuvxyDx2m5Bp4mzTVfsgmD54bJ+RjJ+X2Wn4fb07C0cPj16sv/QXXKhUKdKKVzNKyHIii5dzYCYRNAf+0sLfSRzRiFlWbm82N9DGVl4cK/bDl1Dilor/Vxljgn0d3e+4sN2J7avSe3qMfFpmPp4n8RiC/yINWktyLORjW82I8fwToYq0T8x22LN0T0vgvx7saYu2bsIDzU4NAMeed9VaTfk9sfn6LjkvyD9+YFGuJ4h06iPK7t0T2jXbEGOP+oH5sSPIjSgogX6e1O0KNoL0eUe6cluqyfOexNVY9eqTrBQgegwbd6OO2dYqF1W8oQvNJM24Wrv6jDavh51ZskDLG4CY/zrEUgfWo642Sh/njVf2lDIPwgXoDxL28tVx0Emaw80MB2zqavSkuRSldzLo7+81vRGyCN+6sH5BB4NFFSymLvsMOfXdSvtk6cRPsGOVNaXjK1m3Jc1SpbiwxgwWSQDsBMIC/+6VpUmjuxe4vpvn1wc2JWAz9Hc/XpZ+/xX78+39+ZMXCg2h2kER56HFGimalmPCGg46LTR2XO3oB0HoaOjK2gR9TFqtQ6dIVerJ3XxDcH/aI60PRL+U/uoLwvtx1sq1CyCnf/5r/9+6FsrZyvMuFl604/XoQ0zLMQ2eZWf6kGdwNRSrkxBnsh3DfVtkC/qJo9d19VdigOoAhMGBl3xPuMLmt+CFRMCrW8KKuq0lioDi+lSKqEWnCr9KNlc+NoUlXncLRDntskcuDDfV0gcEFZZVfj7Ky5/5m4k1x1YaF0uqlCdd/11cM6rrrQIas1KiTpx969SlH5KrNaCkqVLhEM3dtjn+Wq1Sph7nSi92Atrzd7r6fMXb85e7NKaTRvOtedAulMnOLV2NTc3XFU6eZQc+Ps+xhZMduh5fftd06EsdxzH/8n7q0EvLF7bvVIwLjt3SLz5/SNqB+mGBvhDHC2VsfTR588UtLzTYrOhx/42pzPL3NAhZ+MF8i5/vnATdpTUSzKo/Quxzvr5ez/3wX6fu7C3kNJcif1KMu574fUWUupQvaXkA/3Q3NdhyT3XTocOyi8i21t2V21FO5uuo/7pBZlvFmx769cunV8Lf3SSfCbXHdhDF+dJoH87w9/9JX8l5f0F139rPvdvblzQOAX/NTGIksJ/AVm6u0g=
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"}>List all active data agreements</h1>

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



This endpoint is used to list all active data agreements by the organisation in consent building block. The results are returned with pagination.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination.","in":"query","name":"offset","required":false,"schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Active data agreements (based on ISO 27560) listed 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"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreements</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></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"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreements\": [\n    {\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  ],\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\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={"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>