Skip to main content
POST
/
auth
/
signup
Sign Up
curl --request POST \
  --url https://api.example.com/auth/signup \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "email": "jsmith@example.com",
  "password": "<string>",
  "role": "business"
}
'
import requests

url = "https://api.example.com/auth/signup"

payload = {
    "username": "<string>",
    "email": "jsmith@example.com",
    "password": "<string>",
    "role": "business"
}
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({
    username: '<string>',
    email: 'jsmith@example.com',
    password: '<string>',
    role: 'business'
  })
};

fetch('https://api.example.com/auth/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.example.com/auth/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([
    'username' => '<string>',
    'email' => 'jsmith@example.com',
    'password' => '<string>',
    'role' => 'business'
  ]),
  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.example.com/auth/signup"

	payload := strings.NewReader("{\n  \"username\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"role\": \"business\"\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.example.com/auth/signup")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"role\": \"business\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/auth/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  \"username\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"password\": \"<string>\",\n  \"role\": \"business\"\n}"

response = http.request(request)
puts response.read_body
{
  "user_id": "<string>",
  "username": "<string>",
  "email": "<string>",
  "message": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Sign up request model.

username
string
required
Required string length: 3 - 50
email
string<email>
required
password
string
required
Required string length: 8 - 72
role
enum<string>
default:business

User role enumeration.

Available options:
business,
developer,
admin

Response

Successful Response

Sign up response model.

user_id
string
required
username
string
required
email
string
required
role
enum<string>
required

User role enumeration.

Available options:
business,
developer,
admin
message
string
required