Create a user

Create a user.

POST /v1/w3s/users

Create a user

cURL

curl --request POST \
  --url https://api.circle.com/v1/w3s/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "ext_user_id_1"
}
'

import requests

url = "https://api.circle.com/v1/w3s/users"

payload = { "userId": "ext_user_id_1" }
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({userId: 'ext_user_id_1'})
};

fetch('https://api.circle.com/v1/w3s/users', 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.circle.com/v1/w3s/users",
  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([
    'userId' => 'ext_user_id_1'
  ]),
  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.circle.com/v1/w3s/users"

	payload := strings.NewReader("{\n  \"userId\": \"ext_user_id_1\"\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.circle.com/v1/w3s/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userId\": \"ext_user_id_1\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.circle.com/v1/w3s/users")

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  \"userId\": \"ext_user_id_1\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "data": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "createDate": "2023-01-01T12:04:05Z",
    "pinStatus": "ENABLED",
    "status": "ENABLED",
    "securityQuestionStatus": "ENABLED",
    "pinDetails": {
      "failedAttempts": 123,
      "lockedDate": "2023-01-01T12:04:05Z",
      "lockedExpiryDate": "2023-01-01T12:04:05Z",
      "lastLockOverrideDate": "2023-01-01T12:04:05Z"
    },
    "securityQuestionDetails": {
      "failedAttempts": 123,
      "lockedDate": "2023-01-01T12:04:05Z",
      "lockedExpiryDate": "2023-01-01T12:04:05Z",
      "lastLockOverrideDate": "2023-01-01T12:04:05Z"
    }
  }
}

{
  "code": 400,
  "message": "Bad request."
}

{
  "code": 401,
  "message": "Malformed authorization."
}

Authorizations

Authorization · string · header · required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request.

Body

application/json

Request body

userId · string · required

Unique system generated identifier for the user.

Required string length: 5 - 50

Example:

"ext_user_id_1"

Response

201

application/json

User creation successful.

data · object · required

Show child attributes