Step-Up Config API
Create step-up config
Create a step-up authentication configuration for the application.
POST
/
v2
/
session
/
apps
/
{appID}
/
config
/
stepup
Create step-up config
curl --request POST \
--url https://api.prelude.dev/v2/session/apps/{appID}/config/stepup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step_keys": [
{
"key": "high_value_transaction",
"description": "Triggered for transactions above $10,000"
}
],
"allowed_scopes": [
{
"scope": "transfer"
}
],
"jwks_url": "https://api.example.com/.well-known/jwks.json"
}
'import requests
url = "https://api.prelude.dev/v2/session/apps/{appID}/config/stepup"
payload = {
"step_keys": [
{
"key": "high_value_transaction",
"description": "Triggered for transactions above $10,000"
}
],
"allowed_scopes": [{ "scope": "transfer" }],
"jwks_url": "https://api.example.com/.well-known/jwks.json"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
step_keys: [
{
key: 'high_value_transaction',
description: 'Triggered for transactions above $10,000'
}
],
allowed_scopes: [{scope: 'transfer'}],
jwks_url: 'https://api.example.com/.well-known/jwks.json'
})
};
fetch('https://api.prelude.dev/v2/session/apps/{appID}/config/stepup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prelude.dev/v2/session/apps/{appID}/config/stepup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'step_keys' => [
[
'key' => 'high_value_transaction',
'description' => 'Triggered for transactions above $10,000'
]
],
'allowed_scopes' => [
[
'scope' => 'transfer'
]
],
'jwks_url' => 'https://api.example.com/.well-known/jwks.json'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.prelude.dev/v2/session/apps/{appID}/config/stepup"
payload := strings.NewReader("{\n \"step_keys\": [\n {\n \"key\": \"high_value_transaction\",\n \"description\": \"Triggered for transactions above $10,000\"\n }\n ],\n \"allowed_scopes\": [\n {\n \"scope\": \"transfer\"\n }\n ],\n \"jwks_url\": \"https://api.example.com/.well-known/jwks.json\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.prelude.dev/v2/session/apps/{appID}/config/stepup")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step_keys\": [\n {\n \"key\": \"high_value_transaction\",\n \"description\": \"Triggered for transactions above $10,000\"\n }\n ],\n \"allowed_scopes\": [\n {\n \"scope\": \"transfer\"\n }\n ],\n \"jwks_url\": \"https://api.example.com/.well-known/jwks.json\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prelude.dev/v2/session/apps/{appID}/config/stepup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"step_keys\": [\n {\n \"key\": \"high_value_transaction\",\n \"description\": \"Triggered for transactions above $10,000\"\n }\n ],\n \"allowed_scopes\": [\n {\n \"scope\": \"transfer\"\n }\n ],\n \"jwks_url\": \"https://api.example.com/.well-known/jwks.json\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"jwks_url": "https://api.example.com/.well-known/jwks.json",
"step_keys": [
{
"key": "high_value_transaction",
"description": "Triggered for transactions above $10,000"
}
],
"allowed_scopes": [
{
"scope": "transfer",
"mode": "delegated",
"delegated": {
"delegation_hook": "https://api.example.com/stepup/signal"
},
"direct": {
"identifier_types": [
"email_address"
],
"status": "continue",
"granted_for": 3600,
"grant_mode": "single-use",
"steps": [
{
"order": 1,
"key": "verify_sms",
"expiration_duration": 600
}
]
}
}
],
"created_at": "2025-03-15T10:30:00Z",
"updated_at": "2025-03-15T12:00:00Z"
}
}{
"code": "invalid_request",
"status": "bad_request",
"message": "The request body is invalid."
}{
"code": "app_not_found",
"status": "not_found",
"message": "The application was not found."
}{
"code": "step_up_config_already_exists",
"status": "conflict",
"message": "A step-up configuration already exists for this application."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The id of the app the request refers to. An application's unique identifier.
Examples:
"54e9ujn"
"fvua38g"
Body
application/json
Show child attributes
Show child attributes
Per-scope step-up configuration. Each entry is either delegated
to a delegation hook on your backend, resolved directly by
Prelude using a static decision, or routed to a preformatted
Prelude-managed flow (prld:phone:register,
prld:email:register).
Show child attributes
Show child attributes
HTTPS endpoint exposing the JWKS used to verify tokens issued
by your backend for custom steps. Required when at least one
entry in allowed_scopes uses the delegated mode.
Example:
"https://api.example.com/.well-known/jwks.json"
Response
Created
Show child attributes
Show child attributes
⌘I
Create step-up config
curl --request POST \
--url https://api.prelude.dev/v2/session/apps/{appID}/config/stepup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step_keys": [
{
"key": "high_value_transaction",
"description": "Triggered for transactions above $10,000"
}
],
"allowed_scopes": [
{
"scope": "transfer"
}
],
"jwks_url": "https://api.example.com/.well-known/jwks.json"
}
'import requests
url = "https://api.prelude.dev/v2/session/apps/{appID}/config/stepup"
payload = {
"step_keys": [
{
"key": "high_value_transaction",
"description": "Triggered for transactions above $10,000"
}
],
"allowed_scopes": [{ "scope": "transfer" }],
"jwks_url": "https://api.example.com/.well-known/jwks.json"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
step_keys: [
{
key: 'high_value_transaction',
description: 'Triggered for transactions above $10,000'
}
],
allowed_scopes: [{scope: 'transfer'}],
jwks_url: 'https://api.example.com/.well-known/jwks.json'
})
};
fetch('https://api.prelude.dev/v2/session/apps/{appID}/config/stepup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prelude.dev/v2/session/apps/{appID}/config/stepup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'step_keys' => [
[
'key' => 'high_value_transaction',
'description' => 'Triggered for transactions above $10,000'
]
],
'allowed_scopes' => [
[
'scope' => 'transfer'
]
],
'jwks_url' => 'https://api.example.com/.well-known/jwks.json'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.prelude.dev/v2/session/apps/{appID}/config/stepup"
payload := strings.NewReader("{\n \"step_keys\": [\n {\n \"key\": \"high_value_transaction\",\n \"description\": \"Triggered for transactions above $10,000\"\n }\n ],\n \"allowed_scopes\": [\n {\n \"scope\": \"transfer\"\n }\n ],\n \"jwks_url\": \"https://api.example.com/.well-known/jwks.json\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.prelude.dev/v2/session/apps/{appID}/config/stepup")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step_keys\": [\n {\n \"key\": \"high_value_transaction\",\n \"description\": \"Triggered for transactions above $10,000\"\n }\n ],\n \"allowed_scopes\": [\n {\n \"scope\": \"transfer\"\n }\n ],\n \"jwks_url\": \"https://api.example.com/.well-known/jwks.json\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prelude.dev/v2/session/apps/{appID}/config/stepup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"step_keys\": [\n {\n \"key\": \"high_value_transaction\",\n \"description\": \"Triggered for transactions above $10,000\"\n }\n ],\n \"allowed_scopes\": [\n {\n \"scope\": \"transfer\"\n }\n ],\n \"jwks_url\": \"https://api.example.com/.well-known/jwks.json\"\n}"
response = http.request(request)
puts response.read_body{
"config": {
"jwks_url": "https://api.example.com/.well-known/jwks.json",
"step_keys": [
{
"key": "high_value_transaction",
"description": "Triggered for transactions above $10,000"
}
],
"allowed_scopes": [
{
"scope": "transfer",
"mode": "delegated",
"delegated": {
"delegation_hook": "https://api.example.com/stepup/signal"
},
"direct": {
"identifier_types": [
"email_address"
],
"status": "continue",
"granted_for": 3600,
"grant_mode": "single-use",
"steps": [
{
"order": 1,
"key": "verify_sms",
"expiration_duration": 600
}
]
}
}
],
"created_at": "2025-03-15T10:30:00Z",
"updated_at": "2025-03-15T12:00:00Z"
}
}{
"code": "invalid_request",
"status": "bad_request",
"message": "The request body is invalid."
}{
"code": "app_not_found",
"status": "not_found",
"message": "The application was not found."
}{
"code": "step_up_config_already_exists",
"status": "conflict",
"message": "A step-up configuration already exists for this application."
}