PostUser

Post User

Allows to add new User.

Request

URL: /v1/users

Method: POST

Path Parameters: None

Query Parameters: None

Headers:

Content-Type: application/json

g-recaptcha-platform: {Web|Android|iOS}

g-recaptcha-token: {reCAPTCHA Token for "signup" action}

Content:

Field	Type	Description	Requirement Type
firstName	string	User first name.	Optional
lastName	string	User last name.	Optional
nickname	string	User nickname.	Optional
pictureUrl	string	Valid URL of picture image file.	Optional
bannerUrl	string	Valid URL of banner image file.	Optional
websiteUrl	string	Valid URL of User personal website.	Optional
twitterUrl	string	Valid URL of User Twitter account.	Optional
instagramUrl	string	Valid URL of User Instagram account.	Optional
spotifyProfile	string	Spotify artist profile URI. E.g. spotify:artist:xyz for artist link https://open.spotify.com/artist/xyz include.	Optional
soundCloudProfile	string	SoundCloud artist profile permalink. E,g. xyz for artist link https://soundcloud.com/xyz.	Optional
appleMusicProfile	string	Apple Music artist profile ID. E,g. xyz for artist link https://music.apple.com/abcd/efg/xyz.	Optional
location	string	User location.	Optional
role	string	User role.	Optional
genre	string	User genre.	Optional
biography	string	User biography.	Optional
companyName	string	Company name.	Oprional
companyLogoUrl	string	Valid URL of company logo image.	Optional
companyIpRights	boolean	Indicates if the IP rights belong to the company.	Optional
dspPlanSubscribed	boolean	Indicates if subscribed to the DSP pricing plan.	Optional
walletAddress	string	User wallet address.	Optional
email	string	Valid email address.	Required
newPassword	string	Plaintext password.	Required
confirmPassword	string	Plaintext password confirmation.	Required
authCode	string	2FA Code.	Required
clientPlatform	string	Client platform type. Valid values are: Web, Android and IOS. Defaults to Web if missing.	Optional

Content example:

{
    "firstName": "John",
    "lastName": "Doe",
    "nickname": "Johnny"
    "pictureUrl": "https://somewebsite/john-doe.png",
    "role": "Producer",
    "genre": "Pop",
    "biography": "John is a leading Pop Music Producer",
    "walletAddress": "addr123456789123456789",
    "email": "[email protected]",
    "newPassword": "abc@123",
    "confirmPassword": "abc@123",
    "authCode": "123456"
}

✅ Success Response

Code: 200 OK

Headers:

Content-Type: application/json

Content:

Field	Type	Description	Condition
userId	string	UUID of the added User.	Always

Content example:

{
    "userId": "7bd2862f-8deb-4814-8943-156d9dab80dd"
}

❌ Error Responses

1. Bad Request

Code: 400 BAD REQUEST

Condition: If a mandatory content field is missing.

Headers:

Content-Type: application/json

Content example:

{
    "code": 400,
    "description": "Bad Request",
    "cause": "Missing email"
}

2. Forbidden

Code: 403 FORBIDDEN

Condition: If 2FA failed because authCode is invalid.

Headers:

Content-Type: application/json

Content example:

{
    "code": 403,
    "description": "Forbidden",
    "cause": "2FA failed"
}

3. Conflict

Code: 409 CONFLICT

Condition: If email is already registered to another user.

Headers:

Content-Type: application/json

Content example:

{
    "code": 409,
    "description": "Conflict",
    "cause": "Already exists: [email protected]"
}

4. Unprocessable Entity

Code: 422 UNPROCESSABLE ENTITY

Condition: If a content field is malformed or invalid.

Headers:

Content-Type: application/json

Content example:

{
    "code": 422,
    "description": "Unprocessable Entity",
    "cause": "Invalid email: john.doe!gmail.com"
}

See Also

Patch User (Update User)

Get User

Get Users

Get User Count

Delete User

Put User Password (Reset Password)