Home docs switch Account Server (BAAS)
Post

Account Server (BAAS)

URL: https://e0d67c509fb203858ebcb2fe3f88c2aa.baas.nintendo.com

The baas server manages user accounts and friendships on the Nintendo Switch.

Depending on the method, this server takes form or json encoded requests. The server always responds with json encoding.

Headers

HeaderDescription
Hoste0d67c509fb203858ebcb2fe3f88c2aa.baas.nintendo.com
User-AgentUser agent
Accept*/*
AuthorizationAccess token received from /1.0.0/application/token, /1.0.0/login or /1.0.0/federation, prefixed with Bearer . Depends on the method.
X-Nintendo-PowerStateFA (fully awake) or HA (half awake). This header is only sent in the /1.0.0/application/token and /1.0.0/login requests.

The following headers are only sent in POST, PUT, PATCH and DELETE requests.

HeaderDescription
Content-LengthContent length
Content-Typeapplication/x-www-form-urlencoded

If the content type is changed, and the request is performed by the account sysmodule, the headers are swapped.

HeaderDescription
Content-Typeapplication/json or application/json-patch+json
Content-LengthContent length

If the content type is changed, and the request is performed by the friends sysmodule, the Content-Type header appears between the Accept and Authorization headers instead.

User Agents

The user agents below are taken from the account sysmodule. If the request is made by the friends sysmodule replace nnAccount by nnFriends.

System VersionUser agent
9.0.0 - 9.2.0libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 9.3.0.0; Add-on 9.3.0.0)
10.0.0 - 10.2.0libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 10.4.0.0; Add-on 10.4.0.0)
11.0.0 - 11.0.1libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 11.4.0.0; Add-on 11.4.0.0)
12.0.0 - 12.1.0libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 12.3.0.0; Add-on 12.3.0.0)
13.0.0libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 13.3.0.0; Add-on 13.3.0.0)
13.1.0 - 13.2.1libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 13.4.0.0; Add-on 13.4.0.0)
14.0.0 - 14.1.2libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 14.3.0.0; Add-on 14.3.0.0)
15.0.0 - 15.0.1libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 15.3.0.0; Add-on 15.3.0.0)
16.0.0 - 16.1.0libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 16.2.0.0; Add-on 16.2.0.0)
17.0.0 - 17.0.1libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 17.5.0.0; Add-on 17.5.0.0)
18.0.0libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 18.3.0.0; Add-on 18.3.0.0)

Methods

The following methods do not require an access token:

ModuleMethodURL
AccountPOST/1.0.0/application/token
NoneGET/1.0.0/certificates
NoneGET/1.0.0/internal_certificates

The following methods require an anonymous access token:

ModuleMethodURL
AccountPOST/1.0.0/login
AccountPOST/1.0.0/federation
AccountPOST/1.0.0/users

The following methods require a user access token:

ModuleMethodURL
AccountPOST/1.0.0/image_upload
AccountPUT/1.0.0/push_channels/<id>/<id>
FriendsGET/1.0.0/users
BothGET/1.0.0/users/<id>
BothPATCH/1.0.0/users/<id>
FriendsGET/1.0.0/users/<id>/blocks
FriendsPOST/1.0.0/users/<id>/blocks
FriendsDELETE/1.0.0/users/<id>/blocks/<id>
FriendsPATCH/1.0.0/users/<id>/device_accounts/<id>
AccountDELETE/1.0.0/users/<id>/device_accounts/<id>
FriendsPOST/1.0.0/users/<id>/generate_code
AccountPOST/1.0.0/users/<id>/link
AccountPOST/1.0.0/users/<id>/unlink
FriendsPOST/2.0.0/friend_requests
FriendsPATCH/2.0.0/friend_requests/<id>
FriendsGET/2.0.0/users/<id>/friends
FriendsPATCH/2.0.0/users/<id>/friends/<id>
FriendsDELETE/2.0.0/users/<id>/friends/<id>
FriendsGET/2.0.0/users/<id>/friend_requests/inbox
FriendsGET/2.0.0/users/<id>/friend_requests/outbox
FriendsGET/2.0.0/users/<id>/relationships/<id>

POST /1.0.0/application/token

This method provides an anonymous access token.

ParamDescription
grantTypepublic_client
assertionDevice token obtained from dauth server

Response on success:

FieldDescription
expiresInExpiration in seconds (10800)
accessTokenThe anonymous access token
tokenTypeBearer

Example:

1
2
3
4
5
6
7
8
9

POST /1.0.0/application/token HTTP/1.1
Host: e0d67c509fb203858ebcb2fe3f88c2aa.baas.nintendo.com
User-Agent: libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 13.3.0.0; Add-on 13.3.0.0)
Accept: */*
X-Nintendo-PowerState: FA
Content-Length: 872
Content-Type: application/x-www-form-urlencoded

