User Registration (Group)

This API operation allows Group Managers to register new users and add them directly to their group.

This is a group manager endpoint, which means that the authenticated user must be the manager of a group.
For more information regarding groups, you can visit the AdultWork.com group site.

URL / Endpoint

Need help with Postman?

POST /v1/Groups/Account/Register

Request

Property	Type	Description
`GroupID`	integer	Required. The ID of the group that the user should be added to. This must be a group of which the authenticated user is the manager.
`Nickname`	string	Required. The nickname of the user, which other users can use to identify or find this user. The nickname must be unique on the site, and maximum `20` characters.
`Password`	string	Required. The password of the user. This should be something unique and secure which can't be easily guessed using other information. Maximum `20` characters long.
`ConfirmPassword`	string	Required. The confirmation of the password, to ensure no mistakes were made while typing the password. Must be equal to `Password`.
`EmailAddress`	string	Required. The email address assigned to the user. This must be an unique email on the site, unless `GroupCanLogin` has been set to `true`, in which case the email can be equal to the managers email address. Maximum `100` characters long, and must be a valid email address.
`GroupCanLogin`	boolean	Specify whether the user should be able to log in on the site by him- or herself. If this value is not specified, `false` will be assumed. If this is set to `false`, then `EmailAddress` can be set equal to the Manager's email address.
`BirthDate`	date	Required. The birth date of the user. This birth date must imply that the user is at least 18 years old, so if the date is 1 february 2019, the birth date must be before 1 february 2001. Format: `YYYY-MM-DD`
`CountryID`	integer	Required. The ID of the country that the user is located in. For a list of countries, see GetCountries.
`RegionID`	integer	The ID of the region that the user is located in. Must be a region contained in the country specified by `CountryID`. For a list of regions, see GetRegions.
`CountyID`	integer	The ID of the county that the user is located in. Must be a county contained in the region specified by `RegionID`. For a list of counties, see GetCounties.
`TZLocationID`	string	The ID of the timezone that the user is located in. Must be a timezone contained in the country specified by `CountryID`. For a list of timezones, see GetTimeZones.
`CurrencyID`	integer	The ID of the currency that the user is using. Must be a currency contained in the country specified by `CountryID`. For a list of currencies, see GetCurrencies.
`IsOfferingServices`	boolean	Specify whether the user will be offering services on AdultWork.com. If this value is not specified, `false` will be assumed, and the user will instead be seeking services. If this value is set as true, at least one of the following properties must also be set as true: `IsEscort`, `IsWebcam`, `IsPhoneChat`, `IsSMSChat`, `IsEroticContentProvider`, `IsAlternative`, or `IsSupplier`.
`IsEscort`	boolean	Specify whether the user would like to offer Escort Services on the site. If this value is not specified, `false` will be assumed. Requires `IsOfferingServices` to be set as `true`.
`IsWebcam`	boolean	Specify whether the user would like to offer Webcam Services on the site. If this value is not specified, `false` will be assumed. Requires `IsOfferingServices` to be set as `true`.
`JCIOnly`	boolean	Specify whether the user will only be able to log in to JustCamIt, the application used for DirectCam and DirectIM. If this value is not specified, `false` will be assumed.
`IsPhoneChat`	boolean	Specify whether the user would like to offer Phone Chat Services on the site. If this value is not specified, `false` will be assumed. Requires `IsOfferingServices` to be set as `true`.
`IsSMSChat`	boolean	Specify whether the user would like to offer SMS Chat Services on the site. If this value is not specified, `false` will be assumed. Requires `IsOfferingServices` to be set as `true`. Requires `MobileNumber` to be specified.
`MobileNumber`	string	Specify the Mobile Phone number of the user. Required if `IsSMSChat` is set to `true`. A verification SMS will be sent to the user, allowing the mobile number to be verified straight away. Must be a valid phone number including the country code (for example, 44 for UK), and no formatting characters such as + or parentheses.
`IsEroticContentProvider`	boolean	Specify whether the user would like to provide erotic content on the site. If this value is not specified, `false` will be assumed. Requires `IsOfferingServices` to be set as `true`.
`IsSupplier`	boolean	Specify whether the user would like to offer other services on the site, specified by `SupplierCategories`. If this value is not specified, `false` will be assumed. Requires `IsOfferingServices` to be set as `true`.
`SupplierCategories`	string of comma-seperated integers	Required if `IsSupplier` is set to `true`. A list of other services that the user is providing. Enabling these comes with a daily fee of 1.00 Credits for the first service, and 0.10 Credits for any additional services (VAT excluded). For a list of services, see GetOtherServices.
`ShowInClientConnections`	boolean	Specify whether the user would like to show up in the Client Connections section of the site. If this value is not specified, `false` will be assumed.
`AcceptedTerms`	boolean	Required. Specify whether the user has accepted the terms and conditions of the site. Must be set to true.
`EmailVerifyURL`	string	The Verification URL that the user will receive in their mail, which will be appended with the verification token. Supplying this allows you to create your own verification page by making use of the GroupVerify endpoint. As an example, supplying a value of `https://my.website.com/verify?code=` will make the verification email contain a link similair to the following: `https://my.website.com/verify ?code=8973485289423895`

Request Information

HTTP Method / Verb

Parameters can be passed to this operation using the HTTP POST method with serialized JSON in the request body.

Headers

The REST API uses HTTP request headers to determine what data type is returned or to authenticate the developer's API key. More information can be found in the overview section.

Authentication

An Authorization header is required with every request and must contain the access_token of the user. More information can be found in the Access tokens page.

Samples

POST method

https://api-sandbox.adultwork.com/v1/Groups/Account/Register
Authorization: bearer {your-access-token}

{
    "GroupID": 123,
    "Nickname": "MyNewGroupUser",
    "Password": "CfeAF57!85Knt",
    "ConfirmPassword": "CfeAF57!85Knt",
    "EmailAddress": "MyNewGroupUser@gmail.com",
    "BirthDate": "1997-02-01",
    "CountryID": 158,
    "AcceptedTerms": true,
    "GroupCanLogin": true
}

Response

Property	Type	Description
`UserID`	integer	The ID of the created user.
`IsEmailVerified`	boolean	Whether the email address was verified straight away, which can happen if for example the manager's email was re-used.

Response Sample

The following example returns a successfully registered user.

JSON
XML

{
    "UserID": 12345,
    "IsEmailVerified": false
}

<RegisterOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.Account">
    <IsEmailVerified>false</IsEmailVerified>
    <UserID>12345</UserID>
</RegisterOutput>