Create a sandbox account
curl --request POST \
--url https://api.farthing.ai/v1/signup \
--header 'Content-Type: application/json' \
--data '
{
"name": "Acme Agents",
"email": "you@example.com"
}
'import requests
url = "https://api.farthing.ai/v1/signup"
payload = {
"name": "Acme Agents",
"email": "you@example.com"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Acme Agents', email: 'you@example.com'})
};
fetch('https://api.farthing.ai/v1/signup', 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.farthing.ai/v1/signup",
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([
'name' => 'Acme Agents',
'email' => 'you@example.com'
]),
CURLOPT_HTTPHEADER => [
"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.farthing.ai/v1/signup"
payload := strings.NewReader("{\n \"name\": \"Acme Agents\",\n \"email\": \"you@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.farthing.ai/v1/signup")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Agents\",\n \"email\": \"you@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.farthing.ai/v1/signup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Agents\",\n \"email\": \"you@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"sandboxOnly": true,
"sandboxMerchants": [
"your-sandbox-store.myshopify.com"
],
"apiKey": "ck_test_3sQd7yQ0mHq9pP2rVwXk1tLb"
}{
"error": true,
"message": "<string>",
"issues": [
{
"code": "<string>",
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": true,
"message": "Self-serve signup is closed"
}{
"error": true,
"message": "Too many signups from this address. Try again later."
}Signup
Create a sandbox account
Creates a sandbox-only tenant and returns one ck_test_ key, shown exactly once.
A sandbox tenant runs the entire product — real browser, real storefront, real card entry, a genuinely placed order — but only against merchants Farthing controls. It cannot reach a real merchant and cannot mint a live key until the account is activated.
Unauthenticated, and rate limited on its own terms: 3 signups per hour per source IP, 200 per 24 hours platform-wide.
POST
/
v1
/
signup
Create a sandbox account
curl --request POST \
--url https://api.farthing.ai/v1/signup \
--header 'Content-Type: application/json' \
--data '
{
"name": "Acme Agents",
"email": "you@example.com"
}
'import requests
url = "https://api.farthing.ai/v1/signup"
payload = {
"name": "Acme Agents",
"email": "you@example.com"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Acme Agents', email: 'you@example.com'})
};
fetch('https://api.farthing.ai/v1/signup', 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.farthing.ai/v1/signup",
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([
'name' => 'Acme Agents',
'email' => 'you@example.com'
]),
CURLOPT_HTTPHEADER => [
"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.farthing.ai/v1/signup"
payload := strings.NewReader("{\n \"name\": \"Acme Agents\",\n \"email\": \"you@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.farthing.ai/v1/signup")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Acme Agents\",\n \"email\": \"you@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.farthing.ai/v1/signup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Acme Agents\",\n \"email\": \"you@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"sandboxOnly": true,
"sandboxMerchants": [
"your-sandbox-store.myshopify.com"
],
"apiKey": "ck_test_3sQd7yQ0mHq9pP2rVwXk1tLb"
}{
"error": true,
"message": "<string>",
"issues": [
{
"code": "<string>",
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": true,
"message": "Self-serve signup is closed"
}{
"error": true,
"message": "Too many signups from this address. Try again later."
}Body
application/json
Optional. An empty body is valid.
Response
Account created.
The only hosts this account can check out at until it is activated.
Example:
["your-sandbox-store.myshopify.com"]
Shown once. Only a SHA-256 hash is stored — nothing can recover it.
Example:
"ck_test_3sQd7yQ0mHq9pP2rVwXk1tLb"