---
id: list-all-data-disclosure-agreement-records
title: "List all Data Disclosure Agreement Records"
description: "Lists all Data Disclosure Agreement Records for the organisation, depending on  the role of the organisation for the record, 'data_source' or  'data_using_service'."
sidebar_label: "List all Data Disclosure Agreement Records"
hide_title: true
hide_table_of_contents: true
api: eJztW21v2zgS/isDfWkC2Iqdt3aDxeLSpN11d7ctmvQK3DZoaWlscSORKknF8Qb+tr/kftr9ksOQepccO+1hD4fLl8SSyOFwXp+hRndeiDpQPDVcCu/E+4Vro4HFMZwzw+Cc6yCWOlMIp3OFmKAw8A4DqUINM6nARAhSzZngmhGJAYSYogi5mIMUYJ8rGSPIWWdsSUBZggP46IXMsE9aZirAjx5IBcW9THMx/6RR3XB65H8U3sBLmWIJGlTaO/ntrrWT11kyRUXrqpxfI0Ff89Qum7I5F5YL3xt4nCZ8yVAtvYEnWILeiSdnM43GG3gKv2RcYeidzFisceDpIMKEeSd3nlmmNJQLg3NU3mo1uCumxzzhpk26yeGv7JYnWQKij1OFJlMCUrS8ov8gRmilGcti452MR3Wu6uJ/J2O8n8GXPDaoYLqEN3W10cRSd20zebdel/2qbGzMqKxvX9ooLuYN+Wo+FxeGmUxvu4dFhCZCx7W2Mwuj7N8DcA0f7ToF+5nIr3bQn/vAAsNvyKSBC/d7dystlbu5otE6lUKjpuf7oxH9a25gkx8Cuaw38AIpDApDBFiaxjywytr7XROVuxoXqZIpKsPdmqSSinpJPPfxGtdMKUbi5QaT+n05/R0D05H7aW7MoDBVqFFQWBE17qdoFogCmBP/hTUUYCJ01+/JSuDCWQnFEWYgYAKmCKQEDEmlU2miAUyZxpCiDekyS0NmMIQfJWijssBkCn24jBDepGY4EXDD4gwhpLCRcIG6YReq1HyuXOKHRFSuHTGFITloaTgNTnuW4hqkiJd0xUPrN4Wbk8oYFzSddmI3xohh7eJbZUq/eTwkHTMhBQ9YPKGrNaq7xCSNmcF3eMM1KcONdAK+KJbI71rmc97rz2RqJjTT8AS1YUlK92pBwDLQF030OcZoMPSuBi1L42HXB9pW817wL1nXITs2z0MUhs84Kt9bNeWycQ1SUKCk1sM6/yyuEW1lJrvGttLuODCtN8viGFQ+BJzLrIs+1WYL2rCIeBC1DLSwesoMbVc03MR0o2YCt0MhzZCLIe2D5pbxqWNlLlS8pjg7yGk6ddufxC4NQsX/YDH/A8MLwVIdSZPfdTd/Yjpq2M+W9jCTKmHGO6G8gLcsSe1Gjo8On4739/fxWfA0OJhOD4L94Ph4NO4ot9gxTM5JabWtbL0WCajUQWeBt6RFmel4ScnBkv/owTQzzmYwiKwhgkKmpdCgI5nFIYWOgMUxhuUsYspmPxRZQrJvr5vKmAfL3E9bgdm7WtVU801ifHb43X6vj7z9uQRtzl5tDF4wDbmWNYbeqmEWWzNy5/v+qnfV+lq8vZSL/B+4iWRm3nS3P5UyRibWLZsbfHPRiQgpV6J2axZCtRuNcWZgGjNxDVxAj8lT8hCk2SCLmaFA3vQAv6KXsCXobKrxS4bCxEsyiRm3JsGFjTB9LvWNEi3cAfMstkMxg2l4dfHm9S79YBDywPhwmqbx0t6GsyKY8j8c3rsge0UaTWh08uLyJbx7eQbPnj478gEmpshjrm4gg5lxjMMSXjl7B7wNMDWgswC1lmoSDlrCql8XAqBEuOrEla2lwsbT/eAgPMSj2fF9vzuCo2WI/z6d71z8dDoc7xJfVXjbmqX90f7hcDQejo8ux6OTg9HJaPSPricUdIkHa2NF8iAbi1iaosDQJ+FXAWZy8QaeHY/G8P7yjNSNQOwRmywzkVS0iedLsvcbHmZFsux6g3tKEXTQhqxNUm8INz0o/hweHY7ZPh7j06Pj70aj0fjwiE1Hox67naFCESAhLSaAhQkXkGkL05iBiGkIFFqkZyKuS/FYY8mCwsSItdvh7HqYyBDjZka8HyVMZk3CFIyEhFiKeY4VKTNrUw4YgCKmiWFuNJRMEEepwhDd5cPsdzvrDQ66BsSSFNVQoeaaygJgyvAZCwzMlEwgzbNYWXoHMuUYuoctZ2vyX4HErTdRZ9X3/W/kFXYWCKEUTwxcC7kA7oJMe5TNU65QkAqENLvearXqh8K9kK0E45AqecNDV3GUgM3RuA981eH0A9BXypaxZBaH1QiUv88xkCHS4xtUfJaXeb+iiWT75tuSUs/dHJ/Vn1xYcT1f9t4+1a3brxb6J2ShPW2oVwk9Obr05hJEXpLMiovq8bfUDJW+KhxvbTeXwlZ1wcbCY8fmTEeBlghdznQb2S0wyloHaa746sNlxXZjbqHljWV2PrAiM6hXlUHMeKIpbuaubRqG/erDJa3aY0gbWT+FBcbxkDxQ5OKAEIW0GMiVK4klRXGT1vfh77b+tTWxPoEn17iccntQ+On3hXnSZuTtQ9RW0aI9Qa7yGmB1gcBI8uUwo7RSF8SatdeF6nbGNKgEi+MlzFGgsjkpUMvUyLliacQDylZRAYbcmYCR1UHGALiPfu2hnEGfJFZrvHUjh88xYJmms4yaazzRwIWL15TdCJ0GERNzBHlDWYwnOCCelD3AYCDQCVAbqTCH57X5zNgN0DQLm/icDNCHiTuVCZi291lLMjWztdnWAscC0uSGDFom2C7OYymvSd1ZSuHdymVJ1zYVZNOYB2QUJQJ17EDKlFn6/ZI81Zsl+YLbk6LcnGwo6DnnrN/vHnbWy718Wl7jNQfbEq8/4G72ztjapD3Byo+quk4+aNyzgJdOu9qSydUzt6dh8OrDRa0mK6q1nXcvz54ejY82Y+J7YG4nEq7NIn0F3xZFXQUqu7WdtZJqXzeoLOhrRZABsHjBlhps8raGuDFjVId6VbFs099G6dAJQauGsjC2f0+p5HTGauTA7Ydr53W5IYYli59YweInh5W6ZnnP4NrJQ59C1gbJVhjYtEweD7i28ybnhRxydNfSSwXt+s8zvwbgNY91H3HeI857xHmPOO8R5z3ivEec94jzHnHefw/nuXfTm43jw3/0xf5DTT6Pks1T/Nq5cZWeaX8sDNG9Z269Zd9qoUpujf6q/ADb7nyKdHRtW4t2bLNBY+Q1YkpBW6bL3Q4X9tX+Vnys7fQqLLVUv2uhGUAtOu76D42aVbPBFpFi1rKD0E31yaYsfCwawvrAWIH131aj2hA2yJRCYd6yeV1Y9Y6sOjtnbrTt7cobwOpn5mMyNmlYPGl126yjd0mDa51ktksH2A3jMZvazoyS9v5RQZx4/RrixHTVgABFq1u5wsFqkPe/bab9usVy0fDWkMZoNfAipot37w9KDO79gMInlK3LtwTtJWygd6u8xlvz9SsIvDUd6tTW5sysbVj1snBDK1bDRq8stcjiBCuPM9f+NSxSTqfrzDaCNd6NtrvEVh0jrdEEt5aLwIejsTX5bVvO6rtEpaQ6k6EVEP0+r6151ZVQ08uq2X2mVW7ucEQm0yHfE8QqeTxn9CY+zUh9eV+pjQ0dsbwX1UtQr64EGnrkevj+T0VTFEmEsai8sMu0ZGRf5weZ4mZp23ZPU/4z0s8raog0bE7dvOvbHjVJIsnLV29uW3RTZiLvxNu7OdjL88MeOdOwAh7DMvPsqdKfHJN9zcPnmMh8D97AyxS9Oo6MSfXJ3l6IiRyylPt8rpgwPpce9aU2CVwY8tX5OhraPW6TuapE45ourGILAVWtmO5G3vcaFaczeWfsaW6cRZpqlQxvJ7ZiIhOmSssZpmtbLMtSypSfG3Q+5/4PSaapd5Mi6YzfYggLbiL47HiEz7AjpHFlt1GMx1YGKQtwdwC2abZJ9gTyid8vZaZIHMNrXP7w2WKQ58gUKhpPe5/aq5fFG2Y60+jszb5yByOvUUDKtC7Yc5RyngmMNJiAUoLWLW3QtxOqQz/SG7Ufe1QLF/7NAuvfmDBOutVZmkpl/lbps1QJ/7G61TSEug21dlNOgp1//fnPXVeeXyww5Dpy0BVv81K+Xc9B7gXFyaaynSKZRmqoimdDTbU/8nlxUGCWRZFIYIE6K+xtFuuB7RCacwIAC2pgM3YxLemMJ5Wh63iTsZxz1ANAwaZW55QIFxDjDcY2t1NcoGDFpjzmZmmJsMzIxHVNBTJJY85szUYKs9tTOLddVdRGx6lRmLooyXJDbiyfCROCOkAJbQQotI18hRekLIgQ9v1RR+aLxcJn9rEv1Xwvn6v3fpmcvXh98WJIc1YV5qv0QL4TyiCjMFJ4V15B5o09/oE/toeRUpuEiRo/1KW93XcVbbOuJZP/rc8zct8xeGv20phxizCsKu7yiP2bd3OQx2FeAv3eqG2hkhPP1cCLpDY0++6OQOh7Fa9WdNt9AWCjOddkIWF/z19dog/5TKR3Q9cUmquvRWwMpQ4YmxO2ZuOh34Lcw0oBx7+Sk513OSLZhb/q+4/75NptMf/Kff3lH4Lcs6vGxyvVfq7oQtkYbOFQgZusSbuZlOLSuna7KL4Oj358QVmS5Sm0gg/XFj7kP4h68Ugsa7TbSMKxQH9J9L1TvqcY+TMufyiHuydrJ5S5140mKVFt82+DHj66
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-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 Data Disclosure Agreement Records</h1>

