Verify approval OTP

POST

/api/approval-artifacts/{artifactId}/otp/verify

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/approval-artifacts/example/otp/verify \
  --header 'Content-Type: application/json' \
  --data '{ "code": "123456" }'

Verify an approval OTP code and return a method-bound completion assertion.

Parameters

Path Parameters

artifactId

required

string

Request Body ^required

Verify an OTP code for an approval artifact.

Media type application/json

object

code

required

string

Example

{
  "code": "123456"
}

Responses

200

Approval completion assertion produced by a step-up method.

Media type application/json

object

completion_assertion

required

object

method

string

actor_subject_type

string

actor_subject_id

string

verified_at

integer format: int64

metadata

object

key

additional properties

Example

{
  "completion_assertion": {
    "method": "passkey",
    "actor_subject_type": "admin_user",
    "actor_subject_id": "admin_123",
    "verified_at": 1770000000000,
    "metadata": {
      "source": "admin_passkey",
      "credential_id": "credential_123"
    }
  }
}

default

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"
}