Login With IOS Device ID

Signs the user in using the iOS device identifier, 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
EvaluationModePlayerCountExceeded	1490
RequestViewConstraintParamsNotAllowed	1303

POST

Server

LoginWithIOSDeviceID

curl --request POST \
  --url https://{titleId}.playfabapi.com/Server/LoginWithIOSDeviceID \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "DeviceId": "29848d9bh8900a0b003",
  "OS": "7.11",
  "DeviceModel": "Iphone 5s",
  "CreateAccount": false
}
'

import requests

url = "https://{titleId}.playfabapi.com/Server/LoginWithIOSDeviceID"

payload = {
    "DeviceId": "29848d9bh8900a0b003",
    "OS": "7.11",
    "DeviceModel": "Iphone 5s",
    "CreateAccount": False
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    DeviceId: '29848d9bh8900a0b003',
    OS: '7.11',
    DeviceModel: 'Iphone 5s',
    CreateAccount: false
  })
};

fetch('https://{titleId}.playfabapi.com/Server/LoginWithIOSDeviceID', 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/Server/LoginWithIOSDeviceID",
  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([
    'DeviceId' => '29848d9bh8900a0b003',
    'OS' => '7.11',
    'DeviceModel' => 'Iphone 5s',
    'CreateAccount' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$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/Server/LoginWithIOSDeviceID"

	payload := strings.NewReader("{\n  \"DeviceId\": \"29848d9bh8900a0b003\",\n  \"OS\": \"7.11\",\n  \"DeviceModel\": \"Iphone 5s\",\n  \"CreateAccount\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	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/Server/LoginWithIOSDeviceID")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"DeviceId\": \"29848d9bh8900a0b003\",\n  \"OS\": \"7.11\",\n  \"DeviceModel\": \"Iphone 5s\",\n  \"CreateAccount\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Server/LoginWithIOSDeviceID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"DeviceId\": \"29848d9bh8900a0b003\",\n  \"OS\": \"7.11\",\n  \"DeviceModel\": \"Iphone 5s\",\n  \"CreateAccount\": false\n}"

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

{
  "code": 123,
  "status": "<string>",
  "data": {
    "NewlyCreated": true,
    "EntityToken": {
      "EntityToken": "lS2hbYH1Gls1KbnlyozHSQBrF4zsq6q006ci9ijSNqQUiiO6xyCQtVrLjsXjdBJ",
      "TokenExpiration": "2022-01-26T07:24:12Z",
      "Entity": {
        "Id": "174812abf712",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
      }
    },
    "InfoResultPayload": {
      "AccountInfo": {
        "PlayFabId": "4027527BF22653D1",
        "Created": "2013-04-07T09:04:28",
        "Username": "my name",
        "TitleInfo": {
          "Origination": "IOS",
          "Created": "2014-01-08T11:03:18",
          "LastLogin": "2014-04-07T09:04:28",
          "FirstLogin": "2014-01-08T11:03:18",
          "TitlePlayerAccount": {
            "Id": "174812abf712",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
          }
        },
        "FacebookInfo": {
          "FacebookId": "23525445454"
        },
        "SteamInfo": {
          "SteamCountry": "US",
          "SteamCurrency": "USD"
        },
        "GameCenterInfo": {
          "GameCenterId": "someone"
        }
      },
      "UserVirtualCurrency": {
        "GC": 15
      },
      "UserVirtualCurrencyRechargeTimes": {
        "GC": {
          "SecondsToRecharge": 3600,
          "RechargeTime": "2014-01-01T12:00:00",
          "RechargeMax": 50
        }
      },
      "UserData": {
        "preferences": {
          "Value": "alpha",
          "LastUpdated": "2014-08-20T12:30:45",
          "Permission": "Public"
        },
        "progress": {
          "Value": "level_twenty",
          "LastUpdated": "2014-09-01T10:12:30"
        }
      },
      "UserDataVersion": 12,
      "PlayerProfile": {
        "TitleId": "TitleName",
        "PlayerId": "10931252888739651331",
        "Created": "0001-01-01T00:00:00",
        "LastLogin": "0001-01-01T00:00:00",
        "BannedUntil": "9999-12-31T23:59:59.9999999",
        "DisplayName": "PlayerDisplayName",
        "TotalValueToDateInUSD": 0
      }
    },
    "LastLoginTime": "<string>",
    "PlayFabId": "<string>",
    "SessionTicket": "<string>",
    "SettingsForUser": {
      "GatherDeviceInfo": true,
      "GatherFocusInfo": true,
      "NeedsAttribution": true
    },
    "TreatmentAssignment": {
      "Variables": [
        {
          "Name": "<string>",
          "Value": "<string>"
        }
      ],
      "Variants": [
        "<string>"
      ]
    }
  }
}

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

Authorizations

X-SecretKey

string

header

required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json

On iOS devices, the identifierForVendor (https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIDevice_Class/index.html#//apple_ref/occ/instp/UIDevice/identifierForVendor) must be used as the DeviceId, as the UIDevice uniqueIdentifier has been deprecated as of iOS 5, and use of the advertisingIdentifier for this purpose will result in failure of Apple's certification process. If this is the first time a user has signed in with the iOS device and CreateAccount is set to true, a new PlayFab account will be created and linked to the vendor-specific iOS device ID. In this case, no email or username will be associated with the PlayFab account. Otherwise, if no PlayFab account is linked to the iOS device, an error indicating this will be returned, so that the title can guide the user through creation of a PlayFab account.

DeviceId

string

required

Vendor-specific iOS identifier for the user's device.

CreateAccount

boolean

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

CustomTags

object

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

DeviceModel

string

Specific model of the user's device.

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

string

Specific Operating System version for the user's device.

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

Last modified on October 1, 2026

⌘I

curl --request POST \
  --url https://{titleId}.playfabapi.com/Server/LoginWithIOSDeviceID \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "DeviceId": "29848d9bh8900a0b003",
  "OS": "7.11",
  "DeviceModel": "Iphone 5s",
  "CreateAccount": false
}
'

import requests

url = "https://{titleId}.playfabapi.com/Server/LoginWithIOSDeviceID"

payload = {
    "DeviceId": "29848d9bh8900a0b003",
    "OS": "7.11",
    "DeviceModel": "Iphone 5s",
    "CreateAccount": False
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    DeviceId: '29848d9bh8900a0b003',
    OS: '7.11',
    DeviceModel: 'Iphone 5s',
    CreateAccount: false
  })
};

fetch('https://{titleId}.playfabapi.com/Server/LoginWithIOSDeviceID', 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/Server/LoginWithIOSDeviceID",
  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([
    'DeviceId' => '29848d9bh8900a0b003',
    'OS' => '7.11',
    'DeviceModel' => 'Iphone 5s',
    'CreateAccount' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$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/Server/LoginWithIOSDeviceID"

	payload := strings.NewReader("{\n  \"DeviceId\": \"29848d9bh8900a0b003\",\n  \"OS\": \"7.11\",\n  \"DeviceModel\": \"Iphone 5s\",\n  \"CreateAccount\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	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/Server/LoginWithIOSDeviceID")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"DeviceId\": \"29848d9bh8900a0b003\",\n  \"OS\": \"7.11\",\n  \"DeviceModel\": \"Iphone 5s\",\n  \"CreateAccount\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Server/LoginWithIOSDeviceID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"DeviceId\": \"29848d9bh8900a0b003\",\n  \"OS\": \"7.11\",\n  \"DeviceModel\": \"Iphone 5s\",\n  \"CreateAccount\": false\n}"

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

{
  "code": 123,
  "status": "<string>",
  "data": {
    "NewlyCreated": true,
    "EntityToken": {
      "EntityToken": "lS2hbYH1Gls1KbnlyozHSQBrF4zsq6q006ci9ijSNqQUiiO6xyCQtVrLjsXjdBJ",
      "TokenExpiration": "2022-01-26T07:24:12Z",
      "Entity": {
        "Id": "174812abf712",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
      }
    },
    "InfoResultPayload": {
      "AccountInfo": {
        "PlayFabId": "4027527BF22653D1",
        "Created": "2013-04-07T09:04:28",
        "Username": "my name",
        "TitleInfo": {
          "Origination": "IOS",
          "Created": "2014-01-08T11:03:18",
          "LastLogin": "2014-04-07T09:04:28",
          "FirstLogin": "2014-01-08T11:03:18",
          "TitlePlayerAccount": {
            "Id": "174812abf712",
            "Type": "title_player_account",
            "TypeString": "title_player_account"
          }
        },
        "FacebookInfo": {
          "FacebookId": "23525445454"
        },
        "SteamInfo": {
          "SteamCountry": "US",
          "SteamCurrency": "USD"
        },
        "GameCenterInfo": {
          "GameCenterId": "someone"
        }
      },
      "UserVirtualCurrency": {
        "GC": 15
      },
      "UserVirtualCurrencyRechargeTimes": {
        "GC": {
          "SecondsToRecharge": 3600,
          "RechargeTime": "2014-01-01T12:00:00",
          "RechargeMax": 50
        }
      },
      "UserData": {
        "preferences": {
          "Value": "alpha",
          "LastUpdated": "2014-08-20T12:30:45",
          "Permission": "Public"
        },
        "progress": {
          "Value": "level_twenty",
          "LastUpdated": "2014-09-01T10:12:30"
        }
      },
      "UserDataVersion": 12,
      "PlayerProfile": {
        "TitleId": "TitleName",
        "PlayerId": "10931252888739651331",
        "Created": "0001-01-01T00:00:00",
        "LastLogin": "0001-01-01T00:00:00",
        "BannedUntil": "9999-12-31T23:59:59.9999999",
        "DisplayName": "PlayerDisplayName",
        "TotalValueToDateInUSD": 0
      }
    },
    "LastLoginTime": "<string>",
    "PlayFabId": "<string>",
    "SessionTicket": "<string>",
    "SettingsForUser": {
      "GatherDeviceInfo": true,
      "GatherFocusInfo": true,
      "NeedsAttribution": true
    },
    "TreatmentAssignment": {
      "Variables": [
        {
          "Name": "<string>",
          "Value": "<string>"
        }
      ],
      "Variants": [
        "<string>"
      ]
    }
  }
}

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

PlayFab API

PlayFab REST API References

Login With IOS Device ID

Error codes

Authorizations

Body

Response