Skip to main content
POST
Capture dual-party recording consent for a call

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
call_id
string
required

The call this consent covers.

Required string length: 1 - 64
parties
object[]
required

One entry per party whose consent is being recorded. Every entry must be granted: true.

Required array length: 1 - 16 elements
recording_id
string

Optional recording id to bind the receipt to a specific artifact.

Required string length: 1 - 64

How consent was collected. Defaults to ivr_announcement.

Available options:
ivr_dtmf,
ivr_speech,
ivr_announcement,
pre_recorded_disclosure,
operator_attested,
verbal_attested,
written_consent

Version tag of the consent disclosure text shown. Defaults to v1.

Required string length: 1 - 32

Optional verbatim disclosure text presented to the parties.

Maximum string length: 2000
jurisdiction
string

Optional jurisdiction code the consent was captured under.

Maximum string length: 64

Response

Consent captured — returns the minted consent_receipt_id, call_id, party_count, and expires_at.