Skip to content
Authrim

Complete email code reauthentication.

POST
/api/account/reauth/email-code/complete
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/account/reauth/email-code/complete \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "challenge_id": "example", "code": "example" }'

Verifies a one-time email code for the current Account Page session and refreshes the session auth_time used by sensitive Account Page operations.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
challenge_id
required
string
code
required
string
/^[0-9]{6}$/
Example generated
{
  "challenge_id": "example",
  "code": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Account Page reauthentication completion response.

Media type application/json
object
ok
required
boolean
reauth
required
object
authenticated_at
required
integer
expires_at
required
integer
methods
required
Array<string>
Example generated
{
  "ok": true,
  "reauth": {
    "authenticated_at": 1,
    "expires_at": 1,
    "methods": [
      "example"
    ]
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

429

Section titled “429 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}