Submit Onboarding Step Route

curl --request POST \
  --url https://api.sumvin.com/v0/user/me/onboarding/steps \
  --header 'Content-Type: application/json' \
  --header 'x-juno-jwt: <api-key>' \
  --data '
{
  "step": "phone_verification"
}
'

import requests

url = "https://api.sumvin.com/v0/user/me/onboarding/steps"

payload = { "step": "phone_verification" }
headers = {
    "x-juno-jwt": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-juno-jwt': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({step: 'phone_verification'})
};

fetch('https://api.sumvin.com/v0/user/me/onboarding/steps', 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.sumvin.com/v0/user/me/onboarding/steps",
  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' => 'phone_verification'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juno-jwt: <api-key>"
  ],
]);

$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.sumvin.com/v0/user/me/onboarding/steps"

	payload := strings.NewReader("{\n  \"step\": \"phone_verification\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-juno-jwt", "<api-key>")
	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.sumvin.com/v0/user/me/onboarding/steps")
  .header("x-juno-jwt", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"step\": \"phone_verification\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sumvin.com/v0/user/me/onboarding/steps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-juno-jwt"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"step\": \"phone_verification\"\n}"

response = http.request(request)
puts response.read_body

{
  "_links": {
    "self": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "wallets": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "kyc-status": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "kyc-token": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    }
  },
  "onboarding": {
    "steps": [
      {
        "gated": false,
        "meta": {}
      }
    ],
    "is_complete": true,
    "safe_creation_status": "<string>",
    "primary_smart_wallet_address": "<string>",
    "did_mint_status": "<string>",
    "did_token_id": "<string>"
  }
}

{
  "_links": {
    "self": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "wallets": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "kyc-status": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "kyc-token": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    }
  },
  "onboarding": {
    "steps": [
      {
        "gated": false,
        "meta": {}
      }
    ],
    "is_complete": true,
    "safe_creation_status": "<string>",
    "primary_smart_wallet_address": "<string>",
    "did_mint_status": "<string>",
    "did_token_id": "<string>"
  }
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

User

Submit Onboarding Step Route

Submit the user’s current onboarding step. The body’s step must match a step the user has not yet passed; submitting a step that is still ahead of them returns 409 Conflict with the user’s current step in the response so the client can self-correct. Resubmitting a step the user has already finished is an idempotent no-op that returns the current state. Returns 200 OK when the transition is fully synchronous. Returns 202 Accepted when the transition enqueues background provisioning work (Safe creation and agent-key minting on the creation path). On 202, a Retry-After response header indicates how many seconds to wait before the next poll of GET /v0/user/me/onboarding/steps.

POST

user

onboarding

steps

Submit Onboarding Step Route

curl --request POST \
  --url https://api.sumvin.com/v0/user/me/onboarding/steps \
  --header 'Content-Type: application/json' \
  --header 'x-juno-jwt: <api-key>' \
  --data '
{
  "step": "phone_verification"
}
'

import requests

url = "https://api.sumvin.com/v0/user/me/onboarding/steps"

payload = { "step": "phone_verification" }
headers = {
    "x-juno-jwt": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-juno-jwt': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({step: 'phone_verification'})
};

fetch('https://api.sumvin.com/v0/user/me/onboarding/steps', 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.sumvin.com/v0/user/me/onboarding/steps",
  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' => 'phone_verification'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-juno-jwt: <api-key>"
  ],
]);

$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.sumvin.com/v0/user/me/onboarding/steps"

	payload := strings.NewReader("{\n  \"step\": \"phone_verification\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-juno-jwt", "<api-key>")
	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.sumvin.com/v0/user/me/onboarding/steps")
  .header("x-juno-jwt", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"step\": \"phone_verification\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sumvin.com/v0/user/me/onboarding/steps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-juno-jwt"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"step\": \"phone_verification\"\n}"

response = http.request(request)
puts response.read_body

{
  "_links": {
    "self": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "wallets": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "kyc-status": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "kyc-token": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    }
  },
  "onboarding": {
    "steps": [
      {
        "gated": false,
        "meta": {}
      }
    ],
    "is_complete": true,
    "safe_creation_status": "<string>",
    "primary_smart_wallet_address": "<string>",
    "did_mint_status": "<string>",
    "did_token_id": "<string>"
  }
}

{
  "_links": {
    "self": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "wallets": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "kyc-status": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "kyc-token": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    }
  },
  "onboarding": {
    "steps": [
      {
        "gated": false,
        "meta": {}
      }
    ],
    "is_complete": true,
    "safe_creation_status": "<string>",
    "primary_smart_wallet_address": "<string>",
    "did_mint_status": "<string>",
    "did_token_id": "<string>"
  }
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "No wallet found with ID 12345 for this user.",
  "error_code": "WAL-404-001",
  "instance": "/v0/wallets/12345",
  "status": 404,
  "title": "Wallet Not Found",
  "trace_id": "abc123-def456-ghi789",
  "type": "https://api.sumvin.com/errors/wal-404-001"
}

Authorizations

x-juno-jwt

string

header

required

JWT issued by Dynamic Labs or Privy. Sent in the x-juno-jwt header on every authenticated request.

Headers

x-sumvin-token

string | null

x-sumvin-pat

string | null

x-juno-jwt

string | null

x-juno-orgid

string | null

Tenant org ID for multi-tenant auth

X-Timestamp-Format

string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Body

application/json

step

enum<string>

required

The onboarding step being submitted. Must match the user's current step.

Available options:

created,

phone_verification,

kyc_verification,

byo_safe,

safe_deploy,

open_banking,

card_setup,

feature_selection,

complete

Example:

"phone_verification"

Response

Step submitted; state updated synchronously.

_links

UserLinks · object

required

HAL-style hypermedia links for navigation.

Show child attributes

onboarding

OnboardingData · object

required

Computed onboarding state.

Show child attributes

⌘I

Introduction

Quickstarts

Guides

Product Guides

API Reference

Submit Onboarding Step Route

Authorizations

Headers

Body

Response