Create consent record with signature
Saves a consent record that the individual signed, in one step. Get the draft with "Create draft consent record", sign it, and send the record and the signature. The record is saved with optIn: true and the state signed.
The server verifies signature.signature (a compact JWS, ES256) with the public key in signature.verificationSignedBy (an EC P-256 JWK as a JSON string). The new revision of the record takes verificationPayload and verificationPayloadHash from the signature as its snapshot and hash.
Authorizations
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
consent-records:create
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"
Body
consentRecord objectrequiredThe draft consent record. The server reads only the members below.
signatureobjectrequiredA 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.
Response
The new consent record, its first revision and the saved signature.
consentRecord objectThe 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.
revisionobjectOne 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
successorIdchanges after the server saves a revision.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.