Skip to main content
Signatures

Create blank signature

POST/v4/service/consent/individual/record/consent-record/{consentRecordId}/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:

  1. Call this route. verificationPayload is the snapshot of the latest revision, and verificationPayloadHash its hash.

  2. Sign it on the device of the individual: a compact JWS (ES256) with the private key of the individual.

  3. Send the template with signature and verificationSignedBy filled in to "Update consent record signature".

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"

Response

application/json

The signature template. Its id, signature and verificationSignedBy are empty.

  • 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.