Praecise Platform
Menu

Rivier/ Reference/ voice

Send a one-time code to a phone number or an email address

post/verify/services/{id}/verifications

Send a one-time code to a phone number or an email address. channel auto uses the service's order and falls back by itself when a channel fails. Rate limits, fraud guards, opt-outs and the plan's allowance are checked first; a refusal says which rule and what to do. The code itself is never returned (only in the mock, where nothing is sent).

Before you call

Credential
Authorization: Bearer $KEY
Scope
voice:write
Mcp
rivier_verify_start
Graphql
Mutation.voiceVerifyStartCreate
Sdk
verify.start
Cli
verify start

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • tostringrequired
    A phone number (E.164, or national with the service's default country) or an email address At most 320 characters.
  • channelstring or auto
    Default: auto.
  • localestring
    At most 10 characters.
  • customCodestring
    A code you made, when the service allows custom codes At most 10 characters. Pattern: ^[A-Za-z0-9]+$.
  • ipstring
    The caller's network address, for rate limits and fraud checks At most 64 characters.
  • userIdstring
    At most 120 characters.
  • deviceIdstring
    At most 120 characters.
  • tagsobject
  • amountstring
    At most 40 characters.
  • payeestring
    At most 120 characters.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown