Skip to content
Authrim

Verify an email code for a directory password migration fallback or recovery transaction and create a session.

POST
/api/auth/directory-password/migration/email-code/verify
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/auth/directory-password/migration/email-code/verify \
  --header 'Content-Type: application/json' \
  --data '{ "transaction_id": "damt_email_123", "transaction_token": "migration-email-token", "challenge_id": "challenge_123", "code": "123456" }'

Works only where the tenant allows email code for login (authentication-methods.email_otp.login_enabled, off unless turned on). This is decided first, before the transaction or the code is consumed and before any session is created: 403 access_denied (error_code AR050006) when it is off, 503 temporarily_unavailable when the tenant settings cannot be read.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
transaction_id
required
string
>= 1 characters
transaction_token
required
string
>= 1 characters
challenge_id
required
string
>= 1 characters
code
required
string
/^\d{6}$/
key
additional properties
Example 
{
  "transaction_id": "damt_email_123",
  "transaction_token": "migration-email-token",
  "challenge_id": "challenge_123",
  "code": "123456"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
One of:
object
ok
required
boolean
expires_in
required
integer
session
required
object
userId
string
createdAt
integer
expiresAt
integer
authTime
integer
acr
string
amr
Array<string>
key
additional properties
user
required
object
id
string
email
string format: email
name
Any of:
string
authorization
object
key
additional properties
redirect_url
string format: uri
Example 
{
  "ok": true,
  "expires_in": 86400,
  "session": {
    "userId": "user_123",
    "createdAt": 1770000000000,
    "expiresAt": 1770086400000,
    "authTime": 1770000000,
    "acr": "urn:mace:incommon:iap:bronze",
    "amr": [
      "pwd",
      "directory"
    ]
  },
  "user": {
    "id": "user_123",
    "email": "user@example.com",
    "name": "Example User"
  }
}

400

Section titled “400 ”

Successful response. The representation can be JSON, HTML, or a redirect.

401

Section titled “401 ”

Successful response. The representation can be JSON, HTML, or a redirect.

403

Section titled “403 ”

Successful response. The representation can be JSON, HTML, or a redirect.

503

Section titled “503 ”

Successful response. The representation can be JSON, HTML, or a redirect.