---
id: audit-data-agreement-list
title: "Fetch all data agreements"
description: "This endpoint is used to fetch all data agreements defined in the consent building block."
sidebar_label: "Fetch all data agreements"
hide_title: true
hide_table_of_contents: true
api: eJztO9tyGzeyv9I1L5a3yNHFlp2wtraObNkJHcfmkeS4NpErAWd6SEQYYBbAkOKq+Ha+5Hza+ZKtBjBXjmTJ9r5snTw44sygu9HoezduohRNonlhuZLRJLpYcgMo00JxaYEbKA2mYBVkaJMlMCEgZZYBW2jEHKU1kGLGJabAJdglQqKkQWlhXnKRcrmAuVDJVRyNIlWgZoRnmkaTiJUpt6fMspMK1FtubDSKCqZZjha1iSa/3fToe1fmc9SgMtCYKJ0aos1c8QIypaFgCy4dCsLHacE/StSbaBRJlmM0iVSWGSQsGv9Rco1pNMmYMDiKTLLEnEWTm8huCvqUS4sL1NF2O7qplguec9sH3aXwZ3bN8zIHOUSpRltqCQU6WjF+ECGEKWOlsNHk8MBR1cV8IkHN/8TEwprbJUxPQeOKG8/wYXZ0Pvg8JcZqLhfRdvuJvjYFHbWh90cHB/S/REmL0tKfrCgET9xZ7P9piL6bFrxCkzBY7lenbSlwT7jF3LQQ+31Fo8hyK+hBR3B2zuBENgJKAmkZl8ZJpykw4VkgjA6HgeFyIRCKUhfKINgls5AwCfNalp0GxAAn0EHr1EPyFWrDBDCZDi2D+Qb+kjO5+QtwmfIVT0smiBatysUSWBfkmROV+FJGo+h6LJUdczkm9syZwfpcmoP6LQpkk974v05bnBi5E9FKCNQftOj8fkcSMIoKJXhCEiHYOivFC2a4iUZRjnap0vfZBweaJZav6I9M6QVay+aCfgmeYbJJBEafRr0j5emu2LjlObPRJIpGEV6zvHBn+ez46fPDo6Mj/C55njyZz58kR8l3T78/2jnWaDuKiNvci9P9oB/GB/HBDqiLJUIARVJgyex1ZcMqWC852TxSYOSFkyTCYYiOhpHTwa120U1PPRYnG2FdFwodz2fBfDh7S3CcBW6Wwl7ONiR3KueWpI5nIJX/isuVEitMH3exucP/LDr66mvwBdma9A3VzD2HUqaoA5PdAXS1yyzJ28wRFmqFWmIaA3xcooREI7PkWVjPF40chwWzaCx45JVK1m6MC+G+CqYUVkyUOAKnvkovmOTGnz9Lcy7d8hQTniKtTpZMLhC4rZxdFz8IXKHw2nub4ZpV+nY/9ZZeS0stvr2OPX9+cDioY/IW6RgGfRo46XhRm5NhSSKehU++nS7/0tbjCj7scW/GMyWEWnvjj/kKNXjYTkLLYa0bxr60tjCT/f3wJE5Uvl9ovmLJZnzLvmeocyZJNEh1mW1L+wr1pmuDEGYdodXI0hGYpSpFClJZesZoN16WgzSSdoDlOdKG/iw1NylP7IP4+urDDuVv2oC2FD2kpbF6c46JVfr+oH9EJuwyYRp3jWIACcbD3I5cJHCGFENwJWeouUpP2cYMBkOD+J48O+6jIatCgZcHSrEXVy5aTQnydhQtUC00K5Y8OUPazdcz74caIugWyO0oMlZptsC3ynuZr8Jy7mGBqIBtR5Fdcp3OmLYb2vb5kjmgDZa5UgKZvA2N1SXuukquUygIptdxE6But+HETqzVfF5abB8U05qRQtShHBPifeZC+r5tHDgvVoOs4reuezakMXjNEis2sKaQjdOXQmBiMY0fal/bFHz7WOZ4wM52dwnT04cb3ne7tHctbQ1+5LIjLo1lMkG4dIguI1AaLiO2wEtn9juA7kvE61IIkC2kTZS7u+fm1w6JTjlQGm75itvN/UU2HGpPNRpIdQDTQZUwiwulN/ff6Ay1UXJgVy8DqGFEJlHFA86UTP6uohMMqMTWnWUfkUsH+3rVFeOWJbpTT+/WTkrSfVLbgnaXtnWJSDSmp5gNx8y3eJAnpx8Pf/7w8dfNi6vZ8dsfnuqLv5/9OHkyefl28t3BpMqJd45FY0omnwlfoeBO7Lye+UT0GxBxNHlJe3NWCeF9Bme44Mb6Msfk2WC4cu6QO0rcf5/6qvdNLOClcwdVdnjvUL9asB3MJz8LpqfhLWjt9PLeXN+VPgcF5gSmNiF1+D2ui0/7IHDBxO9qLvjCx/P7PoNhCb1dccvE7xRLkBzDPhTlXPDkd8vMlV/MLc+ZxfobokuWOfmMgIQS4B6SKsFmTnG6SFyGXiPxi3eQkCy0U+8v59TPDgrxqDQIY5Bkp/ed3fjdqFInWP0qqQDyu0G94gk226QF3r2H76Pwq/u9k96Cs1Nmv4bcC59MIShZx8gIp7PpCWgslHbSvUBJFURMgWUWNRVPZtOTKFBwXuY505t7JdKE7sOZgEKrFXdVyhY6Q9mMx2pGYDxYQJt0akMr1DzjmFKBh8kNVGeIPlYie0eWhi8ks6V2vLkeZ1fjXKUoyAzUb3YMRPXG1adKu1SaE89DDKayXqK8Vy8wEDLzZMk6NVlmHLC8FJYXAqEmyzy+M1ttE3nPehTbCOV8mGmt9czyhstLZu/hrF428PRHZpa9N0QYpi82jtYcjWV58e0jt+OhyO29Y1LN6oIZqi3MWXJFomBUjnAym9ZFdOOqsaq0wCTwFPZmPz0eQYpSWS93zNIZbYBpBAaXUapZZi+jEfAYY2DQiIMNVp5SwQ1aoGSiOeTqWHwpQ4oN4DU31rj3mlFAFDu7Hlh9b87cxHG8HVShjEsmIACsyTPubEbOGFtdJk5hDTB4c/7+HRjUnImqyqIyyDiK1MDNwMFPII7jEdwiEgNvvWwNvDghL80SO/CqEqWBV2/W5kdkKeoR1FIWPvOb/OiP1ovEGWaoUSYYPvHadLEpug+6n21jOA8c6bCJUu8Ypt7F1arUtYJzzBQJjdzYJckS8X5YJPZIJpYOuhM/S3U0+qJHUlVsaBX3Mq1yX1cJxzwvrSujeTTOEq+ZTk28Y+/uJ164ebOc/5Dw9/zN619fnV389/mb7+M4vtssVsQsmVn6sp8HXgUFDceaHYXwyZts5HaJekB4KCkalIFQserbsftn8OnR8fHh9/U2jg6OdoPDE1ijEOMrqdYSPMDGVnjH6OODqjcXwy9M8NTXMc0ELl6cxuC6eDlfLF3JCK8LJlNMfVvIlAV5Nkw7uwxQDa1FjZVxY5BzyXMmwKDjbbM6LACJCRrD9CbuM2j2bQzNlByrZEJsWqJvGp3pldBSX+4JAu3OulFEbxt7Mj928nDtwjZXVpYN/BAa8CrjMk47b9mp81P33i07nB8lT9KneJw9G5L3wX0nelPYurhE0l/t2wmAazhhbYGdB2leqmzIlPY3U5nKr4jmTrqyxQLEyiwRlNB7S5ikOMUfyQh4zhY4amkv2qRPX+36701fytPJFW4m/3z281U2xOoXmLDSeU7gLmnMOOpH5Dk9QKcgbLNTcXWWx1tlBhJ9WdaZ4OAMW+u9m3fLnCLxheRyEcO0G6Kx3hHXrBj5qrHzlpVRqxNDCjoayl2FQCh1RdJbFrVF21SBrk9E4Ao3bXtZh5gDREklx/chLOnQxcB9wkSrKvTIuHKRGVEl1lVUQqt8BJgzLoClqUZj0MA48JKBkawwS2U9W+dc+nZ619J/Iw4H02d9fLNAXWiahdgpbz0yHT5Sfc0fBCEyI2Bg1RXKxoGWxgnV9BQMGuOGFAZF++QBGfJd1bazk9cX8Hr66u3pBM6D7/NdcI3C1xCWvIA52jWGcKCdbbQYK9Owd4+qlaFVfjhRMkEtTfA93BAOXDFpnTC+DHm572+bGGbKGD4XWPuty9ZWLiPYp0AYKb+2eBntMKpxyl9hpISzr9TZrmRp171340Ey8I4b/UML8rMgWAzefDxvO6gwlLF39vrl8+PDY9d4apKWe2/g6ODo6fjgcHx4fHF4MHlyMDk4+HU3Kq/gVhoQKEtKrVFSqailrNzIR9apfN07C8dpFHD7yGcaBA31uNBKZVWId1vk+5Vl26lMXSXNeD3vO+o1MyAwszAXTF5V3mQgFHCr6WtPK1HdxAAPKcb66Zg7i+y+lggurR8mO6SBNELySy3t9dlUZfgK2WXUKjW1KGgi60/1dob4/gVp7rNnA2nuCZhNniMVeWt7Afs+z63Dq0pxWhFWj/cxfESX2jYS+GdprOeXqOyMD7uUC8kbu7PHfCHjMXGo/gzOAlNgz9uhUJBh9bhTsPLB5vjxqxE599akQOgSo00ex76TFYZc7i3BuxZlZzrIg3QWQ+J6aNTH1DNDNNTgRbU9ZPOtqPHYKt9GlpWiybUbpwh84r5SkWq2liOKdLk1voTgTjrUHepw39l1N8TH5lxw6+P/ROUFs2TZyUCEzvznC+2dytjds10fp7OJdzLBiHVthqudN4dQcbly6lQHyVDrJrHlBqChGgoSIlWajjA5PSed75DmS+zNENRnq46O9JdeD+BttQ6MdYVPj6aDIYb+Z8bpUjXNkjNJDWAeMgVYK32VCbU2TuT6kwPGaySNQTBpeQI5MlIp44/Sy+ow//xMS2WVXIUq8odNguSLwMyyDxQ4nPvK8B09pvu1gEsfhXho3dkcond3/OahTd8wdjCK6gb6TgHxYQ3ZO/1EeveefP/zYbMVA+0XGsU1YaCiwtxHIx48fHArogrUbajCeMwpM8u5Yjq9pTj/QKwBKqQVWCi1GCbBt9dUgfKk4Oft/tnnW50X7bQmzJC+J0izaW9WMFVJ6dTFA5hXedbJbPqoGac2I+/1KDegMkQ1Du0rZyQf567R8tWaE/o7/xkqM7CZ/9eVf5uuUCDUET3XMKim6u+ayJ41X+00/b3Lm7FFWzLaY+2dxn1wkDQgH0oD7a0eEoXKMjHtDSzcBu+CPm6N4ztVArZiXIQ55hr20XEFnGj9EuBEtKH+NOV9Eqr7As18mosY6OHnYb/rkVzdGuhw42A7ipbMzELYMhgw3pZk8czXrx5R+aoOfPoonDXwWN7htf1yDBKv7Q50mjjbtsUuCJYfLhsYi2gunuzVbJ6ev4ej58fPDh6D4K4Fa8qE4tSsFILM59IVC4g7BPapv63QhT5nFEsWpUuI/QWUgYWHD7rm0LagqLXSL1Xqdk9/twcrPu22YLsq1Kwekpuam08PSB52wA+YkcZ0vBjY+HY7wP8PMpSH/onpDmuOH3gD5D+LNVWt3oV2qMGh6fHIO61Su+m2326ik4L/hPTnJ5rdeoFMoz4p7dI9oV2zBXn86IRyLGJDHhpO0QL9PSn6Ntp3Odg++cpxoxzOVxMpQ5eoTjFXgdIwW94MN6eYqzEreMwXmkkbc7W/Oop2LxudW7L3i9vAGP96ANKnhg1uEsofYsWMJvDxD8K1Jc/H5t7SSRDEyt/0ShezqavJkrhSTdwLoWttNZ0Q8n9/dOD8AR4N5FSgmLtcMOPXVePsD08j/AF7UllfILaacV/EKFiCj0eA8SLugZ1AWPjXjSo1cWR8hZu//eGivvax30Rz9+t15eHffLzY3Zuza6G0HGYPHHkeUqCZamMdIqDmoFNBZ73dgmb4g46OLrtF1LWodDn0gVxlnnTEt//+qz7S5kj4D82jriw0H+/oTb0I9v7vf/73sW+knK8x5Wbpwz+8Dk2Xftm1zqL8DA/qGKaWMmMK6UQ2NtSlQb6oWjp2U9VyyetTvSWMB7pSfcoXNK0FayYEWt8CVNRXLVQKFpOlVEItONX1UbK58JUoKuq4Ox/OSZMNcEG9r4c4IKy0Kve3VVy2zN0Arjuw0KhclKEW77rp4DxWVVcR1IiVEnXsblslKP1MWKUFBUuWCEduyLDL8/V6HTP3OlZ6sR/Wmv2305ev3p2/GtOabRO8NedAulOlM5V21fc0XA06fhIf+ts9xuZMtuh5fdsd0b4Ut/zEv/XGaZBsi9d2vxCMy9adD28+f/P3UMNsW9uAfhpFS2UsfXJzQ5HGBy22W3rs71A6s8oNHVI6XM5u7/Ih91YHqb4i69hcX3VmzF/XeQgZD72cegcpVWj7hZR85rLqHYg73zXYP9EPzX3VlHxq5TTooPxKsp1Fm+adEGXbdrM/vCLzy4JtbvzSlfNL4Y9WSs7kpgW776I8CfRva1S7u+SvpHw/4eZv9ef+za0LaqPuvyYuUQr3L6SGh68=
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-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"}>Fetch all data agreements</h1>

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



This endpoint is used to fetch all data agreements defined in the 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"}>Query Parameters</h3></summary><div><ul><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><ParamsItem className={"paramsItem"} param={{"description":"An object with ID revisionId","in":"query","name":"revisionId","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

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>