V2: creates wallet if needed, then generates address for the given network and reference.
POST
/
api
/
v2
/
addresses
/
generate
Generate wallet if not exists and create address (v2)
curl --request POST \
--url https://sandbox.oumla.com/api/v2/addresses/generate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-sdk-version: <x-sdk-version>' \
--data '
{
"reference": "user",
"networkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"clientShare": "c2hhcmUtZGF0YS1iYXNlNjQ="
}
'import requests
url = "https://sandbox.oumla.com/api/v2/addresses/generate"
payload = {
"reference": "user",
"networkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"clientShare": "c2hhcmUtZGF0YS1iYXNlNjQ="
}
headers = {
"x-sdk-version": "<x-sdk-version>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-sdk-version': '<x-sdk-version>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reference: 'user',
networkId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
clientShare: 'c2hhcmUtZGF0YS1iYXNlNjQ='
})
};
fetch('https://sandbox.oumla.com/api/v2/addresses/generate', 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://sandbox.oumla.com/api/v2/addresses/generate",
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([
'reference' => 'user',
'networkId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'clientShare' => 'c2hhcmUtZGF0YS1iYXNlNjQ='
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-sdk-version: <x-sdk-version>"
],
]);
$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://sandbox.oumla.com/api/v2/addresses/generate"
payload := strings.NewReader("{\n \"reference\": \"user\",\n \"networkId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"clientShare\": \"c2hhcmUtZGF0YS1iYXNlNjQ=\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-sdk-version", "<x-sdk-version>")
req.Header.Add("x-api-key", "<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://sandbox.oumla.com/api/v2/addresses/generate")
.header("x-sdk-version", "<x-sdk-version>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"user\",\n \"networkId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"clientShare\": \"c2hhcmUtZGF0YS1iYXNlNjQ=\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.oumla.com/api/v2/addresses/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-sdk-version"] = '<x-sdk-version>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"user\",\n \"networkId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"clientShare\": \"c2hhcmUtZGF0YS1iYXNlNjQ=\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"address": "<string>"
},
"message": "<string>"
}{
"code": "ERR_010",
"message": "The request could not be processed.",
"category": "VALIDATION",
"statusCode": 400,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}{
"code": "ERR_008",
"message": "You need to sign in to continue.",
"category": "AUTHORIZATION",
"statusCode": 401,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}{
"code": "ERR_009",
"message": "You don't have permission to do that.",
"category": "AUTHORIZATION",
"statusCode": 403,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}{
"code": "ERR_013",
"message": "Organization not found.",
"category": "RESOURCE",
"statusCode": 404,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}{
"code": "ERR_019",
"message": "Something went wrong on our side.",
"category": "SYSTEM",
"statusCode": 500,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}Authorizations
API key for authentication
Headers
SDK version header
Body
application/json
Profile reference that owns the address
Example:
"user"
UUID of the network to generate the address on
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Client share for key derivation. Must be non-empty.
Example:
"c2hhcmUtZGF0YS1iYXNlNjQ="
Was this page helpful?
Previous
List addresses for organizationList addresses for the authenticated user's organization with pagination.
Next
⌘I
Generate wallet if not exists and create address (v2)
curl --request POST \
--url https://sandbox.oumla.com/api/v2/addresses/generate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-sdk-version: <x-sdk-version>' \
--data '
{
"reference": "user",
"networkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"clientShare": "c2hhcmUtZGF0YS1iYXNlNjQ="
}
'import requests
url = "https://sandbox.oumla.com/api/v2/addresses/generate"
payload = {
"reference": "user",
"networkId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"clientShare": "c2hhcmUtZGF0YS1iYXNlNjQ="
}
headers = {
"x-sdk-version": "<x-sdk-version>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-sdk-version': '<x-sdk-version>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
reference: 'user',
networkId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
clientShare: 'c2hhcmUtZGF0YS1iYXNlNjQ='
})
};
fetch('https://sandbox.oumla.com/api/v2/addresses/generate', 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://sandbox.oumla.com/api/v2/addresses/generate",
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([
'reference' => 'user',
'networkId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
'clientShare' => 'c2hhcmUtZGF0YS1iYXNlNjQ='
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-sdk-version: <x-sdk-version>"
],
]);
$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://sandbox.oumla.com/api/v2/addresses/generate"
payload := strings.NewReader("{\n \"reference\": \"user\",\n \"networkId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"clientShare\": \"c2hhcmUtZGF0YS1iYXNlNjQ=\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-sdk-version", "<x-sdk-version>")
req.Header.Add("x-api-key", "<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://sandbox.oumla.com/api/v2/addresses/generate")
.header("x-sdk-version", "<x-sdk-version>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reference\": \"user\",\n \"networkId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"clientShare\": \"c2hhcmUtZGF0YS1iYXNlNjQ=\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.oumla.com/api/v2/addresses/generate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-sdk-version"] = '<x-sdk-version>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reference\": \"user\",\n \"networkId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"clientShare\": \"c2hhcmUtZGF0YS1iYXNlNjQ=\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"address": "<string>"
},
"message": "<string>"
}{
"code": "ERR_010",
"message": "The request could not be processed.",
"category": "VALIDATION",
"statusCode": 400,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}{
"code": "ERR_008",
"message": "You need to sign in to continue.",
"category": "AUTHORIZATION",
"statusCode": 401,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}{
"code": "ERR_009",
"message": "You don't have permission to do that.",
"category": "AUTHORIZATION",
"statusCode": 403,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}{
"code": "ERR_013",
"message": "Organization not found.",
"category": "RESOURCE",
"statusCode": 404,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}{
"code": "ERR_019",
"message": "Something went wrong on our side.",
"category": "SYSTEM",
"statusCode": 500,
"path": "/api/v1/example",
"timestamp": "2025-02-20T12:00:00.000Z",
"requestId": "req-example-id"
}