Skip to main content
Signatures

Update consent record signature

PUT/v4/service/consent/individual/record/consent-record/{consentRecordId}/signature

Saves the signature of the individual for a consent record and makes the record signed. Send the template from "Create blank signature" with signature (a compact JWS, ES256) and verificationSignedBy (the public key as an EC P-256 JWK in a JSON string) filled in. The server verifies the JWS with the key.

The record moves to the latest revision of the data agreement, and the server saves a new revision of the record with verificationPayload and verificationPayloadHash as its snapshot and hash. The signatureId of the record does not change.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:consent-records:sign

Path parameters

  • consentRecordIdstringrequired

    Consent record ID.

    Example:"6af081ea2d6fb7b6ac6efc71"

Headers

  • X-ConsentBB-IndividualIdstring

    ID of the individual, or its externalId. Mandatory with an API key: without it the answer is 400 ("IndividualId is not present in request header"), and an unknown individual gets 400 too. 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 example consent-records:read), another route answers 400 to a request with this header.

    Example:"6af081b138e8f33dcf799628"

Body

application/json
  • signatureobjectrequired

    A signature of a consent record by the individual. For a consent record, the server verifies signature with the public key in verificationSignedBy and stores the other members as you send them. Members that nobody set are empty.

Response

application/json

The signed consent record, its new revision and the saved signature.

  • consentRecordobject

    The consent of one individual to one data agreement. An individual has at most one consent record for each data agreement. Each change makes a new revision of the record.

  • revisionobject

    One saved version of a record (a data agreement, a policy, a consent record or a data disclosure agreement). Each change makes a new revision. The revision holds the record as JSON and a SHA-1 hash of the snapshot, and it links to the hash of the revision before it, so that you can detect a changed history. Only successorId changes after the server saves a revision.

  • signatureobject

    A signature of a consent record by the individual. For a consent record, the server verifies signature with the public key in verificationSignedBy and stores the other members as you send them. Members that nobody set are empty.