Developer Help Center

POST /partner/account/signup

Table 1. Request Body Parameters

Parameter

Type

Description

email

Mandatory

integer

User's email.

  • Must be unique

  • Must be a PayPal email address in order for the partner to pay royalties to the user via Revelator

The partner can pay each user via PayPal or manage payments to users externally. When using Revelator's distribution deals, Revelator will pay the partner according to the payout preferences specified for the parent account.

password

Mandatory

string

User's password (minimum of 6 characters).

For prompted signup: Partners using prompted signup must prompt users for this value.

For unprompted signup: Partners using unprompted signup (and therefore, unprompted authentication) must still provide a value for this parameter. The user will have no knowledge of this value and the partner will have no need for it as it is not required for unprompted authentication.

enterpriseName

Mandatory

string

The name of the artist, manager or label represented by the account.

This will be the name of the Rights Holder, Payee, and Contract automatically created with the account.

firstname

Optional

string

User's first name.

lastname

Optional

string

User's last name.

type

Mandatory

string

Growth - The type of child account to create. Growth is the appropriate account type for all API users.

partnerAPIKey

Mandatory

string

API key provided upon onboarding.

partnerUserId

Optional

string

Unique ID for the user.

The ID is used for unprompted authentication. It is recommended to use the user's existing ID in the partner application, avoiding the need for partners to save additional credential information.

When unprompted authentication will never be used, this parameter is unnecessary and can be omitted.

maxArtists

Optional

integer

Maximum number of artists the user can create in the account. By default, there is no artist limit.

The following count as an artist towards the maximum:

  • Each artist named as the primary artist for a release (contributors, even contributors with the Primary Artist role, do not count)

  • Each compilation release (there is no artist named for the release; there are artists named for each track)

storeAccess

Optional

object

Controls which stores (digital service providers / DSPs) the child account can distribute to. By default, all stores available in the partner's parent account will be available in the child account.

Parameter

Type

Description

type

string

  • all - All stores available in the partner's parent account will be available

  • some - The stores specified in storeIds will be available

  • none - The child account will not be able to distribute releases

storeIds

array of integers

The Revelator ID for each store that will be available,

Lookup DSP IDs using the GET /common/lookup/stores resource. Provide an access token to retrieve only the DSPs enabled for a specific account.



curl -iv -X POST "https://staging-api.revelator.com/partner/account/signup”\
-H "Accept:application/json"\ 
-H "Content-Type:application/json" \
-d ‘{ "email":"exampleemail@company.com",
    "password":"password123",
    "enterpriseName": "John Doe Band",
    "firstname":"John",
    "lastname": "Doe",
    "type":"Launch",
    "partnerApiKey":"00000000-0000-0000-0000-000000000000",
    "partnerUserId":"XXXXX"}’
Table 2. Response

Response Body (success)

Parameter

Type

Description

userId

string

The Revelator user ID for the newly created user.

enterpriseId

integer

The Revelator account ID for the newly created child account.

Store this ID in order to make upgrades to the account in the future.

HTTP codes

Code

Description

204 No Content

Success

403 Forbidden

If the request would grant an account access to resources the partner doesn't have access to. For example, setting storeIds to a store the partner doesn't have access to.



{ userId: "a57cbed3-3bf1-4ada-b16c-40d0320bfc8cb",
  enterpriseId: 123456}