Create new user
Creates a new user aggregate with initial profile data.
curl -X POST "https://api.spkey.co/users/example_string/CreateUser" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"userId": "example_string",
"email": "user@example.com",
"firstName": "John Doe",
"lastName": "John Doe",
"phoneNumber": "+1-555-0123"
}'
import requests
import json
url = "https://api.spkey.co/users/example_string/CreateUser"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"userId": "example_string",
"email": "user@example.com",
"firstName": "John Doe",
"lastName": "John Doe",
"phoneNumber": "+1-555-0123"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/users/example_string/CreateUser", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"userId": "example_string",
"email": "user@example.com",
"firstName": "John Doe",
"lastName": "John Doe",
"phoneNumber": "+1-555-0123"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"userId": "example_string",
"email": "user@example.com",
"firstName": "John Doe",
"lastName": "John Doe",
"phoneNumber": "+1-555-0123"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/users/example_string/CreateUser", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/users/example_string/CreateUser')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"userId": "example_string",
"email": "user@example.com",
"firstName": "John Doe",
"lastName": "John Doe",
"phoneNumber": "+1-555-0123"
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "550e8400-e29b-41d4-a716-446655440000",
"version": 1,
"event": null
}
{
"success": true,
"aggregateId": "550e8400-e29b-41d4-a716-446655440000",
"version": 1,
"userId": "550e8400-e29b-41d4-a716-446655440000"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
POST
/users/{id}/CreateUserPOST
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token (JWT)
Bearer Tokenstring
RequiredJWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
RequiredAPI key for B2B organization access. Provided during organization onboarding.
API key for B2B organization access. Provided during organization onboarding.
path
idstring
RequiredUser ID
Content-Typestring
RequiredThe media type of the request body
Options: application/json
userIdstring
RequiredUser UUID
emailstring
RequiredUser email
Format: email
firstNamestring
First name
lastNamestring
Last name
phoneNumberstring
Phone number
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
header
X-API-Keystring
RequiredAPI Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
idstring
RequiredUser ID
Body
application/json
userIdstring
RequiredUser UUID
emailstring
RequiredUser email
firstNamestring
First name
lastNamestring
Last name
phoneNumberstring
Phone number
Responses
successboolean
RequiredaggregateIdstring
Requiredversionnumber
Requiredeventobject,null
RequireduserIdstring
Requiredsuccessboolean
RequiredaggregateIdstring
Requiredversionnumber
Requiredeventobject,null
RequireduserIdstring
Requirederrorstring
Requiredmessagestring
RequiredWas this page helpful?