https://docs.igrant.io/assets/js/789474e9.e480b398.js

1"use strict";(self.webpackChunkdocusaurus_template_openapi_docs=self.webpackChunkdocusaurus_template_openapi_docs||[]).push([[30450],{78819:(e,a,i)=>{i.r(a),i.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>x,frontMatter:()=>y,metadata:()=>h,toc:()=>b});var t=i(58168),s=(i(96540),i(15680)),n=i(91366),r=(i(6050),i(57742)),o=i.n(r),m=(i(67792),i(27362)),l=i(36683),d=i(81124),c=i(28390),p=i(12601),g=(i(26651),i(77675),i(19365));const y={id:"service-update-individual-consent-record-signature",title:"Update consent record signature",description:"This endpoint is used to update a signature object for the consent record for an individual in an organiation defined in the consent building block.",sidebar_label:"Update consent record signature",hide_title:!0,hide_table_of_contents:!0,api:"eJztW9ty48YR/ZWueVltFQhddrWOWS5XpNWuTfmmSNpsytZW7RBoEmMBM/DMgBSs4lu+JJ+WL0n1zOBCEtzIjh9SCV9UFDCXvs3p7gPgkaVoEi1KK5RkY3abCQMo01IJaUEYqAymYBVUZcotAgcj5pLbSiOo6c+YWJgpDTZDSJQ0KC1oTJRO3WUuQchULERa8RyEpAtKz7kUnPaDFGdCYkp3+itMK5GnQs5hmqvkPmYRUyVqN2WSsjEzqBciwXdOpEm7wWs//drtf9OIySJWcs0LtKgNG//0uKHxOyl+qRAmF6BmTj6nFYuYoLsltxmLmOQFsjFL+jtMUhYxjb9UQmPKxlZXGDGTZFhwNn5kti5pirFayDlbraJHv2KGPEXdrfm3UZD7/HzU6fLbFo82dOrWgckFW33wS6Gx5yqtaX6ipEVp6Scvy1wkzriHPxua/tjbqNRkeivQuOutUTsZWntZYXO60Lf8ulhnMEeJWiS9ICJJuJAGOCS6Lq2aa15mIoGMm4xcYlSBsOB5hRGAVXO0GWpYCputBWOikVtMYVr7GaUWCwrYe6x94Ck3z9TGYhEDXAfbuiUo1gq0mUrNGK5xIQxFZ4hvF8d+9s1G7Md3kkXsYSSVHQk5SrnlU26QjWc8N9h34E+s5HWuOLnV9Ay0QC1mwfzfOQk2Ll610waufs1NtnGHRMT0vHYOKdBYXpTsQ7ThSJFuR1HEZkoX3LIxYxHDB16Uzp+vTl9+dnxycoJ/Sj5LXkynL5KT5PT06HjLvT84mxgoeA1ThJIbwo4pT+5br5xdTVp0Mc6JqrIOJlI4uPrmeQQpSmXJHzbjllChBq4Jd+5YqvnM3rEIRIwx8J433FhhQCoLNVowVukOVhq3AJcpKJnXgA/CWOPuay6NsDGdocZDT7bMYxzHqy0z3GYIMyF5DmHBVjzjfBM5nLO6SiheOUX+5c0P34NBLXgujIdGNYOZwDw18Djg+DHEcRzBjpAYuOtja+DGmbZixhM7cKsJpYFbl0vztcOxCNooC8O8ku+9a31IXOMMNcoEwxB/eG7rcv3C+rBVDDfBImtmSkViY5jMnGu78y+MBxcPAjhTFDSythnFEtl+OCQOKCYyt7oLP5uhH7EhEphMVTmtDKoQljaZaVW4oY2bp5WFmchzvw2fWdRLrlPjgmsIOv9NeGF9mU2/SsQP4vLtj2+ub/9yc/l5HMdbAddDpVkrDMGnUwf84nRv3WKdRqbERMyER08UDuq2g4eAcDAGSL0BHHuynm/Sk9PT489bNU6OTo4GcscS83x0L9VSgl+ww4plJpIsIHhTtMTwV56L1KcOM4bb84sYXHlTiHlmSW98KLlMMfXZxFRlqTR5tq9MkxdoLmpswI1DIaQoeA4GnW272WECSEzQGK7reNNAV38M0EykRS15nte90DfdmVmgNgFKmpgH3QS083V3ED02bsT8yMXDg9U8cWamMc36HqJRaL8uN+507tDU5akna8uPpyfJi/Qlns5eDcX7oN7DxQPp7QKAStgptgjsMkh3U82GoHRTmQYqn67JQBSvxRYPKzawRKu4MhRMwiVVxt4lEYiCzzHqnV60yaZ8bep/snypSMf3WI9/ffXd/WzI1OeY8MplThApSksooZ9R5vQLugPCa0gyLucIaoHaJQSHPB6VOUj0LYSD4JAMe/N9mnfT3EHy9VgMk9AUEEw7m6y7uDUF7SWMz5YNqIWq0hcdneSuKcmVuqforcoW0eoQzVBW01wkrmjs4SXdLbm29YBQUsnRUwRL1uTi4Ia4pqgp1Z8ZoJbARFCiNooKCFkVU8qxWHCRA09TjcaggVGwJQcjeWkyZb1Zp0Kmhky9jvR/kIUD9Flf38xRl5qaxGCoNUX6dtTQOII2MhFwsOoeZZdAK+OCanIBBg1B1hZi+tA+M08P7U6craC+uD57ewtvJ2++vRjDTch9xkmiMXf7mUyUMEW7xFAO8MpmSnvY6xlWpkH30G35RNQvChIlE9TShNwjDO2BCy594xx6P/AtpYnhShkjpjm2eeuup8odg0MqhDHHObd4x7YM1SXl/wCkcoevViywiaXt9L5eDxLAO2tsOi3Ez5zW4nD5/qafoEKDdXD99vVnp8enz0mZrml5sgInRycvR0fHo+PT2+Oj8Yuj8dHRj9tVebNucwKCZEmlNUqb1/3DKox8Zt2Rb6K7cadRIOwz32nQaqhHpVZq1pR4uyrfnjZTpXLkcpc6oXXcbugTbl2UUi23kaiX3ECOMwvTnMv7JpsMlAJuNo32spLUXQ3wdIvr0CJvWfl77iHGbe9IBChUivmw2KENtMrVaiHaW9/cMcKOu3azOyeDrArqpnsSdJX1h1adIbv/jjb31auBNvcMTF0UaInHaPACDn2f25ZXzcHpVVgbto/hPbrWtovAnytjvb3yBmd82RW4ixZ3DjhlXCGfk4XaYR1zceBxKOHS16q6pTQcyq8RdREldz7XiAVKG0GpcpHUVF88j9lqtVqt0xg9a0cbFFAz2JS0gcPqk6OjPd20p5v2dNOebtrTTXu6aU837emmPd20p5v2dNOebtrTTXu6aU837emmPd20p5vW6aYtVmnTJK/X3zTrBPUvqaVgqoSK4VmV58RM+FeuCM1prZeek1pfcsqpiyordwz9y2IDE49/E5nVp2NQa6Vfq5RIGPf7orf9FpO2yZ90s7v4EtLi3EnZBtXLo6PVwPIDMdnF4fmA4qvVgNHfyZCUfsV0wDQv/49Nc41GVTpBB9MzVcltA53+RiL0f8tATQtFOYJqdrfNho0oo2FSaWFr95bmWSm+Qfr5gV6dPEeuUZ9VNnNXSGs+p9c52XpJQ/YoAiHAysqZg17hHLPD8NboYVffHHoAOQwINQr/Pm685rk67FOoXoWhN0kvsFBBQxaxSuf0tqe1pRkfHqZYqBEvRSzmmksbC3W4OGGk2Qa5YvncgfHwMsbfHljpQ2e+G4oi7/zGiK0Xub8QDb+LehZOuIvK7Ux0NXElNuEAtTg+eB1T0TW2lIU+rq3zEfw2UFC+IaZW40w8NDzIRy8jfIQDqayv963mwuekkif4PAKM5/HGsmMIE7+oVaXJIqN7rL/86GrUfrg8sqn7722Thy/f327r5hJG6BQClezE8ysFmanUWRMCWgu6o+vqLTeBtceSXEev/zI65Nfda7hvmmO08ZyDuPJPkeAtbdzSNL3pnyDxhiizXVzYIHvU7reTcRmgUoYJDbbrKcIgRzDcma23XDuaErb2XGJn7f7pUjqUyP3KtV8QbpWAu2s7CgPiIppUENgd128TxHpS78/tye5Opviqu7QOCd3gLdhtJ8HBP//+j+eeHrlZYipM5nk0fAhUymYzBQEtodRqIVLUMUwsdc4GDOazkSHuBcW8IWps3XRonLrJRKO7zHPXgKdiLiz1qzzP0XpiTxFbWqoULCaZVLmaC+rWUfJp7utLiUvIcYE54QqlLJfX+FTkwtZuEV5ZRbSOnEOiijIX3LUndG4D/TivQoftOHJwFSHwKhXWyVkQ7aUpyHKRoDTuBDZgWPIkQziJj7ZsvlwuY+5ux0rPD8Ncc/jt5PWb72/ejGjOqntE2fmBIDRVSUW1bwOyoVkK0Rm/iI/d0yFlbMFlTx7/ucPmZxZm1+PPXrHx3/pVR0BIiw/2sMy5kKS4s/RjyNo/Nd96uIzVO+9eHBax9dzNIjbe/khj7Zl1poylhR8f6YnMO52vVnT5lwq1qzYituDaRbFP8cLQ73S4U+4b+aB5

1xvscdn5TMqhxk5ol5WWXSD1w3VPm3vrmZEVtZ0g7v1vA9Q9Edsjl9//E9ymtrFTH+NGv/W4jB5PdiK1it5tBmbe0nxzbr+mu3lHynobvWApX1zLNlxQTfMnG7I65zl05A7giyF1/ZDmX84rPabxfltCYhxKhK4/uXXkUfpCBB92zWSl5XegvaTY45Qs6/N9g/WU73N/ZOaGtLfxocsqH1Wr1L5vTzHo=",sidebar_class_name:"put api-method",info_path:"docs/consent-management-individual-api/igrant-io-api-documentation",custom_edit_url:null},u=void 0,h={unversionedId:"consent-management-individual-api/service-update-individual-consent-record-signature",id:"consent-management-individual-api/service-update-individual-consent-record-signature",title:"Update consent record signature",description:"This endpoint is used to update a signature object for the consent record for an individual in an organiation defined in the consent building block.",source:"@site/docs/consent-management-individual-api/service-update-individual-consent-record-signature.api.mdx",sourceDirName:"consent-management-individual-api",slug:"/consent-management-individual-api/service-update-individual-consent-record-signature",permalink:"/docs/consent-management-individual-api/service-update-individual-consent-record-signature",draft:!1,editUrl:null,tags:[],version:"current",lastUpdatedAt:1780581133,formattedLastUpdatedAt:"Jun 4, 2026",frontMatter:{id:"service-update-individual-consent-record-signature",title:"Update consent record signature",description:"This endpoint is used to update a signature object for the consent record for an individual in an organiation defined in the consent building block.",sidebar_label:"Update consent record signature",hide_title:!0,hide_table_of_contents:!0,api:"eJztW9ty48YR/ZWueVltFQhddrWOWS5XpNWuTfmmSNpsytZW7RBoEmMBM/DMgBSs4lu+JJ+WL0n1zOBCEtzIjh9SCV9UFDCXvs3p7gPgkaVoEi1KK5RkY3abCQMo01IJaUEYqAymYBVUZcotAgcj5pLbSiOo6c+YWJgpDTZDSJQ0KC1oTJRO3WUuQchULERa8RyEpAtKz7kUnPaDFGdCYkp3+itMK5GnQs5hmqvkPmYRUyVqN2WSsjEzqBciwXdOpEm7wWs//drtf9OIySJWcs0LtKgNG//0uKHxOyl+qRAmF6BmTj6nFYuYoLsltxmLmOQFsjFL+jtMUhYxjb9UQmPKxlZXGDGTZFhwNn5kti5pirFayDlbraJHv2KGPEXdrfm3UZD7/HzU6fLbFo82dOrWgckFW33wS6Gx5yqtaX6ipEVp6Scvy1wkzriHPxua/tjbqNRkeivQuOutUTsZWntZYXO60Lf8ulhnMEeJWiS9ICJJuJAGOCS6Lq2aa15mIoGMm4xcYlSBsOB5hRGAVXO0GWpYCputBWOikVtMYVr7GaUWCwrYe6x94Ck3z9TGYhEDXAfbuiUo1gq0mUrNGK5xIQxFZ4hvF8d+9s1G7Md3kkXsYSSVHQk5SrnlU26QjWc8N9h34E+s5HWuOLnV9Ay0QC1mwfzfOQk2Ll610waufs1NtnGHRMT0vHYOKdBYXpTsQ7ThSJFuR1HEZkoX3LIxYxHDB16Uzp+vTl9+dnxycoJ/Sj5LXkynL5KT5PT06HjLvT84mxgoeA1ThJIbwo4pT+5br5xdTVp0Mc6JqrIOJlI4uPrmeQQpSmXJHzbjllChBq4Jd+5YqvnM3rEIRIwx8J433FhhQCoLNVowVukOVhq3AJcpKJnXgA/CWOPuay6NsDGdocZDT7bMYxzHqy0z3GYIMyF5DmHBVjzjfBM5nLO6SiheOUX+5c0P34NBLXgujIdGNYOZwDw18Djg+DHEcRzBjpAYuOtja+DGmbZixhM7cKsJpYFbl0vztcOxCNooC8O8ku+9a31IXOMMNcoEwxB/eG7rcv3C+rBVDDfBImtmSkViY5jMnGu78y+MBxcPAjhTFDSythnFEtl+OCQOKCYyt7oLP5uhH7EhEphMVTmtDKoQljaZaVW4oY2bp5WFmchzvw2fWdRLrlPjgmsIOv9NeGF9mU2/SsQP4vLtj2+ub/9yc/l5HMdbAddDpVkrDMGnUwf84nRv3WKdRqbERMyER08UDuq2g4eAcDAGSL0BHHuynm/Sk9PT489bNU6OTo4GcscS83x0L9VSgl+ww4plJpIsIHhTtMTwV56L1KcOM4bb84sYXHlTiHlmSW98KLlMMfXZxFRlqTR5tq9MkxdoLmpswI1DIaQoeA4GnW272WECSEzQGK7reNNAV38M0EykRS15nte90DfdmVmgNgFKmpgH3QS083V3ED02bsT8yMXDg9U8cWamMc36HqJRaL8uN+507tDU5akna8uPpyfJi/Qlns5eDcX7oN7DxQPp7QKAStgptgjsMkh3U82GoHRTmQYqn67JQBSvxRYPKzawRKu4MhRMwiVVxt4lEYiCzzHqnV60yaZ8bep/snypSMf3WI9/ffXd/WzI1OeY8MplThApSksooZ9R5vQLugPCa0gyLucIaoHaJQSHPB6VOUj0LYSD4JAMe/N9mnfT3EHy9VgMk9AUEEw7m6y7uDUF7SWMz5YNqIWq0hcdneSuKcmVuqforcoW0eoQzVBW01wkrmjs4SXdLbm29YBQUsnRUwRL1uTi4Ia4pqgp1Z8ZoJbARFCiNooKCFkVU8qxWHCRA09TjcaggVGwJQcjeWkyZb1Zp0Kmhky9jvR/kIUD9Flf38xRl5qaxGCoNUX6dtTQOII2MhFwsOoeZZdAK+OCanIBBg1B1hZi+tA+M08P7U6craC+uD57ewtvJ2++vRjDTch9xkmiMXf7mUyUMEW7xFAO8MpmSnvY6xlWpkH30G35RNQvChIlE9TShNwjDO2BCy594xx6P/AtpYnhShkjpjm2eeuup8odg0MqhDHHObd4x7YM1SXl/wCkcoevViywiaXt9L5eDxLAO2tsOi3Ez5zW4nD5/qafoEKDdXD99vVnp8enz0mZrml5sgInRycvR0fHo+PT2+Oj8Yuj8dHRj9tVebNucwKCZEmlNUqb1/3DKox8Zt2Rb6K7cadRIOwz32nQaqhHpVZq1pR4uyrfnjZTpXLkcpc6oXXcbugTbl2UUi23kaiX3ECOMwvTnMv7JpsMlAJuNo32spLUXQ3wdIvr0CJvWfl77iHGbe9IBChUivmw2KENtMrVaiHaW9/cMcKOu3azOyeDrArqpnsSdJX1h1adIbv/jjb31auBNvcMTF0UaInHaPACDn2f25ZXzcHpVVgbto/hPbrWtovAnytjvb3yBmd82RW4ixZ3DjhlXCGfk4XaYR1zceBxKOHS16q6pTQcyq8RdREldz7XiAVKG0GpcpHUVF88j9lqtVqt0xg9a0cbFFAz2JS0gcPqk6OjPd20p5v2dNOebtrTTXu6aU837emmPd20p5v2dNOebtrTTXu6aU837emmPd20p5vW6aYtVmnTJK/X3zTrBPUvqaVgqoSK4VmV58RM+FeuCM1prZeek1

1pfcsqpiyordwz9y2IDE49/E5nVp2NQa6Vfq5RIGPf7orf9FpO2yZ90s7v4EtLi3EnZBtXLo6PVwPIDMdnF4fmA4qvVgNHfyZCUfsV0wDQv/49Nc41GVTpBB9MzVcltA53+RiL0f8tATQtFOYJqdrfNho0oo2FSaWFr95bmWSm+Qfr5gV6dPEeuUZ9VNnNXSGs+p9c52XpJQ/YoAiHAysqZg17hHLPD8NboYVffHHoAOQwINQr/Pm685rk67FOoXoWhN0kvsFBBQxaxSuf0tqe1pRkfHqZYqBEvRSzmmksbC3W4OGGk2Qa5YvncgfHwMsbfHljpQ2e+G4oi7/zGiK0Xub8QDb+LehZOuIvK7Ux0NXElNuEAtTg+eB1T0TW2lIU+rq3zEfw2UFC+IaZW40w8NDzIRy8jfIQDqayv963mwuekkif4PAKM5/HGsmMIE7+oVaXJIqN7rL/86GrUfrg8sqn7722Thy/f327r5hJG6BQClezE8ysFmanUWRMCWgu6o+vqLTeBtceSXEev/zI65Nfda7hvmmO08ZyDuPJPkeAtbdzSNL3pnyDxhiizXVzYIHvU7reTcRmgUoYJDbbrKcIgRzDcma23XDuaErb2XGJn7f7pUjqUyP3KtV8QbpWAu2s7CgPiIppUENgd128TxHpS78/tye5Opviqu7QOCd3gLdhtJ8HBP//+j+eeHrlZYipM5nk0fAhUymYzBQEtodRqIVLUMUwsdc4GDOazkSHuBcW8IWps3XRonLrJRKO7zHPXgKdiLiz1qzzP0XpiTxFbWqoULCaZVLmaC+rWUfJp7utLiUvIcYE54QqlLJfX+FTkwtZuEV5ZRbSOnEOiijIX3LUndG4D/TivQoftOHJwFSHwKhXWyVkQ7aUpyHKRoDTuBDZgWPIkQziJj7ZsvlwuY+5ux0rPD8Ncc/jt5PWb72/ejGjOqntE2fmBIDRVSUW1bwOyoVkK0Rm/iI/d0yFlbMFlTx7/ucPmZxZm1+PPXrHx3/pVR0BIiw/2sMy5kKS4s/RjyNo/Nd96uIzVO+9eHBax9dzNIjbe/khj7Zl1poylhR8f6YnMO52vVnT5lwq1qzYituDaRbFP8cLQ73S4U+4b+aB5xvscdn5TMqhxk5ol5WWXSD1w3VPm3vrmZEVtZ0g7v1vA9Q9Edsjl9//E9ymtrFTH+NGv/W4jB5PdiK1it5tBmbe0nxzbr+mu3lHynobvWApX1zLNlxQTfMnG7I65zl05A7giyF1/ZDmX84rPabxfltCYhxKhK4/uXXkUfpCBB92zWSl5XegvaTY45Qs6/N9g/WU73N/ZOaGtLfxocsqH1Wr1L5vTzHo=",sidebar_class_name:"put api-method",info_path:"docs/consent-management-individual-api/igrant-io-api-documentation",custom_edit_url:null},sidebar:"openApiSidebar",previous:{title:"Creates blank signature",permalink:"/docs/consent-management-individual-api/service-create-individual-consent-record-signature"},next:{title:"List all consent records",permalink:"/docs/consent-management-individual-api/service-list-individual-agreement-consent-record-list"}},f={},b=[{value:"Request",id:"request",level:2}],v={toc:b},T="wrapper";function x(e){let{components:a,...i}=e;return(0,s.yg)(T,(0,t.A)({},v,i,{components:a,mdxType:"MDXLayout"}),(0,s.yg)("h1",{className:"openapi__heading"},"Update consent record signature"),(0,s.yg)(o(),{method:"put",path:"/service/individual/record/consent-record/{consentRecordId}/signature",mdxType:"MethodEndpoint"}),(0,s.yg)("p",null,"This endpoint is used to update a signature object for the consent record for an individual in an organiation defined in the consent building block."),(0,s.yg)("h2",{id:"request"},"Request"),(0,s.yg)("details",{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0},(0,s.yg)("summary",{style:{}},(0,s.yg)("h3",{className:"openapi-markdown__details-summary-header-params"},"Path Parameters")),(0,s.yg)("div",null,(0,s.yg)("ul",null,(0,s.yg)(l.A,{className:"paramsItem",param:{description:"Unique ID of an object",in:"path",name:"consentRecordId",required:!0,schema:{type:"string"}},mdxType:"ParamsItem"})))),(0,s.yg)("details",{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0},(0,s.yg)("summary",{style:{}},(0,s.yg)("h3",{className:"openapi-markdown__details-summary-header-params"},"Header Parameters")),(0,s.yg)("div",null,(0,s.yg)("ul",null,(0,s.yg)(l.A,{className:"paramsItem",param:{in:"header",name:"X-ConsentBB-IndividualId",required:!0,schema:{type:"string"},description:"Individual ID"},mdxType:"ParamsItem"})))),(0,s.yg)(m.A,{className:"openapi-tabs__mime",mdxType:"MimeTabs"},(0,s.yg)(g.default,{label:"application/json",value:"application/json-schema",mdxType:"TabItem"},(0,s.yg)("details",{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0},(0,s.yg)("summary",{style:{},className:"openapi-markdown__details-summary-mime"},(0,s.yg)("h3",{className:"openapi-markdown__details-summary-header-body"},"Body")),(0,s.yg)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.yg)("ul",{style:{marginLeft:"1rem"}},(0,s.yg)(c.A,{collapsible:!0,className:"schemaItem",mdxType:"SchemaItem"},(0,s.yg)("details",{style:{},className:"openapi-markdown__details"},(0,s.yg)("summary",{style:{}},(0,s.yg)("span",{className:"openapi-schema__container"},(0,s.yg)("strong",{className:"openapi-schema__property"},"signature"),(0,s.yg)("span",{className:"openapi-schema__name"}," object"),(0,s.yg)("span",{className:"openapi-schema__divider"}),(0,s.yg)("span",{className:"openapi-schema__required"},"required"))),(0,s.yg)("div",{style:{marginLeft:"1rem"}},(0,s.yg)("div",{style:{marginTop:".5rem",marginBottom:".5rem"}},(0,s.yg)("p",null,"A generic signature contains a cryptographic hash of some value,  together with a signature created by some private key in another system.  Required signing methods: Revision object or another Signature object.")),(0,s.yg)(c.A,{collapsible:!1,name:"id",required:!1,schemaName:"string",qualifierMessage:void 0,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.'},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"payload",required:!0,schemaName:"string",qualifierMessage:void 0,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 

1in afterwards."},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"signature",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"",example:"eyJhbGciOiJFZERTQSJ9...",description:"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationMethod",required:!0,schemaName:"string",qualifierMessage:void 0,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."},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationPayload",required:!0,schemaName:"string",qualifierMessage:void 0,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"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationPayloadHash",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"",example:"a1b2c3d4e5f6...",description:"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationArtifact",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"",example:"",description:"A verification artifact in the form of a scanned object, image, signature etc"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationSignedBy",required:!0,schemaName:"string",qualifierMessage:void 0,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."},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationSignedAs",required:!1,schemaName:"string",qualifierMessage:void 0,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".'},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationJwsHeader",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"",example:"",description:"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"timestamp",required:!0,schemaName:"string",qualifierMessage:void 0,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"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"signedWithoutObjectReference",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",format:"",example:!1,description:"Indicates that objectReference was left blank in the serialised version that was signed"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"objectType",required:!1,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"]},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"objectReference",required:!1,schemaName:"string",qualifierMessage:void 0,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)."},mdxType:"SchemaItem"})))))))),(0,s.yg)("div",null,(0,s.yg)("div",null,(0,s.yg)(n.A,{label:void 0,id:void 0,mdxType:"ApiTabs"},(0,s.yg)(g.default,{label:"200",value:"200",mdxType:"TabItem"},(0,s.yg)("div",null,(0,s.yg)("p",null,"Consent record signature updated successfully")),(0,s.yg)("details",{style:{textAlign:"left",marginBottom:"1rem"},className:"openapi-markdown__details","data-collaposed":!0,open:!1},(0,s.yg)("summary",{style:{}},(0,s.yg)("strong",null,"Response Headers")),(0,s.yg)("ul",{style:{marginLeft:"1rem"}})),(0,s.yg)("div",null,(0,s.yg)(m.A,{className:"openapi-tabs__mime",schemaType:"response",mdxType:"MimeTabs"},(0,s.yg)(g.default,{label:"application/json",value:"application/json",mdxType:"TabItem"},(0,s.yg)(p.default,{className:"openapi-tabs__schema",mdxType:"SchemaTabs"},(0,s.yg)(g.default,{label:"Schema",value:"Schema",mdxType:"TabItem"},(0,s.yg)("details",{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0},(0,s.yg)("summary",{style:{},className:"openapi-markdown__details-summary-response"},(0,s.yg)("strong",null,"Schema")),(0,s.yg)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.yg)("ul",{style:{marginLeft:"1rem"}},(0,s.yg)(c.A,{collapsible:!0,className:"schemaItem",mdxType:"SchemaItem"},(0,s.yg)("details",{style:{},className:"openapi-markdown__details"},(0,s.yg)("summary",{style:{}},(0,s.yg)("span",{className:"openapi-schema__container"},(0,s.yg)("strong",{className:"openapi-schema__property"},"signature"),(0,s.yg)("span",{className:"openapi-schema__name"}," object"))),(0,s.yg)("div",{style:{marginLeft:"1rem"}},(0,s.yg)("div",{style:{marginTop:".5rem",marginBottom:".5rem"}},(0,s.yg)("p",null,"A generic signature contains a cryptographic hash of some value,  together with a signature created by some private key in another system.  Required signing methods: Revision object or another Signature object.")),(0,s.yg)(c.A,{collapsible:!1,name:"id",required:!1,schemaName:"string",qualifierMessage:void 0,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.'},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"payload",required:!0,schemaName:"string",qualifierMessage:void 0,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 