grantType=public_client&assertion=eyJqa3UiOiJodHRwczovL2RjZXJ0LWxwMS5uZGFzLnNydi5uaW50ZW5kby5uZXQva2V5cyIsImtpZCI6IjM2NzllMTg4LTI5ZWUtNDE4Zi04ZDkwLWI3MjRjYzg1MzQ0MSIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI2ODMzN2FjYTI4ODE1Y2JiIiwiaXNzIjoiZGF1dGgtbHAxLm5kYXMuc3J2Lm5pbnRlbmRvLm5ldCIsImF1ZCI6IjhmODQ5YjVkMzQ3NzhkOGUiLCJleHAiOjE2MzI3NjMzMDEsImlhdCI6MTYzMjY3NjkwMSwianRpIjoiZTU5YTBiMGUtOTRlMS00NGFhLWI1ZGItMGZjMGNmNTAyYWRhIiwibmludGVuZG8iOnsic24iOiJYQVcxMDAxMjM0NTY3OCIsInBjIjoiSEFDIiwiZHQiOiJOWCBQcm9kIDEiLCJpc3QiOmZhbHNlfX0.Mdl42B_tWnQQZkpp0qkvEwpkAFGos1YQ8OBKDr_rJCQlNVZLrP6_sd53U8kvwI6TWbnuxFtNxcVJh21kbbY23WsjwQN9Ph2pbjEmneov5b5SfAjWSvfEqt_ViKFQVLv_MZZXQpBYZSQmJ3sA-BbOjeEO6JI5XI3_KR0uj9IxSH_LNSiEwMMNLkP0PcC3gO5cSKcmnb1NPW2BMMdlKOSIbxDSWE4sEuYt2Pl_u2F6hVMVeoC-4z43lIv2tv7aF9Pwv-D7MR-mOxQaxYVHw2Ux4FL0zPZOJMU6qPgfzACeItd6H_A4OBMKSQwBl4DEbSwdle5tph-ur01K91FhXhI6BA

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1061
Connection: keep-alive
Cache-Control: no-store, no-cache
Pragma: no-cache
X-Cloud-Trace-Context: d6b433b5122481d45b61aa4379d547f2
Date: Sun, 26 Sep 2021 19:21:43 GMT
Server: Google Frontend
X-Cache: Miss from cloudfront
Via: 1.1 9608d1fa3f5912724e10840925944987.cloudfront.net (CloudFront)
X-Amz-Cf-Pop: AMS1-C1
X-Amz-Cf-Id: WGSd3qu043Y9Co4sredK7gclrF4BMYPKQXytykkQfwEez4HYJmIbDw==

{"accessToken": "eyJqa3UiOiJodHRwczovL2UwZDY3YzUwOWZiMjAzODU4ZWJjYjJmZTNmODhjMmFhLmJhYXMubmludGVuZG8uY29tLzEuMC4wL2ludGVybmFsX2NlcnRpZmljYXRlcyIsImFsZyI6IlJTMjU2Iiwia2lkIjoiMzA4M2MxYjItNWQ2OC00MzRiLWJlMzItMTFmOTE1NTcwNTAwIn0.eyJzdWIiOiJlZDllMmYwNWQyODZmN2I4IiwiYXVkIjoiZWQ5ZTJmMDVkMjg2ZjdiOCIsImJzOnN0cyI6WzM4NV0sIm5pbnRlbmRvIjp7ImR0IjoiTlggUHJvZCAxIiwicGMiOiJIQUMiLCJkaSI6IjY4MzM3YWNhMjg4MTVjYmIiLCJzbiI6IlhBVzEwMDEyMzQ1Njc4IiwiaXN0IjpmYWxzZX0sImlzcyI6Imh0dHBzOi8vZTBkNjdjNTA5ZmIyMDM4NThlYmNiMmZlM2Y4OGMyYWEuYmFhcy5uaW50ZW5kby5jb20iLCJ0eXAiOiJ0b2tlbiIsImJzOmdydCI6MSwiZXhwIjoxNjMyNjg3NzAxLCJpYXQiOjE2MzI2NzY5MDEsImp0aSI6Ijg3OGQwNzM1LTU3MWEtNGI5NC04MmE2LTJiZjE4MzExNGRiMSJ9.oVn3eE81TJwApnNzhoUJTWhvJJasP5OpURctjSw-evHZVGXSnNbEcNHAGMHQu5QHU7IMiDlBaIM4hb0BU_l7h4EIPtZzZxys0tb4IbyHUD8SQdqjrA7GPadmfuJkIQYMJUUVikTIbAfmVuZ0asM1HjBUEpUjn9JzJgF6355oOePqrcQtWTWtsmthwPpfLj7RfPeGuXlc_89Yj6wBplDkpS3NQGrVULxLXoRBgi_cnhZpgnauorOkynby2EZC2UNfaMxpPXa5yNXPM2HQIiAlnd78Zk4Knl2ZH5xhKbtI6Fzeo0CmCCgzQYfYoh2xhR7WowVPpDNfZiwZ7XX0a3hZLw", "tokenType": "Bearer", "expiresIn": 10800}