<MethodEndpoint method={"get"} path={"/v3/service/data-disclosure-agreement/records"}></MethodEndpoint>



Lists all Data Disclosure Agreement Records for the organisation, depending on  the role of the organisation for the record, "data_source" or  "data_using_service".


## 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={{"name":"organisationRole","in":"query","description":"Filter by Organisation Role for the Data Disclosure Record, \"data_source\" or \"data_using_service\"","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"signStatus","in":"query","description":"Filter by whether the status of the Data Disclosure Record is \"sign\" or \"unsign\" (e.g. active or inactive)","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data Disclosure Agreement Record List

</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"}}><li className={"schemaItem"}><summary style={{}}><strong>Content-Type</strong><span style={{"opacity":"0.6"}}> json</span></summary><div><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Content-Type header

</div></div></li></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"}>dataDisclosureAgreementRecords</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"}}><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={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique Data Disclosure Agreement Record identifier."}}></SchemaItem><SchemaItem collapsible={false} name={"canonicalId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The cross-organisational identifier for the record."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataDisclosureAgreementTemplateRevision</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"}}>

The full revision object of the Data Disclosure Agreement Template which the record is based on.

</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><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataSourceSignature</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"}}>

The signature provided by the Data Source.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","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."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","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","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></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"}>dataUsingServiceSignature</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"}}>

