Skip to content
vocapable.Docs

A customer's consent records by channel, with revocations (read-only)

GET
/v1/workspace/contacts/{contact_id}/consent-ledger
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/contacts/example/consent-ledger \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
contact_id
required
Contact Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceConsentLedger
object
contact_id
required
Contact Id
string
do_not_contact
required
Do Not Contact
boolean
on_internal_dnc
required
On Internal Dnc
boolean
channels
required
Channels
Array<object>
WorkspaceConsentChannelStatus
object
channel
required
Channel
string
Allowed values: voice sms email ai_call
state
required
State
string
Allowed values: covered missing stopped not_required
basis
required
Any of:
string
record_ids
required
Record Ids
Array<string>
explanation
required
Explanation
string
entries
required
Entries
Array<object>
WorkspaceConsentEntry
object
id
required
Id
string
basis
required
Basis
string
channels
required
Channels
Array<string>
purposes
required
Purposes
Array<string>
source
required
Source
string
evidence
required
Any of:
string
note
required
Any of:
string
disclosure_text
required
Any of:
string
captured_at
required
Captured At
string format: date-time
expires_at
required
Any of:
string format: date-time
status
required
Status
string
recorded_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
authorizes_ai
required
Authorizes Ai
boolean
revocations
required
Revocations
Array<object>
WorkspaceConsentRevocation
object
id
required
Id
string
revokes_consent_id
required
Any of:
string
source
required
Source
string
captured_at
required
Captured At
string format: date-time
ebr
required
WorkspaceEbrStatus

The established-business-relationship clock (47 C.F.R. § 64.1200(f)(5)).

18 months after a purchase or transaction, 3 months after an inquiry; a do-not-call request ends it. active is False when no EBR record is on the ledger or it lapsed.

object
active
required
Active
boolean
kind
required
Any of:
string
Allowed values: transaction inquiry
since
required
Any of:
string format: date-time
expires_at
required
Any of:
string format: date-time
record_id
required
Any of:
string
explanation
required
Explanation
string
national_dnc
required
WorkspaceNationalDncStatus

What is on record about National Do Not Call screening for marketing calls.

Registry screening runs upstream, on the company’s side, under its own SAN (adr/0018-no-compliance-data-bureau.md). company_attested means the company signed the attestation that it screens its lists before they arrive; it is never a statement that this number was checked.

object
status
required
Status
string
Allowed values: company_attested not_on_record
attested_by
required
Any of:
string
attested_at
required
Any of:
string format: date-time
san_on_file
required
San On File
boolean
san_expires_at
required
Any of:
string format: date-time
explanation
required
Explanation
string
can_review
required
Can Review
boolean
evaluated_at
required
Evaluated At
string format: date-time
Example
{
  "channels": [
    {
      "channel": "voice",
      "state": "covered"
    }
  ],
  "ebr": {
    "kind": "transaction"
  },
  "national_dnc": {
    "status": "company_attested"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}