Skip to content
vocapable.Docs

Read a registration's review status now

POST
/v1/workspace/voice-trust/{kind}/check
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/voice-trust/example/check \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
kind
required
Kind
string

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