POST /1.0.0/login

This method can be used to log in on a device account that was registered with /1.0.0/users. If an application token is provided, the server checks if the device account is linked against a Nintendo account, and if the account has a Nintendo Switch Online membership.

ParamDescription
idDevice account id
passwordDevice account password
appAuthNTokenAAuth token (optional)
skipOp2VerificationSkip NSO verification (optional)

Response on success:

FieldDescription
expiresInExpiration in seconds (10800)
userUser information
idTokenID token (for game servers)
accessTokenAccess token for user
tokenTypeBearer
summarySee below

The summary field is only present if an app token is provided where the policy handler is set to GAME_SERVER and the user has an NSO membership. It looks as follows:

1
2
3
4
5

"summary": {
    "nintendo": {
        "hasMembership": true
    }
}

POST /1.0.0/federation

This method is the same as /1.0.0/login except that it also takes an ID token that represents a Nintendo account. This is required to link the Nintendo account to the device.

ParamDescription
idDevice account id
passwordDevice account password
idpnintendoAccount
idTokenID token obtained from accounts.nintendo.com
appAuthNTokenAAuth token optional
skipOp2VerificationSkip NSO verification (optional)

POST /1.0.0/users

This method registers a new user on the server. This method does not take any parameters. On success, the response contains the new user information and HTTP status code 201.

Example:

1
2
3
4
5
6
7

