Prepare and serve a consent form for a user.

This API can be used to redirect the user to a form hosted on ConsentGrid™. See here for a more detailed explanation.

Authorization: Bearer apiKey
Content-Type: application/json
Accept: application/json | ""
cookie cgs_{accountURL}: session
Content-Type: application/json
Accept: application/json | ""

This API is similar to the build consent form API. It instantiates a consent form template, but instead of returning the template, it prepares a URL and returns either an HTTP redirect to that URL, or a JSON document containing the URL. The calling application can redirect the user to this URL to serve and process the form. Once the form is processed, the user will be redirected back to the application.

The templateName, along with the optional locale query parameter, will be used to select the consent form with the given specific locale. If a consent form template for this locale is not available, the form template for the default locale will be used.

The subjectId specifies the data subject for which the form is being instantiated. If there is a data subject with this id is in the database, it will be loaded, and combined with the data subject information submitted in the request body. This means if you uploaded your subject information before, then by providing the subjectId in the request document you can load the subject information from the database. The subjectOption query parameter determines how to process the subject information in the document. Possible values are:

merge or unspecified
Merge the given subject information with the subject information in the database, and use it to build the consent form template.
Overwrite the subject information as given in the request body.
Only store the subject id in the database. The form template can still use any subject information submitted in the request body.

The type path parameter is either new that means no existing consent information is loaded to initialize the form, or current that means existing consent information is loaded and used to initialize the form. This only works for SmartConsents with at most one active consent record (that is, consent cancels existing active consents when user saves a new consent record).

If Accept header is ommitted or anything other than application/json, this API returns an HTTP redirect response with a URL the end user should visit to interact with the form. If Accept: application/json, the API returns a JSON document pointing to the consent form, as follows:

 "uri": "https://consentgrid...."

The ok and err query parameters will be appended to the form action URL. If the ok=ok_uri query parameter is given, an HTTP redirect response to this URI will be returned upon successful submission of the form. If the err=err_uri query parameter is given, errors during submission will be redirected to this URI. If the error URI is not given, errors will be redirected to the ok_uri, with an additional query parameter err=msg containing the error message.

The request body optionally contains subject information. The subject data must validate with the data subject schema.

  "subject": {
    Subject fields

by is an optional field that specifies the user identifier for the user saving the consent on behalf of the data subject. If omitted or empty, it is assumed that the data subject is recording the consent himself/herself.