Consent

Unique identifier for the consent record.

Consent record reused by an automatic acceptance.

string

Organization that owns the consent record.

string

nullable

Member associated with the consent.

string

nullable

Package associated with the consent.

string

nullable

Signer associated with the consent.

string

nullable

Identity verification associated with the consent.

string

nullable

Signing session associated with the consent.

string

nullable

Time the consent was accepted (ISO 8601 date-time).

string

nullable

Time the consent was declined (ISO 8601 date-time).

string

nullable

Time the consent was revoked (ISO 8601 date-time).

string

nullable

IP address from which consent was recorded.

string

Action used to record the consent.

Show values

Value	Version	Description
`auto`	4.2	Consent was reused automatically under the configured policy.
`clicked_consent_button`	4.2	The signer accepted by selecting the consent button.
`clicked_decline_button`	4.2	The signer declined by selecting the decline button.
`checked_consent_checkbox`	4.2	The signer accepted by selecting the consent checkbox.
`on_behalf_of`	4.2	Consent was recorded on behalf of the signer.

string

Base64-encoded SHA-256 version of the consent notice.

object

nullable

Notice presented when consent was recorded.

Show properties

string

nullable

Default notice text.

Map<string, string>

nullable

Notice text keyed by locale code.

string

Consent type.

Show values

Value	Version	Description
`signing`	4.2	Consent to sign documents.
`verification`	4.2	Consent to complete identity verification.
`video_recording`	4.2	Consent to record a Video Signing Room session.

string

Current consent state.

Show values

Value	Version	Description
`required`	4.2	Consent is required and has not yet been accepted or declined.
`accepted`	4.2	Consent was accepted.
`declined`	4.2	Consent was declined.
`revoked`	4.2	Previously accepted consent was revoked.

Getting started

Guides

API

Webhooks

Reference