Create consents in bulk

Create multiple consent requests at once. Email-type consents are automatically sent to recipients.
Resellers can send consents on behalf of their customers.

Recipient requirements:

  • Must provide email
  • Must provide EITHER (firstname AND lastname) OR (company, optionally with identifier + identifierType)

Type-specific rules:

  • EMAIL/LINK: delayInDays is optional (defaults to configured value)
  • MANUAL: state is required, delayInDays is optional
Body Params
recipients
array of objects
required
length ≥ 1

List of consent recipients

recipients*

Must provide either:

  • Natural person: firstname AND lastname
  • Legal person: company (optionally with identifier + identifierType)

If identifierType is provided, identifier is required and its format is enforced for that type. If identifier is provided without identifierType, identifierType defaults to SIREN and the SIREN format is enforced.

string
required

Recipient email address

string

Recipient first name (required for natural persons)

string

Recipient last name (required for natural persons)

string

Company name (required for legal persons)

string

Legal person identifier. The format must match identifierType:

  • SIREN (France): 9 digits, e.g. "123456789"
  • BCE (Belgium): 10 digits starting with 0 or 1, with or without dots, e.g. "0403170701" or "0403.170.701"

Required when identifierType is provided. Sending identifierType without identifier is rejected.

string
enum

Type of legal identifier. Defaults to SIREN when identifier is provided without identifierType. The identifier format is validated against this type.

Allowed:
string
enum
required

Consent delivery method:

  • EMAIL: Automatically sent via email
  • LINK: Generate shareable link
  • MANUAL: Manual consent creation
Allowed:
integer
enum

Number of days before consent expires.
Optional for EMAIL/LINK (uses default if not provided).
Optional for MANUAL.

Allowed:
string
enum

Initial consent state. Required when type is MANUAL.
Not applicable for EMAIL/LINK types.

Allowed:
uuid

Customer ID (for resellers sending on behalf of customers)

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json