POST
/
v1
/
auth
/
register
Register
curl --request POST \
  --url https://api.next.orenda.finance/v1/auth/register \
  --header 'Content-Type: application/json' \
  --header 'x-program-id: <x-program-id>' \
  --data '
{
  "email": "ada.lovelace@example.com",
  "password": "S3cur3-P@ssw0rd!"
}
'
import requests

url = "https://api.next.orenda.finance/v1/auth/register"

payload = {
"email": "ada.lovelace@example.com",
"password": "S3cur3-P@ssw0rd!"
}
headers = {
"x-program-id": "<x-program-id>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'x-program-id': '<x-program-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'ada.lovelace@example.com', password: 'S3cur3-P@ssw0rd!'})
};

fetch('https://api.next.orenda.finance/v1/auth/register', 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.next.orenda.finance/v1/auth/register",
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([
'email' => 'ada.lovelace@example.com',
'password' => 'S3cur3-P@ssw0rd!'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-program-id: <x-program-id>"
],
]);

$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.next.orenda.finance/v1/auth/register"

payload := strings.NewReader("{\n \"email\": \"ada.lovelace@example.com\",\n \"password\": \"S3cur3-P@ssw0rd!\"\n}")

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

req.Header.Add("x-program-id", "<x-program-id>")
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.next.orenda.finance/v1/auth/register")
.header("x-program-id", "<x-program-id>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"ada.lovelace@example.com\",\n \"password\": \"S3cur3-P@ssw0rd!\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.next.orenda.finance/v1/auth/register")

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

request = Net::HTTP::Post.new(url)
request["x-program-id"] = '<x-program-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"ada.lovelace@example.com\",\n \"password\": \"S3cur3-P@ssw0rd!\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "message": "Confirmation code sent to email"
  }
}
{
"success": false,
"code": "INVALID_PASSWORD",
"message": "Password does not meet requirements"
}
{
"success": false,
"code": "USER_ALREADY_EXISTS",
"message": "An account with this email already exists"
}
{
"success": false,
"code": "VALIDATION_ERROR",
"message": "email is required"
}
{
"success": false,
"code": "USER_LOCKED",
"message": "Too many failed attempts"
}
{
"success": false,
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal Server Error"
}
Send the user’s email and password. We create the account and email them a confirmation code. Confirm it next with Confirm sign-up. For a brand-new user, confirming logs them in and returns a SECURITY_SETUP_REQUIRED challenge, so they set up a passkey or 2FA before they have a usable session.

Headers

x-program-id
string
required

Identifies the program. Can also be sent as the programId query parameter.

x-sandbox
boolean

Set to true to use the sandbox environment. Defaults to false.

Body

application/json
email
string<email>
required
password
string
required

Must meet the password policy.

Minimum string length: 8

Response

A simple confirmation message

success
boolean
Example:

true

data
object