Skip to navigation
Customer Onboarding

Relay (or withdraw) the customer’s consent

View as Markdown

Send granted: false to relay a withdrawal. Answers the customer’s state per purpose.

Authentication

AuthorizationBearer

The token Liquify issued your organisation. Shown once; rotate it from Liquify if it is exposed.

Path parameters

customer_idstringRequired<=64 characters

The customer_id POST /v1/customers returned.

Request

This endpoint expects an object.
purposeslist of enumsRequired
Only the purposes the customer ticked.
Allowed values:
grantedbooleanRequired

false relays a withdrawal.

captured_atdatetimeRequired

When the customer agreed. Not in the future; relayed within 24 hours.

ipstringRequired<=64 characters
The customer's IP address when they agreed.
consent_text_versionstringRequired<=64 characters
The version of Liquify's consent text you showed. Wording you wrote yourself is refused.
devicestringOptional<=300 characters
The customer's user agent or device.

Response

The customer's consent per purpose, after this call.
datalist of objects
metaobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error