Create blank signature
Gives a signature template for the latest revision of a consent record, without saving it. Use it to sign a record that is unsigned, for example after an update:
-
Call this route.
verificationPayloadis the snapshot of the latest revision, andverificationPayloadHashits hash. -
Sign it on the device of the individual: a compact JWS (ES256) with the private key of the individual.
-
Send the template with
signatureandverificationSignedByfilled in to "Update consent record signature".
Authorizations
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
consent-records:sign
Path parameters
consentRecord Id stringrequiredConsent record ID.
Example:
"6af081ea2d6fb7b6ac6efc71"
Headers
X-Consent BB- Individual Id stringID of the individual, or its
externalId. Mandatory with an API key: without it the answer is400("IndividualId is not present in request header"), and an unknown individual gets400too. With an individual token, leave it out: the server takes the individual from the token. Send it only on the routes that list it: with an API key that has resource scopes (for exampleconsent-records:read), another route answers400to a request with this header.Example:
"6af081b138e8f33dcf799628"
Response
The signature template. Its id, signature and verificationSignedBy are empty.
signatureobjectA signature of a consent record by the individual. For a consent record, the server verifies
signaturewith the public key inverificationSignedByand stores the other members as you send them. Members that nobody set are empty.