Check the code a person typed, by destination or verification id

post/verify/services/{id}/check

Check the code a person typed, by destination or verification id. Answers valid and the status (pending, approved, expired or out of tries); a wrong code leaves the verification pending until the tries run out.

Before you call

Credential: Authorization: Bearer $KEY
Scope: voice:write
Mcp: rivier_verify_check
Graphql: Mutation.voiceVerifyCheckCreate
Sdk: verify.check
Cli: verify check

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

tostring
At most 320 characters.
verificationIdstring (uuid)
codestringrequired
At most 12 characters. Pattern: ^[A-Za-z0-9]+$.
ipstring
At most 64 characters.

Responses

200application/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

Example request

curl -X POST 'https://api.rivier.ai/verify/services/{id}/check' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "code": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown