Skip to content
vocapable.Docs

Submit (or resume) SHAKEN/STIR, CNAM or Voice Integrity

POST
/v1/workspace/voice-trust/{kind}
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/voice-trust/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "line_ids": [ "example" ], "contact_email": "example", "display_name": "example", "use_case": "example", "employee_count": 1, "daily_call_volume": 1, "accept_terms": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
kind
required
Kind
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
<= 255 characters

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape. Required on this endpoint: a retry without one would dial a human twice or spend money twice.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceTrustSubmit

Start (or resume) one voice trust registration.

object
line_ids
Line Ids
Array<string>
<= 200 items
contact_email
required
Contact Email
string
>= 3 characters <= 254 characters
display_name
Any of:
string
<= 15 characters
use_case
Any of:
string
<= 60 characters
employee_count
Any of:
integer
>= 1 <= 1000000
daily_call_volume
Any of:
integer
>= 1 <= 10000000
accept_terms
required
Accept Terms
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
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
line_ids
required
Line Ids
Array<string>
failure_reasons
required
Failure Reasons
Array<string>
twilio_status
required
Any of:
string
submitted_at
required
Any of:
string format: date-time
last_checked_at
required
Any of:
string format: date-time
Example
{
  "kind": "shaken_stir",
  "stage": "draft"
}

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": {}
    }
  ]
}