Create draft consent record
Gives a draft consent record for the individual and a data agreement, without saving it. Use it when the individual must sign the consent before the server saves it: build the signature from the draft, then send both with "Create consent record with signature".
The draft has no id, optIn: true, and the latest data agreement revision (or the one in revisionId). The signature in the answer is empty. individualId must be the individual of the request.
Authorizations
AuthorizationstringheaderrequiredYour API key with the prefix
ApiKey:ApiKey <your-api-key>. Get an API key.Scope:
consent-records:create
Query parameters
individualId stringrequiredIndividual ID (the
id, not theexternalId). It must be the individual of the request.Example:
"6af0821c38e8f33dcf79962e"dataAgreement Id stringrequiredData agreement ID.
Example:
"6af0821c2d6fb7b6ac6efc78"revisionId stringRevision ID. Give it to get the record as it was at that revision. Without it, the server uses the latest revision.
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 draft consent record and an empty 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.
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.