Attestation per line; SHAKEN/STIR, CNAM, branding status

GET

/v1/workspace/voice-trust

const url = 'https://api.vocapable.com/v1/workspace/voice-trust';
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/voice-trust \
  --header 'Authorization: Bearer <token>'

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

WorkspaceVoiceTrust

object

business_profile

required

Business Profile

string

Allowed values: approved missing unknown

business_profile_guidance

required

Any of:

string
null

string

registrations

required

Registrations

Array<object>

WorkspaceTrustRegistration

object

kind

required

Kind

string

Allowed values: shaken_stir cnam branded_calling voice_integrity

stage

required

Stage

string

Allowed values: draft submitting in_review approved rejected

display_name

required

Any of:

string
null

string

line_ids

required

Line Ids

Array<string>

failure_reasons

required

Failure Reasons

Array<string>

twilio_status

required

Any of:

string
null

string

submitted_at

required

Any of:

string
null

string format: date-time

last_checked_at

required

Any of:

string
null

string format: date-time

lines

required

Lines

Array<object>

WorkspaceLineAttestation

object

line_id

required

Line Id

string

phone_e164

required

Phone E164

string

name

required

Name

string

kind

required

Kind

string

Allowed values: number verified_caller_id

expected

required

Expected

string

Allowed values: A B C

best_possible

required

Best Possible

string

Allowed values: A B C

reason

required

Reason

string

next_step

required

Any of:

string
null

string

cnam

required

Any of:

string
null

string

Allowed values: draft submitting in_review approved rejected

branded_calling

required

Any of:

string
null

string

Allowed values: draft submitting in_review approved rejected

can_manage

required

Can Manage

boolean

lock_notice

Lock Notice

string

Example

{
  "business_profile": "approved",
  "registrations": [
    {
      "kind": "shaken_stir",
      "stage": "draft"
    }
  ],
  "lines": [
    {
      "kind": "number",
      "expected": "A",
      "best_possible": "A",
      "cnam": "draft",
      "branded_calling": "draft"
    }
  ],
  "lock_notice": ""
}