Overview

Sections

Theme switcher

Register by MSISDN

Header Parameters

Authorizationstring Required

Bearer token

StoreIdstring Required

StoreId API key provided by Tuned Global to authenticate and authorize access to the service

Body Parameters

CountryCodestring Required

ISO 3166-1 alpha-2 country code representing the user's registered country

PhoneNumberstring Required

User's phone number in international format, used for registration and verification

Tokenstring Required

Authentication token used to verify the user's registration request

GeoCountryCodestring

ISO 3166-1 alpha-2 country code based on the user's geolocation data

OtpProviderstring

Name of the service provider used for sending one-time passwords (OTPs)

Response

200
Object

OK

Response Attributes

UserIdinteger

Id of the user

GroupIdstring

The Id of the group which user belongs to

DisplayNamestring

Publicly visible display name for the user

FirstNamestring

First name

LastNamestring

Last name

PrimaryEmailstring

Main email address for the user

PhoneNumberstring

Phone Number for the user

Countrystring

Users home country

Languagestring

Language preference for this user

Circlestring

Identifier for the user's social or interest group within the platform

BirthYearinteger

Birth year

Genderstring

User's gender as specified during registration or profile update

Enum values:
FemaleMale
Subscriptionsarray

List of this users subscriptions to the service

IsVerifiedboolean

Boolean to see if user is verified or not

ContentKeystring

Content Key

AudioQualitystring

Preferred audio streaming quality selected by the user

Enum values:
lowhighhlsflacogg
IsPrimaryEmailValidatedboolean

Is primary email validated?

Imagestring

URL to a profile image for the user

BackgroundImagestring

URL to a background image for the user's profile page

Followersarray

List of user id's of other users following this user

Followingarray

List of user id's of other users this user is following

IsPublicboolean

Is this user visible to other users?

IsEnabledboolean

Is this user active?

OptedInboolean

Indicates whether the user has opted in to receive marketing communications

Blockedarray

List of user ids this user has blocked

HadTrialboolean

Indicate if the user has ever been on a free trial before

Devicesarray

Devices this user currently has registered

IsSubProfileboolean

Indicate if the user is a profile.

PrimaryUserIdinteger

The primary user ID if the user is a profile, otherwise it's NULL.

Actionstring

Specifies the action taken or required related to the user registration process.

Loginsarray

A record of the user's login sessions including timestamps and associated metadata.

ContentLanguagesarray

A list of language codes representing the user's preferred content languages.

UserCentricsControllerIDstring

User Centrics Controller ID

ExternalIdstring

External ID of the user

DateCreatedstring
Tokenobject

Authentication token used to verify the user's registration request

Show child attributes

400
Object

Bad Request

409
Object

The phone number (countryCode + phoneNumber) is already registered to an existing account.

Was this section helpful?

POST

/

Select
1

Response

Error Codes

400

Token missing

400

Invalid GeoCountryCode

400

OTP validation failed

400

User creation failed

409

The phone number (countryCode + phoneNumber) is already registered to an existing account.

Was this section helpful?