---
id: config-read-agreement
title: "Read data agreement"
description: "This endpoint allows the admin to view the latest data agreement defined"
sidebar_label: "Read data agreement"
hide_title: true
hide_table_of_contents: true
api: eJztPNly28aWv9LFF0spklosyQ7r1q2hJdmm48QaLXFNLFfcBJpkRyCAdAOiGZXe7pfMp82XzFkaOyiTkTI1c+emUglFok+fPvvWuOv4ynpGx4mOws6gcznTVqjQjyMdJkIGQbSwIpkpIf25DkUSiVutFvRNIBNlE+HLRAo5NUrNFSzx1USHyr8OlTSBVkbAKhmKyExlqK3EbfpihKBtJIxKUhPaMjijbrWFh0SYzsfK9K/DTrcTxcrQ0pEPOHpRONHTcyX9YbYtPBNLI+cqUcZ2Bp/uase6CvXvqRKjExFNCJ3xb8rDVRp/jWUyg88hrIe/8EA5YNiw2zHq91QbBXsnJlXdjvVmai47g7tOsoxxiU2MDqed+/vP+LCNo9Aqi7/v7+7i/wDjBLGEjzKOA+3RYXZ+s4jcXQlebPCoiebVFUxocRB8mNDx3Mb5ORKdBPjFSWVJt0aGYVjiFCIltaO+jZWnJw4xIpKwcKRAiTg1cWQVPCVhDdBurHCpBRDKB4HoCzEUlW0FiFAa6ltghQyA2n7bMjFeiu/mMlx+BxLi61vtpyASsIuJ0ukMtq+APFdeZHwWhq+9MEp6OuwhecbSwrEnsFSV+fSp49BGweBPJyVKdIkjJgoCZa5MUPn7J5QCWBUBm5bwIZCLSRq8klZb+AskbBb5HyZXBFp6CRwTPkxAvlUC6AT4V6Anylt68BnkocpS7TfFhpbPJXC4A5/VVzmPiZdHhwcv9vb399VL74X3fDx+7u17Lw++32+wtXPf7SC1NYvTetD3+rv93QaoS5AFBwqlIEFzUJUNYN1ipj1kkVGegpXIV9zDIh4FIUetR61uxwqJAlisq0JB9nwTzNX5e4RDpqhYKrbmcolyF811glKnJyKM+Ckd3kbBrfK3q7sR87+5HT71mP2cbA3qVuqMvgfd8QEYE5kYUNUuOwMzgNtMI+AU2FrQwI8zFQrPKGBROAXOVI1yt2xgefNMJVPL2jjRABOfAvst0yARtzIAUydIfcvG2zkCXO6DWPgKV3szGU6V0Alae4JSdQqBulUBa+8qw3WW6dt66h2ylqYgHU+uYy9e7O616li4QjraQZ84ShItcnPSLklIM/fI0+nyz2U9zuCLLc1mfBKhc2fjr+awpWDYJKFpu9a17z5LktgOdnbcN30vmu/ERt9Kb9lbce4zBYBCFA1UXXAsJWkHVJZVG6TEWUVoQc79LuhBlAY+aFiC31GowrLspBG1QyQaWAYH+i012vraSzai6+lVA/N3ZUD3GED4KUBZXoA4R2Z90G+VDJKZJ41qGkUHEvhCMGEXlKFzhTEEPALE05F/Ipe2tB2Ea2oKxnPFfs+PDuvboFXBCIyBipigogL7CBk2napoamQMnDlXeJrHE+9NDhE2LkDCXhYOKqfqfcRe5lG7XDAsEWTAAD5IlvHPpEmWeOyLmSSgxS7jKAqUDFdtw3FfI1Q2vogRJuu4dVDv7x3HhgngPk4TVWaUNEaiQuhEze3DQV0Lv2QOMovfqu7ZosYA2l4SLEGpJAVjHronDzxSf1P7Wsbg6WOZwxY7Wz0lROybG96fmrhXLW0Ovos2D0TeJjL0lLimja474PDgM4jQNZn9CqB1kXidgkMNS5sWUW7zzMVfDRRJOVRoNUSaOlmuL7KOqTXVKCDlAUxlK5AiNY3Mcv2DgjWCNKblVMcOVPtG1oviDXiKJr+p6AhDZGJLvKxvBKrY1KuqGJcs0YN6+rB2vtcQW8FJK9Ae0rYqEhC7+RAwtMfMKzzI85OPez9effxl+erm7PD9mwNz+R/nbwfPB8fvBy93By6Qa7IFdkKTD6kZ5eqaxI71jBPRJ0Bif3CMZyOrpMSHiThXUyAQJ/GDo9Zw5YI2J0zon8911XsSC3hN7iDLDtcO9bMF96355DfB1DS8BK2cXq5N9ab0ERQxRjC5CcnD716WeYsdCMWnMvg1Ggd6yvH8DmcwQC/4CIYBfsVYAuUYvohTeNL7NZH2hheDuABCKn8G8QrTOfoMtwkmwLVNsgRbkuJUN6EMPd+EFzc2QVkop95/nlI/EhSkEaQ+QJkQ7fQO2Y1fbZQacAPurxQLIL9aZW61p4pj4gJ27+75jvur+jxJb6wlyOxj0L3kZApkMMxjZCVOzkZDsDRxZEi6pyrE+hiYQDkBgmHxBB7oOAwu0vlcmuVaiTRud3UeCDBO4KswlyxtZzGb4V0thN8MVqjEq9SGIOoGXQRcxktIHpci46HiWAntHVoaPQ1lkhqizdfe5KY3j3wVoBnIf2kYiOwXqk+lwEcIxRFHjsHgy2qivJUvsMJl5pAaYHUyS1M9MMi4bg4n08ABkaNltx/MVstIrlmPkssgIh9mS2uZWGy4WDJrX57ly1q+fSvtrPYLIqb8V0vCdQ5kB8l6+sjtsC1y+0BEykkdS4u1hbH0blAUbASGdHg2yovLViw0HDhNsB6rfbF19sN2F1wSEJPlDkQKeARCBAyXEI/5BqT7utMVuq/68E0hDomz8pgKLlUiMJkomJyxhUsZIXgF9RV8kaXfjcSAqE923ZF6bcrc9fv9+1YVArcK7tUBzNGzxJsuGWNIKDxSWAsneXfx4SdI9gz45KzKAkIJShT4Vty1MH4gYOuuWCESLb+ybLX8MEQvDWa55adMlFp+erewkL/6ynRFLmXuMT7kR2Yti8S5moAFgADbPcLadAk0rnxRfey+Ly4cRSpkwtS7L0bs4nJVqlrBsQKGIb+XkPaBLCHt20ViC2ViRtBJ/BKso+ETNZSyYkOpuDcx0ZzrKo7NEJNQGY23IUu8kMa3/Ya9W0+81PLdbPzG0x/0u9e/nJ5f/vvFu++BMA+bxQwZONOMy34MPAsKCooVJ3LhE5tsBZwDF9IUHkyKWmXAVazqdmz9DN7fPzzc+z4/xv7ufjM4HIqFCoLeTRgtIN4jgIWtYMfI8QE1HywWRX8G2fG5jmkH4vLVSV9Qd2uupzMqGamvMbAfjo2GCPxZjJ4N/iwfxkG1uBZEITNuEqCEEKMEoLZE22K1WyBC5SlrwUP26wQ6expDM0LHCnYGDFoh+rbQmVoJzedyjxNo4nWhiGwbazLfI3n4SmEblZXDAr4LDXSWcVnSzhUnJT+19mnl3njfe+4fqMPJUZu8t57bM8s4yYtLKP3ZuUkAqOGkcgtMHqT4EZ5s40/tMJmpfEQ0N6zKlnQQM7OEUFzvDYIpjFOYJYDwXE5Vt6S9EHXV8ctd/9r4+dof3Kjl4I+jH28mbaR+pTyZkucED41JI1gJ8ww9JwMkBQGNqFdcyfKwVZagCFyWJRPsnGFpPbt5WkaKBKcAnMHEV0M0WWNxToouV43JW2ZGLU8MMegoMKcKQRBFNyi9aZxbtGUW6HIiIoAmZXuZh5gtSIVR2FsHMa+CF6zDR8B8FFUhICuWiyCyjl1FxbXAuwLSYh0I6fsQl1oIZnuOliAnoYzhzAmTdQzQLJK6aumfiMLO9CUc30yViQ3OCDTKW3CQMh1pAoAYgRvB8SRgeANuNnegIGEoVKMTsC4WTVbDYrJoDzfIkB+qtp0PX1+K16PT9ycDceF8H3fBjQq4hjDTMZw1WSgXDpSzjRJhQ9+dnbcqZWiZHwaOe2CtrPM98C/soW4lEA6F8djl5dzfhqfOIqDAOFC537ouHeW6A7kpBMIK8+tEXXcahCqc8iOMVED2FTvbmSw13Xs1HkQDT9SoM83JzxRhQQD38aLsoNi4ia3z18cvDvcOqfFUJC1rHwDihYPe7l5v7/Byb3fwfHewu/tLMyrP4GYa4DDzUgPODktFJWXVNnyWkMrnvTPHThsJnTzjTAOhKdODzCqaZCHeqsj3kWXbEYgAVtIs63ndUS/A/QZqAgYgkOFN5k1aQgFajU8zroh1EQNsUozlGZ0Hi+xcSxSU1rej7dJAHCH5OZf2nDdZGT7b7LpTKjWVMCgi68/5cdro/ifS3KOjljR3KOxyDkGeoSZWkBXRKM/Nw6tMcUoRVo32ffFRUWpbSOBvqU2YXkFmZzjsiigkL+zOluRCxjZSKH8MjIgbndpiO+QKMrKYqWIr72yOIZvTRedemhRwXWKIL7b73MlyQy5rS3DTojSmgxgkWYxQLdpGfWw+M4RDDSyq5SGbp8KGd8t8G1pWjCYXNE7h6KS5UuEbuQi7GOlqEFoqIRCnXd0hD/fJrsvU14CoDnTC8b8XzWMQFUAdDYTrzH+70F6pjD082/VxdDZgJ+OMWNVmUO28YEJG5cypYx0EZNcUiS0AEgXWIkYhilJbESbSc9T5CmpcYi+GoL5ZdSTUj1kPxPtsHQQ5VPjkbSo79EX9MUu6lE2zzGWIDWDtMgWxiMzNhEYZUeTqkwOWNRLHIMAvg1rPQZ4AT8usZFltpx/PtGRWiSpUHWY2ChIXgWHhFQYOF1wZfqDHtF4LOOUohKFVZ3MQ3+b4zaZNXzd2ACzMGuiNAuJmDdkH/YT/8Jm4/7nZbEVL+wWHUq0bqMh2rm8TbDx8sHKjDNSqrdx4zAnETeNIGn9FcX7DXR1UIKkDK1ITtKPA7TVgaTiM9UW5f/btVudlOa1xM6QfENLZqDYr6Ede6qaCEcA4y7PgyWfFmDHkBGTiMDfAMkQ27MuVM5SPC2q0PFpzXH/nn0NlWg7zL135y3SldY6gdej6FAtm2Poviwly7PQrl0maolH59ZvqR6Ks3OOgWaCAAe63GuaZiSZ6HUdcBR27ZYWDG47O9nbJq7V3kNra9bnLhPzeXQ7ADAVAUVyUTyOc5MMI6wwOt08xFKWeb00ztI4eVJdre4pBHnru+rx/EXPW8jSbpT3KLUVAv7eOQmNAC+KBluVkCcZBe+91eNP6HMReGImSOJ6DVGFHvEVM1rM3DwyglrahqRrc5+Fx1IcHTlfAcx+V3zoft0Lqf5Qxj9e4taU5kCc4egtYxvTPjQZV0XmkHD44GrSpVtw3hmraBpdyr9hKFwKCMW6EE7ylI9bHqf7vkaYpmn+Fov1L2jaTtpw1mTttmOaSsf/sYtu8RNRCscxxn68qZA3Fd9Rb0t53RcLLpSxPxjxSUquxuTtelm+YLZ0jeGaze1QmWhRFYOoz25QLoJCw7m2vKr5TSLy/zRUFLNtfh9fh0OLFi7yAft2xqYflh8hcd3DWLZ1jpaLAvOj1YlED1mKeD3HXzSYjwdrPyewmbJmedEWOP6LHp2jY6D+ALH8o/8I1KNy3/KWbW/kLB1RaK3d5faw87Ljqxs+KjtmDJZgzVyMJlsgSAg/8oLkAlHDlzULIjAK8v2BR7ktskTQ3cF1CqlLvrO9bXKtoFrNKddBNJjnXvm2GAy5nP+ShspPhvLqZa0RRXSaxeIKxmvJeur5VS/m9cvwnq7uP/JaCe4vIuyqiDLw04HtZVQ3oF/CwCgfWwKL9o1LwWBWjJDw/0qJSj6Ropg6wCSWUW27QBhv52zxxw8M2wzgGlGj65liGEckwIEPWnuwv1tCwaylGp5evxfnrY/HyxcvDvsB7vnmFQLoLZm6sqdolgJxDxQnQgK3YCK/3VIhV/jsjgJvlrdmVPzVn8NDnBuHeuumCNp5vXbwd9vb+51pZJGOZnUcZm8k4VtRfGCUlAzO6+CBeglEUV5fHPFCa3Yxyrc0/cHRglLcaWXWa2uAanWBBu808pQzqA/YsNrI/B4cHe3JfHakXh0ff7+7u7h0cyvFucxTovNxkkdmFRGwis5biOJfrGnAZO48EUFgyR8moVerrpWjgG7dWJ1XA3AMAh4pd8bbL7F3uDCHC2DzIkXDJna/4z83kdz3p9Z43BYgblxDDUA8jKeZQKKIoVfq5QeRFsc76AjVlq+J/sfmQWxnVtgmUzXAVWwsl/Ai7tzgphhdwXSJaearowmEDDWKfbZfUVOPElvC1VtLYwmAJh0pJv/ZBcHe38Uqd0eoWGwrM50kaBOirZ9SZx/gGAR/wqwGq8McSLX6cUveZX2fQsnCPboys+06BcgynjInMMcg7MgE/l28xfG7OO1ejsmJ1273DnKlwsvsW8C0yUcjBq5aDu8C//iaHwsq0kObg/zFpzpWrCWNjaxKlYZNAhxu+j+Kfi0DZ5CA1msAc0zY1GnEJPTV01+7TXWcY6x8UfvyMFeBXShplhiCB9A2eWk6x/9Cp9geRHnM3B9uZKn4/CS7q7PDbS3Yw5OrllmTnrvbWkXtOmG7bX2dyouaRO0THXdbOb2H78FtPxrqvIZcMk76Odm73O4h8/ZasnGZNtxYwln9ugfS5oBBHf8TfjE5F2YK/cK9YYRJ38pesDJ0SZ9eDaun32YiGx1DVsZrguffGXJZHNtGyf6nA+SJ4GzHHSYoxGf6J/ppN+H5hHMUXsQUawpNsiZGapy1i6antrlD9ab8GdiDcwr8tQb+QIj1A7u9fKDAvS8RdZ0x/vc5c3buPl82zkU9wM3DukgShx5AczlQiLyMhcgqSdlIAQAuKaAVZ17mnO+mTKFNzN7BKI4SoPjyn/G85SwuW6DfFV1VZKB5uqFS+SGz91z/+c5snPi8WytcQI/uVdkJ9Pixv9/JlI2UoZE0t9Z6CSc/iOKkCN+1KSskyGzrDCRBRdA5optDXU7xWBr4d0qaEZ5UjHACPI59T7yiIphoHEFUIAHhkBqdP6OUUKFA0LkDdRx7cICAggtGc0zdq62u6KUwMcxPV09QNDdLYvyBvnw2ABDgxHoZwNuwNwmFDvryWaQEIHQjhPt2GrNJ8sVj0Jf3cj8x0x621O+9Hx6c/XZz2cM19Uckq+IC6k/VdM+3KK/iUYfSf9/f4NSQ2AexK+OA7lZqd0Nr959x5/C99WZTThkR9TXbiAHLP0gst2Ah/cq+QcvWTXvmwg/rrn8DczSJsuHzq3N1hvHdlgvt7/BqSdUOeAQgsjea5JLTVgDp89tuLCmUCbp07/7otVr6hqvU4mY0N0cCSReTA+gZNcOMNVlQPdfYDEeSn0BDFSWl9IxS4L3uxN6doy6QzdIWRvyEj7z6UGvFV3Or2nlHA/5Yaq9Ulf0NJBrP79/xx/mXlgtxC8tNIKSwG/zdD98y5
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"}>Read data agreement</h1>

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



