Login With Custom ID

Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user

Error codes

This operation may return the following PlayFab errors:

Error	Code
EncryptedRequestNotAllowed	1301
EncryptionKeyMissing	1290
EvaluationModePlayerCountExceeded	1490
InvalidSignature	1273
InvalidSignatureTime	1324
PlayerCreationDisabled	22000
PlayerSecretAlreadyConfigured	1294
PlayerSecretNotConfigured	1323
RequestViewConstraintParamsNotAllowed	1303
SignedRequestNotAllowed	1302

POST

Client

LoginWithCustomID

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/LoginWithCustomID \
  --header 'Content-Type: application/json' \
  --data '
{
  "CustomId": "67AB-5397-CC54-EA31",
  "CreateAccount": false,
  "TitleId": "144"
}
'

import requests

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

payload = {
    "CustomId": "67AB-5397-CC54-EA31",
    "CreateAccount": False,
    "TitleId": "144"
}
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({CustomId: '67AB-5397-CC54-EA31', CreateAccount: false, TitleId: '144'})
};

fetch('https://{titleId}.playfabapi.com/Client/LoginWithCustomID', 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/LoginWithCustomID",
  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([
    'CustomId' => '67AB-5397-CC54-EA31',
    'CreateAccount' => false,
    'TitleId' => '144'
  ]),
  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/LoginWithCustomID"

	payload := strings.NewReader("{\n  \"CustomId\": \"67AB-5397-CC54-EA31\",\n  \"CreateAccount\": false,\n  \"TitleId\": \"144\"\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/LoginWithCustomID")
  .header("Content-Type", "application/json")
  .body("{\n  \"CustomId\": \"67AB-5397-CC54-EA31\",\n  \"CreateAccount\": false,\n  \"TitleId\": \"144\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"CustomId\": \"67AB-5397-CC54-EA31\",\n  \"CreateAccount\": false,\n  \"TitleId\": \"144\"\n}"

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

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

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

Body

application/json

It is highly recommended that developers ensure that it is extremely unlikely that a customer could generate an ID which is already in use by another customer. If this is the first time a user has signed in with the Custom ID and CreateAccount is set to true, a new PlayFab account will be created and linked to the Custom ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the Custom ID, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.

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.

CreateAccount

boolean

Automatically create a PlayFab account if one is not currently linked to this ID.

CustomId

string

Custom unique identifier for the user, generated by the title.

CustomTags

object

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

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"]
}

PlayerSecret

string

Player secret that is used to verify API request signatures.

Response

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:

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

Last modified on October 1, 2026

⌘I

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/LoginWithCustomID \
  --header 'Content-Type: application/json' \
  --data '
{
  "CustomId": "67AB-5397-CC54-EA31",
  "CreateAccount": false,
  "TitleId": "144"
}
'

import requests

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

payload = {
    "CustomId": "67AB-5397-CC54-EA31",
    "CreateAccount": False,
    "TitleId": "144"
}
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({CustomId: '67AB-5397-CC54-EA31', CreateAccount: false, TitleId: '144'})
};

fetch('https://{titleId}.playfabapi.com/Client/LoginWithCustomID', 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/LoginWithCustomID",
  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([
    'CustomId' => '67AB-5397-CC54-EA31',
    'CreateAccount' => false,
    'TitleId' => '144'
  ]),
  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/LoginWithCustomID"

	payload := strings.NewReader("{\n  \"CustomId\": \"67AB-5397-CC54-EA31\",\n  \"CreateAccount\": false,\n  \"TitleId\": \"144\"\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/LoginWithCustomID")
  .header("Content-Type", "application/json")
  .body("{\n  \"CustomId\": \"67AB-5397-CC54-EA31\",\n  \"CreateAccount\": false,\n  \"TitleId\": \"144\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"CustomId\": \"67AB-5397-CC54-EA31\",\n  \"CreateAccount\": false,\n  \"TitleId\": \"144\"\n}"

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

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

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

PlayFab API

PlayFab REST API References

Login With Custom ID

Error codes

Body

Response