The signature provided by the Data Using Service.

</div><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique signature identifier"}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The Data Disclosure Agreement Record (as a stringified JSON object)"}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JWT signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signatureDecoded"} required={true} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Decoded signature, containing claims used from the signature JWT"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A well-known string denoting which method is used. Valid values: 'keybinding_jwt'"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The keybinding JWT payload that was signed to produce the signature"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","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."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"Either signed as a \"data_source\" or as a \"data_using_service\"","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","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","description":"Timestamp of signature"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates that objectReference was left blank in the serialised version that was signed, always false for Data Disclosure Agreement Record signatures"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_disclosure_agreement_record`]"} schema={{"type":"string","description":"Name of the schema model that objectReference points to, in this case \"data_disclosure_agreement_record\"","enum":["data_disclosure_agreement_record"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"In the case of a data_disclosure_agreement_record, this is the ID of the record that was signed"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"optIn"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the record is active and data can be shared to the Data Using Service."}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The timestamp of when the latest signature was added."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the organisation this record belongs to (both organisation keep a copy)."}}></SchemaItem><SchemaItem collapsible={false} name={"organisationRole"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`data_source`, `data_using_service`]"} schema={{"type":"string","description":"The role of the organisation in this agreement (e.g., data_source).","enum":["data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"isDeleted"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If the record is deleted."}}></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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</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  \"dataDisclosureAgreementRecords\": [\n    {\n      \"id\": \"string\",\n      \"canonicalId\": \"string\",\n      \"dataDisclosureAgreementTemplateRevision\": {\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      \"dataSourceSignature\": {\n        \"id\": \"string\",\n        \"payload\": \"string\",\n        \"signature\": \"string\",\n        \"signatureDecoded\": {},\n        \"verificationMethod\": \"string\",\n        \"verificationPayload\": \"string\",\n        \"verificationPayloadHash\": \"string\",\n        \"verificationSignedBy\": \"string\",\n        \"verificationSignedAs\": \"data_source\",\n        \"verificationJwsHeader\": \"string\",\n        \"timestamp\": \"string\",\n        \"signedWithoutObjectReference\": true,\n        \"objectType\": \"data_disclosure_agreement_record\",\n        \"objectReference\": \"string\"\n      },\n      \"dataUsingServiceSignature\": {\n        \"id\": \"string\",\n        \"payload\": \"string\",\n        \"signature\": \"string\",\n        \"signatureDecoded\": {},\n        \"verificationMethod\": \"string\",\n        \"verificationPayload\": \"string\",\n        \"verificationPayloadHash\": \"string\",\n        \"verificationSignedBy\": \"string\",\n        \"verificationSignedAs\": \"data_source\",\n        \"verificationJwsHeader\": \"string\",\n        \"timestamp\": \"string\",\n        \"signedWithoutObjectReference\": true,\n        \"objectType\": \"data_disclosure_agreement_record\",\n        \"objectReference\": \"string\"\n      },\n      \"optIn\": true,\n      \"timestamp\": \"string\",\n      \"organisationId\": \"string\",\n      \"organisationRole\": \"data_source\",\n      \"isDeleted\": true\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={"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>