Your company's National Do Not Call setup: its SAN and attestation

GET

/v1/workspace/national-dnc

const url = 'https://api.vocapable.com/v1/workspace/national-dnc';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.vocapable.com/v1/workspace/national-dnc \
  --header 'Authorization: Bearer <token>'

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

WorkspaceNationalDncSetup

PRD E13-R3: the owner’s National Do Not Call setup - the SAN the company screens its marketing lists under (upstream, on its own side: adr/0018), and the attestation on record. Vocapable keeps both on file and shows them on every consent ledger; it never checks a number against the registry, and nothing here says it does.

object

san

required

Any of:

WorkspaceSanSubscription
null

WorkspaceSanSubscription

The company’s own National Do Not Call Registry subscription (its SAN), on file.

object

account_hint

required

Account Hint

string

area_codes

required

Area Codes

Array<string>

status

required

Status

string

effective_at

required

Effective At

string format: date-time

expires_at

required

Any of:

string
null

string format: date-time

attested

required

Attested

boolean

attested_by

required

Any of:

string
null

string

attested_at

required

Any of:

string
null

string format: date-time

can_edit

required

Can Edit

boolean

registry_url

Registry Url

string

default: https://telemarketing.donotcall.gov

guidance

required

Guidance

string

Example

{
  "registry_url": "https://telemarketing.donotcall.gov"
}