POST /1.0.0/users HTTP/1.1
Host: e0d67c509fb203858ebcb2fe3f88c2aa.baas.nintendo.com
User-Agent: libcurl (nnAccount; 789f928b-138e-4b2f-afeb-1acae821d897; SDK 13.3.0.0; Add-on 13.3.0.0)
Accept: */*
Authorization: Bearer eyJqa3UiOiJodHRwczovL2UwZDY3YzUwOWZiMjAzODU4ZWJjYjJmZTNmODhjMmFhLmJhYXMubmludGVuZG8uY29tLzEuMC4wL2ludGVybmFsX2NlcnRpZmljYXRlcyIsImFsZyI6IlJTMjU2Iiwia2lkIjoiMzA4M2MxYjItNWQ2OC00MzRiLWJlMzItMTFmOTE1NTcwNTAwIn0.eyJzdWIiOiJlZDllMmYwNWQyODZmN2I4IiwiYXVkIjoiZWQ5ZTJmMDVkMjg2ZjdiOCIsImJzOnN0cyI6WzM4NV0sIm5pbnRlbmRvIjp7ImR0IjoiTlggUHJvZCAxIiwicGMiOiJIQUMiLCJkaSI6IjY4MzM3YWNhMjg4MTVjYmIiLCJzbiI6IlhBVzEwMDEyMzQ1Njc4IiwiaXN0IjpmYWxzZX0sImlzcyI6Imh0dHBzOi8vZTBkNjdjNTA5ZmIyMDM4NThlYmNiMmZlM2Y4OGMyYWEuYmFhcy5uaW50ZW5kby5jb20iLCJ0eXAiOiJ0b2tlbiIsImJzOmdydCI6MSwiZXhwIjoxNjMyNjg3NzAxLCJpYXQiOjE2MzI2NzY5MDEsImp0aSI6Ijg3OGQwNzM1LTU3MWEtNGI5NC04MmE2LTJiZjE4MzExNGRiMSJ9.oVn3eE81TJwApnNzhoUJTWhvJJasP5OpURctjSw-evHZVGXSnNbEcNHAGMHQu5QHU7IMiDlBaIM4hb0BU_l7h4EIPtZzZxys0tb4IbyHUD8SQdqjrA7GPadmfuJkIQYMJUUVikTIbAfmVuZ0asM1HjBUEpUjn9JzJgF6355oOePqrcQtWTWtsmthwPpfLj7RfPeGuXlc_89Yj6wBplDkpS3NQGrVULxLXoRBgi_cnhZpgnauorOkynby2EZC2UNfaMxpPXa5yNXPM2HQIiAlnd78Zk4Knl2ZH5xhKbtI6Fzeo0CmCCgzQYfYoh2xhR7WowVPpDNfZiwZ7XX0a3hZLw
Content-Length: 0
Content-Type: application/x-www-form-urlencoded

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 835
Last-Modified: Sun, 26 Sep 2021 19:21:43 GMT
Location: /1.0.0/users/f09c3d45cc3432c6
Cache-Control: no-store, no-cache
Pragma: no-cache
X-Cloud-Trace-Context: 7ce4b7892458ab7cb2b59ad859885437
Date: Sun, 26 Sep 2021 19:21:43 GMT
Server: Google Frontend
X-Cache: Miss from cloudfront
Via: 1.1 b2d8ce5eb7a72ad5dc65a8cc007a854d.cloudfront.net (CloudFront)
X-Amz-Cf-Pop: AMS1-C1
X-Amz-Cf-Id: 4uJpXHc1kKroh8tdpjO-x55dJLYyzudJ5VWnYdir2csFTjh5C7t3xA==
Connection: keep-alive

{"id":"f09c3d45cc3432c6","etag":"\"4d20053b9c0fcf9a\"","nickname":"","country":"","birthday":"0000-00-00","thumbnailUrl":"","deviceAccounts":[{"id":"7c23fd7c9b37b0cb","password":"0mr1prbsNFzRs0dRCHXRUNECGd1kJVg3Lq6zn0nR"}],"links":{},"permissions":{"personalAnalytics":true,"personalNotification":true,"friendRequestReception":true,"friends":"EVERYONE","presence":"FRIENDS","presenceUpdatedAt":1633432210,"personalAnalyticsUpdatedAt":1633432210,"personalNotificationUpdatedAt":1633432210},"extras":{"self":{},"favoriteFriends":{},"friends":{},"foaf":{},"everyone":{}},"presence":{"state":"OFFLINE","extras":{"self":{},"favoriteFriends":{},"friends":{},"foaf":{},"everyone":{}},"updatedAt":1632676901,"logoutAt":0},"deleted":false,"blocksUpdatedAt":1632676901,"friendsUpdatedAt":1632676901,"createdAt":1632676901,"updatedAt":1632676901}

GET /1.0.0/users/<id>

This method does not take any parameters and simply returns the user information for the given user. If the access token does not belong to the given user, this method returns insufficient_scope.

PATCH /1.0.0/users/<id>

This method updates the given user. The following JSON patch paths are known to work:

  • /nickname
  • /country
  • /birthday
  • /thumbnailUrl
  • /extras/self/nxAccount
  • /permissions/personalAnalytics
  • /permissions/personalNotification
  • /permissions/friendRequestReception
  • /permissions/friends
  • /permissions/presence

DELETE /1.0.0/users/<id>/device_accounts/<id>

Delete the given device account. This method does not take any parameters. Returns HTTP status 204 on success.

POST /1.0.0/users/<id>/generate_code

Generates a new friend code. Returns the new user information on success. After generating a friend code, one cannot generate a new friend code for 24 hours.

ParamDescription
typeNX

GET /1.0.0/certificates

This method returns the JWK set for the id token that’s issued by /1.0.0/login and /1.0.0/federation.

GET /1.0.0/internal_certificates

This method returns the JWK set for the access token that’s issued by /1.0.0/application/token, /1.0.0/login and /1.0.0/federation.

User information

FieldDescription
idUser id (16 hex digits)
etagETag
nicknameNickname
countryCountry
birthdayYYYY-MM-DD
thumbnailUrlThumbnail URL
deviceAccountsList of device accounts
linksLinked accounts
permissionsPrivacy settings
extrasExtras
presenceOnline status
deletedBool
blocksUpdatedAtTimestamp
friendsUpdatedAtTimestamp
createdAtTimestamp
updatedAtTimestamp

Device account

The password is only present once, when the account is created.

FieldDescription
idDevice account id (16 hex digits)
passwordDevice account password (40 random alphanumeric characters)

Linked accounts

FieldDescription
nintendoNetworkNintendo network link
twitterTwitter account link
facebookFacebook account link
googleGoogle account link
friendCodeFriend code

Linked account

FieldDescription
idAccount id
createdAtTimestamp
updatedAtTimestamp
FieldDescription
idFriend code
createdAtTimestamp
updatedAtTimestamp
regenerableAtTimestamp
regenerableBool

Privacy settings

FieldDescription
personalAnalyticsBool
personalNotificationBool
friendRequestReceptionBool
friendsEVERYONE, FRIENDS or SELF
presenceFRIENDS, FAVORITE_FRIENDS or SELF
presenceUpdatedAtTimestamp
personalAnalyticsUpdatedAtTimestamp
personalNotificationUpdatedAtTimestamp

Online status

FieldDescription
stateOFFLINE, INACTIVE, ONLINE or PLAYING
extrasExtras
updatedAtTimestamp
logoutAtTimestamp

Extras

FieldDescription
selfExtras visible by no one
favoriteFriendsExtras visible by best friends
friendsExtras visible by all friends
foafExtras visible by friends of a friend
everyoneExtras visible by everyone

User extras

The following fields are stored in each of the extras.

FieldDescription
playLogJSON-encoded string containing a list of play log entries
nxAccountString that identifies the account (only present in ‘self’-extras)

Presence extras

The following fields are stored in each of the extras.

FieldDescription
appInfo:appIdTitle id
appInfo:presenceGroupIdTitle id
appFieldJSON-encoded string

Play log entry

FieldDescription
appInfo:appIdTitle id
appInfo:presenceGroupIdTitle id
totalPlayCountTotal play count
totalPlayTimeTotal play time in minutes
firstPlayedAtTimestamp
lastPlayedAtTimestamp

Errors

On error, the server sends the following response:

FieldDescription
statusHTTP status code
errorCodeError name
titleError title
detailError details
instancePath of the request that failed
typehttps://baas.nintendo.com/errors/1.0.0/<status>/<errorCode>

Known Errors

StatusCodeTitleDetail
404resource_is_not_foundSpecified resource is not foundResource is not found
405method_not_allowedMethod Not AllowedMethod Not Allowed
400invalid_paramsInvalid Paramsinvalid params
400invalid_requestAuthorization header value is invalidAuth scheme or auth params is invalid
400invalid_device_accountInvalid Device AccountDevice Account’s id or password is invalid
400invalid_ndas_app_authn_tokenInvalid NDAS App AuthN Token 
400invalid_idp??
400invalid_idp_accountInvalid IdP AccountIdP account is invalid
400linked_user_not_foundLinked User Not Foundlinked user not found
400invalid_friend_code_format??
400user_link_not_exist??
400invalid_raw_contentInvalid Raw Contentinvalid raw content
401invalid_tokenToken is invalidThe access token was invalid
403insufficient_scopeToken is insufficientThe access token does not have sufficient scope
403forbidden??
403membership_requiredMembership Required 
403unavailable_device_accountUnavailable Device AccountDevice Account is unavailable
403banned_user??
403banned_user_by_application??
404deleted_user??
406not_acceptable_language??
409resource_already_exists??
409user_link_already_exists??
412precondition_failed??
415unsupported_media_typeUnsupported Media Typeunsupported media type
422friend_code_unregenerable_stateFriend Code Unregenerable State 
500internal_server_errorInternal Server ErrorInternal Server Error
502could_not_confirm_membership??
503under_maintenance??

Environments

EnvironmentPrefix
dd1e97b8a9d672e4ce4845ec6947cd66ef6-sb
dp1d9c8ea0e17f68bdeab8674c59f6fabda-sb
jd1d78dbb1c550d43c6af49bf04c56bc094-sb
lp1e0d67c509fb203858ebcb2fe3f88c2aa
sd196130dc402837b377c07719e6c9514de-sb
sp1dc219b6b3aa8e06873733fda1def0e03-sb
td1e03a97819c9711e59510d820a52f298a-sb
Contents