Register Play Fab User

Registers a new Playfab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply a username and an email address.

Error codes

This operation may return the following PlayFab errors:

Error	Code
EmailAddressNotAvailable	1006
EncryptionKeyMissing	1290
EvaluationModePlayerCountExceeded	1490
InvalidEmailAddress	1005
InvalidPartnerResponse	1193
InvalidPassword	1008
InvalidUsername	1007
NameNotAvailable	1058
ProfaneDisplayName	1234
SignedRequestNotAllowed	1302
UsernameNotAvailable	1009

POST

Client

RegisterPlayFabUser

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/RegisterPlayFabUser \
  --header 'Content-Type: application/json' \
  --data '
{
  "Username": "theuser",
  "Email": "me@here.com",
  "Password": "ExampleSecret",
  "TitleId": "1"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/RegisterPlayFabUser"

payload = {
    "Username": "theuser",
    "Email": "me@here.com",
    "Password": "ExampleSecret",
    "TitleId": "1"
}
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: 'theuser',
    Email: 'me@here.com',
    Password: 'ExampleSecret',
    TitleId: '1'
  })
};

fetch('https://{titleId}.playfabapi.com/Client/RegisterPlayFabUser', 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://{titleId}.playfabapi.com/Client/RegisterPlayFabUser",
  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' => 'theuser',
    'Email' => 'me@here.com',
    'Password' => 'ExampleSecret',
    'TitleId' => '1'
  ]),
  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://{titleId}.playfabapi.com/Client/RegisterPlayFabUser"

	payload := strings.NewReader("{\n  \"Username\": \"theuser\",\n  \"Email\": \"me@here.com\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"1\"\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://{titleId}.playfabapi.com/Client/RegisterPlayFabUser")
  .header("Content-Type", "application/json")
  .body("{\n  \"Username\": \"theuser\",\n  \"Email\": \"me@here.com\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"1\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/RegisterPlayFabUser")

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\": \"theuser\",\n  \"Email\": \"me@here.com\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"1\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "PlayFabId": "50DF92E291CCD4C3",
    "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
    "Username": "username"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Body

application/json

TitleId

string

required

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

DisplayName

string

An optional parameter for setting the display name for this title (3-25 characters).

string

User email address attached to their account

EncryptedRequest

string

Base64 encoded body that is encrypted with the Title's public RSA key.

InfoRequestParameters

object

Flags for which pieces of info to return for the user.

Show child attributes

Example:

{
  "GetUserAccountInfo": true,
  "GetUserVirtualCurrency": true,
  "GetUserData": true,
  "UserDataKeys": ["preferences", "progress"]
}

Password

string

Password for the PlayFab account (6-100 characters)

PlayerSecret

string

Player secret that is used to verify API request signatures.

RequireBothUsernameAndEmail

boolean

An optional parameter that specifies whether both the username and email parameters are required. If true, both parameters are required; if false, the user must supply either the username or email parameter. The default value is true.

Username

string

PlayFab username for the account (3-20 characters)

Response

Each account must have a unique email address in the PlayFab service. Once created, the account may be associated with additional accounts (Steam, Facebook, Game Center, etc.), allowing for added social network lists and achievements systems.

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Example:

{
  "PlayFabId": "50DF92E291CCD4C3",
  "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
  "Username": "username"
}

Last modified on October 1, 2026

⌘I

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/RegisterPlayFabUser \
  --header 'Content-Type: application/json' \
  --data '
{
  "Username": "theuser",
  "Email": "me@here.com",
  "Password": "ExampleSecret",
  "TitleId": "1"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/RegisterPlayFabUser"

payload = {
    "Username": "theuser",
    "Email": "me@here.com",
    "Password": "ExampleSecret",
    "TitleId": "1"
}
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: 'theuser',
    Email: 'me@here.com',
    Password: 'ExampleSecret',
    TitleId: '1'
  })
};

fetch('https://{titleId}.playfabapi.com/Client/RegisterPlayFabUser', 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://{titleId}.playfabapi.com/Client/RegisterPlayFabUser",
  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' => 'theuser',
    'Email' => 'me@here.com',
    'Password' => 'ExampleSecret',
    'TitleId' => '1'
  ]),
  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://{titleId}.playfabapi.com/Client/RegisterPlayFabUser"

	payload := strings.NewReader("{\n  \"Username\": \"theuser\",\n  \"Email\": \"me@here.com\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"1\"\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://{titleId}.playfabapi.com/Client/RegisterPlayFabUser")
  .header("Content-Type", "application/json")
  .body("{\n  \"Username\": \"theuser\",\n  \"Email\": \"me@here.com\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"1\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/RegisterPlayFabUser")

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\": \"theuser\",\n  \"Email\": \"me@here.com\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"1\"\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "PlayFabId": "50DF92E291CCD4C3",
    "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
    "Username": "username"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Register Play Fab User

Error codes

Body

Response