Skip to content

Begin Mobile Step Up

POST
/v1/mobile/step-up/requests
curl --request POST \
--url https://api.vocapable.com/v1/mobile/step-up/requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "action": "schedule_update", "target": "example", "payload_hash": "example", "callback_uri": "example" }'

Start one browser confirmation for one canonical mobile mutation payload.

Media typeapplication/json
MobileStepUpBeginRequest

A native app starts a proof for exactly one high-impact command.

object
action
required
Action
string
Allowed values: schedule_update emergency_override_set emergency_override_clear team_member_update team_invitation_create team_invitation_revoke transfer_destination_confirm device_revoke call_ai_start billing_budget_update billing_portal_launch receptionist_studio_update
target
required
Target
string
>= 1 characters <= 160 characters
payload_hash
required
Payload Hash
string
>= 64 characters <= 64 characters
callback_uri
required
Callback Uri
string
>= 8 characters <= 2048 characters

Successful Response

Media typeapplication/json
MobileStepUpBeginResponse
object
request_id
required
Request Id
string
portal_url
required
Portal Url
string
expires_at
required
Expires At
string format: date-time
Examplegenerated
{
"request_id": "example",
"portal_url": "example",
"expires_at": "2026-04-15T12:00:00Z"
}

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