Check the code a customer typed and start a session the project's server holds

post/customer-accounts/auth/verify

Check the code a customer typed and start a session the project's server holds: an access token (minutes) and a refresh token. Every wrong code gets the same answer.

Before you call

Credential: Authorization: Bearer $KEY
Scope: contacts:write
Sdk: contacts.customerAuth.verify
Cli: contacts customer auth verify

Request bodyapplication/json, required

projectstring
At most 80 characters.
emailstring (email)required
At most 254 characters.
codestringrequired
Pattern: ^\d{8}$.
ipstring
At most 64 characters.
userAgentstring
At most 200 characters.

Responses

200application/json
Success
object
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/customer-accounts/auth/verify' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "name@example.com",
  "code": "string"
}'

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

This page as Markdown