This method registers a new user at your site, in accordance with the predefined site Policies and the Schema of the Accounts Storage. On-site registration requires three API calls:

1. accounts.initRegistration
2. accounts.register  
3. accounts.finalizeRegistration

If the finalizeRegistration  parameter of accounts.register is set to 'true' then there is no need to call accounts.finalizeRegistration. 

A regToken (registration token), generated by accounts.initRegistration, is required when using this method .

For registration through a social network, see  accounts.socialLogin .

Note: This method is treated as a client-side call, so even if you pass your secret key to the API call, you still will not be able to set profile or data fields that have a writeAccess mode of 'serverOnly'. In this instance, if you are registering an account that has fields with 'serverOnly' writeAccess, then make the call to accounts.register without these fields in the profile/data object, and then take the UID from the register response, and pass it to accounts.setAccountInfo, which will be treated as a server-side call if you pass a secret/signature and the UID (not the regToken).

Parameters

Response Data

validationErrors: [
    {
      "errorCode": 400006,
      "message": "invalid password - minimum length of 6 characters is required",
      "fieldName": "password"
    },
    {
      "errorCode": 400006,
      "message": "wrong format",
      "fieldName": "profile.email"
    }
  ],

Response Example

{
  "sessionInfo": {
    "cookieName": "gac_2_ddxTpQZ_zGiuCsCePVKC6bZcBp_qD-pjql",
    "cookieValue": "VC1_739B3B4AD534B6F62AHNld3Knl98Q_vGL5_SxwA=="
  },
  "UID": "e862a450214c46b3973ff3c8368d1c7e",
  "UIDSignature": "iwPwRr3oDmbb8hhTeoO5JHTrc2Y=",
  "signatureTimestamp": "1344415327",
  "loginProvider": "site",
  "isRegistered": true,
  "registeredTimestamp": 1344415327000,
  "registered": "2012-08-08T08:42:07Z",
  "isActive": true,
  "isVerified": true,
  "verifiedTimestamp": 1344413279133,
  "verified": "2012-08-08T08:07:59.133Z",
  "socialProviders": "site",
  "profile": {
    "email": "Joe@hotmail.com",
    "firstName": "Joe",
    "lastName": "Smith",
    "age" : "31",
    "gender" : "m",
    "country" : "US"
  },
  "created": "2012-08-08T08:07:59.128Z",
  "createdTimestamp": 1344413279128,
  "lastLogin": "2012-08-08T08:42:07Z",
  "lastLoginTimestamp": 1344415327000,
  "lastUpdated": "2012-08-08T08:07:59.133Z",
  "lastUpdatedTimestamp": 1344413279133,
  "oldestDataUpdated": "2012-08-08T08:07:59.133Z",
  "oldestDataUpdatedTimestamp": 1344413279133,
  "statusCode": 200,
  "errorCode": 0,
  "statusReason": "OK",
  "callId": "8fb3eaf37a424cae8c3e6fe3f53cc177",
  "time": "2015-03-22T11:42:25.943Z"
}

Errors

Gigya defines specific error codes and messages that are used with the Accounts API. These errors are returned with the APIs, indicating that some information is incorrect or missing. 

This section describes the errors that are related to this API, the reasons for each error, and the expected next step.

• Account pending registration (error code 206001) - returned when you call a method that performs social login, such as this method, and the registration process has not been finalized, or the schema defines fields as required and one or more of these fields are missing from the user Profile or data. The expected next step is: if the schema defines fields that are required and one or more of these fields are missing from the user profile or data, call accounts.setAccountInfo. If the registration process has not been finalized, call accounts.finalizeRegistration.
• CAPTCHA verification failed (error code 400021) - returned when the registration policy states that requireCaptcha  is "true", and the CAPTCHA verification fails when a user tries to register.
• Login identifier exists (error code 403043) - returned when email is defined as the loginIdentifier in the accountOptions  policy, and the email address received from the provider exists in the system but is associated with a different user. The expected next step: call accounts.linkAccounts to merge between the account identified by the provided UID and the account identified by the provided login credentials (loginID + password).
• Validation errors - the validationErrors object is an array of validation errors; each validation error is made up of an errorCode , a message, and a fieldName . The errorCode and message specify what error occurred and the fieldName specifies which field had a validation error. When an invalid field type is used, i.e. a string instead of an integer, or if a wrong format is used, i.e. an email address that is not in a correct format, an "Invalid parameter value" error is returned (error code 400006). A validation error is returned whenever there is a data validation error regarding one of the following required fields: username, password, securityQuestion, secretAnswer, email. The expected next step is: call the API method again with the missing info.