Creating a Merchant Account
curl --request POST \
--url https://api.hel.io/v1/auth/external/sign-up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"user": {
"email": "<string>",
"name": "<string>",
"discordUsername": "<string>",
"twitterUsername": "<string>"
},
"company": {
"kycVerified": true,
"name": "<string>",
"email": "<string>",
"websiteUrl": "<string>",
"discordUsername": "<string>",
"address": "<string>",
"phoneNumber": "<string>"
},
"wallets": [
{
"name": "<string>",
"address": "<string>"
}
]
}
'import requests
url = "https://api.hel.io/v1/auth/external/sign-up"
payload = {
"id": "<string>",
"user": {
"email": "<string>",
"name": "<string>",
"discordUsername": "<string>",
"twitterUsername": "<string>"
},
"company": {
"kycVerified": True,
"name": "<string>",
"email": "<string>",
"websiteUrl": "<string>",
"discordUsername": "<string>",
"address": "<string>",
"phoneNumber": "<string>"
},
"wallets": [
{
"name": "<string>",
"address": "<string>"
}
]
}
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({
id: '<string>',
user: {
email: '<string>',
name: '<string>',
discordUsername: '<string>',
twitterUsername: '<string>'
},
company: {
kycVerified: true,
name: '<string>',
email: '<string>',
websiteUrl: '<string>',
discordUsername: '<string>',
address: '<string>',
phoneNumber: '<string>'
},
wallets: [{name: '<string>', address: '<string>'}]
})
};
fetch('https://api.hel.io/v1/auth/external/sign-up', 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.hel.io/v1/auth/external/sign-up",
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([
'id' => '<string>',
'user' => [
'email' => '<string>',
'name' => '<string>',
'discordUsername' => '<string>',
'twitterUsername' => '<string>'
],
'company' => [
'kycVerified' => true,
'name' => '<string>',
'email' => '<string>',
'websiteUrl' => '<string>',
'discordUsername' => '<string>',
'address' => '<string>',
'phoneNumber' => '<string>'
],
'wallets' => [
[
'name' => '<string>',
'address' => '<string>'
]
]
]),
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.hel.io/v1/auth/external/sign-up"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"user\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"twitterUsername\": \"<string>\"\n },\n \"company\": {\n \"kycVerified\": true,\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"address\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"wallets\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n ]\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.hel.io/v1/auth/external/sign-up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"user\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"twitterUsername\": \"<string>\"\n },\n \"company\": {\n \"kycVerified\": true,\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"address\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"wallets\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/auth/external/sign-up")
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 \"id\": \"<string>\",\n \"user\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"twitterUsername\": \"<string>\"\n },\n \"company\": {\n \"kycVerified\": true,\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"address\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"wallets\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"user": {
"id": "681297e9b510d96df0eb6406",
"email": "user@test.com",
"userType": null,
"name": "Test",
"payoutWallets": [
{
"id": "681297e9b510d96df0eb6412",
"publicKey": "DsUFWNpve7hVQdhWDAfUTGq78SpZZ3tVLdnJiRa54QBU",
"name": "Test Wallet"
}
],
"discordUsername": "test-discord-username"
},
"company": {
"id": "681297e9b510d96df0eb6408",
"name": "Company",
"email": "company@test.com",
"websiteUrl": "https://test.com",
"discordUsername": "test-discord-username",
"phoneNumber": "+1234567890",
"kycVerified": true,
"address": "1 Market St, San Francisco, CA",
"kybVerified": true
},
"redirectUrl": "https://app.hel.io/auth/external-login?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4MTI5N2U5YjUxMGQ5NmRmMGViNjQwNiIsImlhdCI6MTc0NjA0OTAwMSwiZXhwIjoxNzQ2MDQ5MTIxfQ.C62U9M6g9OE3_f_XbhpU9PDtBigp7Do4mYtDnfileD4"
}{
"message": "Api key or token is invalid",
"code": 401
}PLATFORM
Creating a Merchant Account
Create a new Helio merchant account using an external authentication method.
POST
/
v1
/
auth
/
external
/
sign-up
Creating a Merchant Account
curl --request POST \
--url https://api.hel.io/v1/auth/external/sign-up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"user": {
"email": "<string>",
"name": "<string>",
"discordUsername": "<string>",
"twitterUsername": "<string>"
},
"company": {
"kycVerified": true,
"name": "<string>",
"email": "<string>",
"websiteUrl": "<string>",
"discordUsername": "<string>",
"address": "<string>",
"phoneNumber": "<string>"
},
"wallets": [
{
"name": "<string>",
"address": "<string>"
}
]
}
'import requests
url = "https://api.hel.io/v1/auth/external/sign-up"
payload = {
"id": "<string>",
"user": {
"email": "<string>",
"name": "<string>",
"discordUsername": "<string>",
"twitterUsername": "<string>"
},
"company": {
"kycVerified": True,
"name": "<string>",
"email": "<string>",
"websiteUrl": "<string>",
"discordUsername": "<string>",
"address": "<string>",
"phoneNumber": "<string>"
},
"wallets": [
{
"name": "<string>",
"address": "<string>"
}
]
}
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({
id: '<string>',
user: {
email: '<string>',
name: '<string>',
discordUsername: '<string>',
twitterUsername: '<string>'
},
company: {
kycVerified: true,
name: '<string>',
email: '<string>',
websiteUrl: '<string>',
discordUsername: '<string>',
address: '<string>',
phoneNumber: '<string>'
},
wallets: [{name: '<string>', address: '<string>'}]
})
};
fetch('https://api.hel.io/v1/auth/external/sign-up', 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.hel.io/v1/auth/external/sign-up",
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([
'id' => '<string>',
'user' => [
'email' => '<string>',
'name' => '<string>',
'discordUsername' => '<string>',
'twitterUsername' => '<string>'
],
'company' => [
'kycVerified' => true,
'name' => '<string>',
'email' => '<string>',
'websiteUrl' => '<string>',
'discordUsername' => '<string>',
'address' => '<string>',
'phoneNumber' => '<string>'
],
'wallets' => [
[
'name' => '<string>',
'address' => '<string>'
]
]
]),
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.hel.io/v1/auth/external/sign-up"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"user\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"twitterUsername\": \"<string>\"\n },\n \"company\": {\n \"kycVerified\": true,\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"address\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"wallets\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n ]\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.hel.io/v1/auth/external/sign-up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"user\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"twitterUsername\": \"<string>\"\n },\n \"company\": {\n \"kycVerified\": true,\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"address\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"wallets\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hel.io/v1/auth/external/sign-up")
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 \"id\": \"<string>\",\n \"user\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"twitterUsername\": \"<string>\"\n },\n \"company\": {\n \"kycVerified\": true,\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"discordUsername\": \"<string>\",\n \"address\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"wallets\": [\n {\n \"name\": \"<string>\",\n \"address\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"user": {
"id": "681297e9b510d96df0eb6406",
"email": "user@test.com",
"userType": null,
"name": "Test",
"payoutWallets": [
{
"id": "681297e9b510d96df0eb6412",
"publicKey": "DsUFWNpve7hVQdhWDAfUTGq78SpZZ3tVLdnJiRa54QBU",
"name": "Test Wallet"
}
],
"discordUsername": "test-discord-username"
},
"company": {
"id": "681297e9b510d96df0eb6408",
"name": "Company",
"email": "company@test.com",
"websiteUrl": "https://test.com",
"discordUsername": "test-discord-username",
"phoneNumber": "+1234567890",
"kycVerified": true,
"address": "1 Market St, San Francisco, CA",
"kybVerified": true
},
"redirectUrl": "https://app.hel.io/auth/external-login?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4MTI5N2U5YjUxMGQ5NmRmMGViNjQwNiIsImlhdCI6MTc0NjA0OTAwMSwiZXhwIjoxNzQ2MDQ5MTIxfQ.C62U9M6g9OE3_f_XbhpU9PDtBigp7Do4mYtDnfileD4"
}{
"message": "Api key or token is invalid",
"code": 401
}Note: When using the production environment at moonpay.hel.io, set your API endpoint to
api.hel.io/v1 and generate API keys there. For the development environment, use api.dev.hel.io/v1 and generate API keys from moonpay.dev.hel.io.Authorizations
Authentication using JWT token
Query Parameters
Contact the Helio team directly to obtain API keys.
Body
application/json
Merchant-generated unique identifier used as a stable external reference for the account.
Details about the individual user signing up.
Show child attributes
Show child attributes
Details about the company associated with the sign-up.
Show child attributes
Show child attributes
List of user wallets to associate with the sign-up request.
Show child attributes
Show child attributes
Response
Returns user and company details along with a redirect URL.
Merchant account details returned after a successful external sign-up or sign-in.