Account Nickname
GETAuth required
Returns the nickname associated with the authenticated user's identity. The brand is resolved from the X-Brand request header and the caller's identity is resolved from the X-Client-ID request header — both are set by the gateway and cannot be spoofed by the client.
Endpoint
GET
/account/v1/nicknameBase URL: https://api.derivws.com
Authentication Required
This endpoint requires an OAuth2 Bearer token with the
account_manage scope and a Deriv-App-ID header.Status Codes
200OK - Nickname returned successfully
400Bad request - Missing X-Brand or X-Client-ID gateway header
{
"data": {},
"errors": [
{
"status": 400,
"code": "InputError",
"message": "The request could not be processed"
}
],
"metadata": {
"endpoint": "/account/v1/nickname",
"method": "GET",
"timing": 8
}
}401Unauthorized - Invalid or missing authentication
{
"data": {},
"errors": [
{
"status": 401,
"code": "InternalError",
"message": "Invalid or missing authentication credentials"
}
],
"metadata": {
"endpoint": "/account/v1/nickname",
"method": "GET",
"timing": 6
}
}403Forbidden - Access denied
{
"data": {},
"errors": [
{
"status": 403,
"code": "InternalError",
"message": "You do not have permission to access this resource"
}
],
"metadata": {
"endpoint": "/account/v1/nickname",
"method": "GET",
"timing": 7
}
}404Not found - The brand could not be resolved (BrandNotFound) or no identity exists for this client and brand (IdentityNotFound)
{
"data": {},
"errors": [
{
"status": 404,
"code": "IdentityNotFound",
"message": "No identity exists for this client and brand"
}
],
"metadata": {
"endpoint": "/account/v1/nickname",
"method": "GET",
"timing": 9
}
}504Gateway timeout - Upstream service timeout
{
"data": {},
"errors": [
{
"status": 504,
"code": "InternalError",
"message": "The upstream service did not respond in time"
}
],
"metadata": {
"endpoint": "/account/v1/nickname",
"method": "GET",
"timing": 30000
}
}Any other questions? Get in touch