This endpoint allows the admin to view the latest data agreement defined
earlier in an organisation. It also returns the latest revision number.


## 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"}}><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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAttributes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Data attributes contain specifications of exactly what is collected.


</div><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":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"sensitivity"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"category"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Personal","description":"Category of data attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"scope"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</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={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></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><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataExchange</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"}}>

Data exchange details

</div><SchemaItem collapsible={false} name={"dataExchangeProfile"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`AIP10`]"} schema={{"type":"string","description":"Data exchange profile","enum":["AIP10"]}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Data agreement ID defined in AIP"}}></SchemaItem><SchemaItem collapsible={false} name={"credentialDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential definition identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"isExistingSchema"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Is schema existing"}}></SchemaItem><SchemaItem collapsible={false} name={"qrId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"firebaseDynamicLink"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>presentationRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the presentation request"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Version of the presentation request"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requestedAttributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Map of requested attributes

</div><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the requested attribute"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>restrictions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

List of restrictions for the requested attribute

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"schemaId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Schema identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"credDefId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Credential definition identifier"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\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    \"dataExchange\": {\n      \"dataExchangeProfile\": \"AIP10\",\n      \"id\": \"string\",\n      \"credentialDefinitionId\": \"string\",\n      \"schemaId\": \"string\",\n      \"isExistingSchema\": true,\n      \"qrId\": \"string\",\n      \"firebaseDynamicLink\": \"string\",\n      \"presentationRequest\": {\n        \"name\": \"string\",\n        \"version\": \"string\",\n        \"requestedAttributes\": {\n          \"name\": \"string\",\n          \"restrictions\": [\n            {\n              \"schemaId\": \"string\",\n              \"credDefId\": \"string\"\n            }\n          ]\n        }\n      }\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}"} 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>