1in afterwards."},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"signature",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"",example:"eyJhbGciOiJFZERTQSJ9...",description:"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationMethod",required:!0,schemaName:"string",qualifierMessage:void 0,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."},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationPayload",required:!0,schemaName:"string",qualifierMessage:void 0,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"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationPayloadHash",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"",example:"a1b2c3d4e5f6...",description:"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationArtifact",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"",example:"",description:"A verification artifact in the form of a scanned object, image, signature etc"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationSignedBy",required:!0,schemaName:"string",qualifierMessage:void 0,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."},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationSignedAs",required:!1,schemaName:"string",qualifierMessage:void 0,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".'},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"verificationJwsHeader",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"",example:"",description:"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"timestamp",required:!0,schemaName:"string",qualifierMessage:void 0,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"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"signedWithoutObjectReference",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",format:"",example:!1,description:"Indicates that objectReference was left blank in the serialised version that was signed"},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"objectType",required:!1,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"]},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"objectReference",required:!1,schemaName:"string",qualifierMessage:void 0,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)."},mdxType:"SchemaItem"}))))))),(0,s.yg)(g.default,{label:"Example (from schema)",value:"Example (from schema)",mdxType:"TabItem"}

1,(0,s.yg)(d.A,{responseExample:'{\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}',language:"json",mdxType:"ResponseSamples"}))))))),(0,s.yg)(g.default,{label:"400",value:"400",mdxType:"TabItem"},(0,s.yg)("div",null,(0,s.yg)("p",null,"bad input parameter")),(0,s.yg)("details",{style:{textAlign:"left",marginBottom:"1rem"},className:"openapi-markdown__details","data-collaposed":!0,open:!1},(0,s.yg)("summary",{style:{}},(0,s.yg)("strong",null,"Response Headers")),(0,s.yg)("ul",{style:{marginLeft:"1rem"}})),(0,s.yg)("div",null)),(0,s.yg)(g.default,{label:"401",value:"401",mdxType:"TabItem"},(0,s.yg)("div",null,(0,s.yg)("p",null,"Unauthorized")),(0,s.yg)("details",{style:{textAlign:"left",marginBottom:"1rem"},className:"openapi-markdown__details","data-collaposed":!0,open:!1},(0,s.yg)("summary",{style:{}},(0,s.yg)("strong",null,"Response Headers")),(0,s.yg)("ul",{style:{marginLeft:"1rem"}})),(0,s.yg)("div",null,(0,s.yg)(m.A,{className:"openapi-tabs__mime",schemaType:"response",mdxType:"MimeTabs"},(0,s.yg)(g.default,{label:"application/json",value:"application/json",mdxType:"TabItem"},(0,s.yg)(p.default,{className:"openapi-tabs__schema",mdxType:"SchemaTabs"},(0,s.yg)(g.default,{label:"Schema",value:"Schema",mdxType:"TabItem"},(0,s.yg)("details",{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0},(0,s.yg)("summary",{style:{},className:"openapi-markdown__details-summary-response"},(0,s.yg)("strong",null,"Schema")),(0,s.yg)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.yg)("ul",{style:{marginLeft:"1rem"}},(0,s.yg)(c.A,{collapsible:!1,name:"errorCode",required:!0,schemaName:"integer",qualifierMessage:void 0,schema:{type:"integer",example:400},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"errorDescription",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bad input parameter"},mdxType:"SchemaItem"})))),(0,s.yg)(g.default,{label:"Example (from schema)",value:"Example (from schema)",mdxType:"TabItem"},(0,s.yg)(d.A,{responseExample:'{\n  "errorCode": 400,\n  "errorDescription": "Bad input parameter"\n}',language:"json",mdxType:"ResponseSamples"}))))))),(0,s.yg)(g.default,{label:"404",value:"404",mdxType:"TabItem"},(0,s.yg)("div",null,(0,s.yg)("p",null,"Resource not found")),(0,s.yg)("details",{style:{textAlign:"left",marginBottom:"1rem"},className:"openapi-markdown__details","data-collaposed":!0,open:!1},(0,s.yg)("summary",{style:{}},(0,s.yg)("strong",null,"Response Headers")),(0,s.yg)("ul",{style:{marginLeft:"1rem"}})),(0,s.yg)("div",null,(0,s.yg)(m.A,{className:"openapi-tabs__mime",schemaType:"response",mdxType:"MimeTabs"},(0,s.yg)(g.default,{label:"application/json",value:"application/json",mdxType:"TabItem"},(0,s.yg)(p.default,{className:"openapi-tabs__schema",mdxType:"SchemaTabs"},(0,s.yg)(g.default,{label:"Schema",value:"Schema",mdxType:"TabItem"},(0,s.yg)("details",{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0},(0,s.yg)("summary",{style:{},className:"openapi-markdown__details-summary-response"},(0,s.yg)("strong",null,"Schema")),(0,s.yg)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.yg)("ul",{style:{marginLeft:"1rem"}},(0,s.yg)(c.A,{collapsible:!1,name:"errorCode",required:!0,schemaName:"integer",qualifierMessage:void 0,schema:{type:"integer",example:400},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"errorDescription",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bad input parameter"},mdxType:"SchemaItem"})))),(0,s.yg)(g.default,{label:"Example (from schema)",value:"Example (from schema)",mdxType:"TabItem"}

1,(0,s.yg)(d.A,{responseExample:'{\n  "errorCode": 400,\n  "errorDescription": "Bad input parameter"\n}',language:"json",mdxType:"ResponseSamples"}))))))),(0,s.yg)(g.default,{label:"500",value:"500",mdxType:"TabItem"},(0,s.yg)("div",null,(0,s.yg)("p",null,"Internal server error")),(0,s.yg)("details",{style:{textAlign:"left",marginBottom:"1rem"},className:"openapi-markdown__details","data-collaposed":!0,open:!1},(0,s.yg)("summary",{style:{}},(0,s.yg)("strong",null,"Response Headers")),(0,s.yg)("ul",{style:{marginLeft:"1rem"}})),(0,s.yg)("div",null,(0,s.yg)(m.A,{className:"openapi-tabs__mime",schemaType:"response",mdxType:"MimeTabs"},(0,s.yg)(g.default,{label:"application/json",value:"application/json",mdxType:"TabItem"},(0,s.yg)(p.default,{className:"openapi-tabs__schema",mdxType:"SchemaTabs"},(0,s.yg)(g.default,{label:"Schema",value:"Schema",mdxType:"TabItem"},(0,s.yg)("details",{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0},(0,s.yg)("summary",{style:{},className:"openapi-markdown__details-summary-response"},(0,s.yg)("strong",null,"Schema")),(0,s.yg)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.yg)("ul",{style:{marginLeft:"1rem"}},(0,s.yg)(c.A,{collapsible:!1,name:"errorCode",required:!0,schemaName:"integer",qualifierMessage:void 0,schema:{type:"integer",example:400},mdxType:"SchemaItem"}),(0,s.yg)(c.A,{collapsible:!1,name:"errorDescription",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bad input parameter"},mdxType:"SchemaItem"})))),(0,s.yg)(g.default,{label:"Example (from schema)",value:"Example (from schema)",mdxType:"TabItem"},(0,s.yg)(d.A,{responseExample:'{\n  "errorCode": 400,\n  "errorDescription": "Bad input parameter"\n}',language:"json",mdxType:"ResponseSamples"})))))))))))}x.isMDXComponent=!0}}]);
2//# sourceMappingURL=789474e9.e480b398.js.map