Skip to main content
POST
/
sdk
/
{environmentId}
/
stepUp
/
check
Check if step-up authentication is required for a given scope
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/stepUp/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": "credential:link"
}
'
{
  "isRequired": true,
  "credentials": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "format": "blockchain",
      "type": "<string>",
      "alias": "<string>"
    }
  ],
  "defaultCredentialId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json
​
scope
enum<string>
required

Valid scopes for an elevated access token

Available options:
credential:link,
credential:update,
credential:unlink,
user:update,
user:delete,
wallet:export,
wallet:delete,
wallet:delegate,
wallet:sign,
wallet:restore

Response

Step-up check result

​
isRequired
boolean
required

Whether step-up authentication is required for the given scope

​
credentials
object[]
required

The credentials available for step-up authentication. Empty if isRequired is false.

​
defaultCredentialId
string<uuid>

The recommended default credential to use for step-up. For reauth this is the sign-in credential; for MFA this is the default or most recently added device.