register

v1.0.0

Registration, when successful, will return an array of access tokens so the user is immediately signed in.

It returns Catalog and Commerce scoped tokens for both Account and Profile. The Commerce ones are intended to allow the purchase of a subscription plan in the step after registration, without the user being prompted to enter their username and password again.

An email will also be sent with a link they need to click to confirm their email address. This confirmation is done via the /verify-email endpoint.

Input

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "ff": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "all",
          "idp",
          "ldp",
          "hb",
          "rpt",
          "cas",
          "lrl",
          "cd"
        ]
      }
    },
    "firstName": {
      "type": "string"
    },
    "lang": {
      "type": "string"
    },
    "languageCode": {
      "type": "string",
      "description": "The code of the preferred language for the primary profile.\nMust be a valid ISO language code e.g. \"en-US\" and must match the code of\none of the languages specified in the app config.\nSee https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\n"
    },
    "lastName": {
      "type": "string"
    },
    "marketing": {
      "type": "boolean",
      "description": "Whether to receive marketing material or not. Default to true."
    },
    "password": {
      "type": "string"
    },
    "pin": {
      "type": "string",
      "description": "The primary account pin."
    },
    "segments": {
      "type": "array",
      "description": "The segments to apply to the primary profile.",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "email",
    "password"
  ],
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "value",
      "refreshable",
      "expirationDate",
      "type"
    ],
    "properties": {
      "accountCreated": {
        "type": "boolean",
        "description": "When a `UserAccount` token is issued during a single-sign-on flow\na user may have been automatically registered if they didn't\nhave an account already. If this occurs then `accountCreated`\nwill be `true`.\n"
      },
      "expirationDate": {
        "type": "string",
        "format": "date-time",
        "description": "The timestamp this token expires."
      },
      "refreshable": {
        "type": "boolean",
        "description": "True if this token can be refreshed, false if not."
      },
      "type": {
        "type": "string",
        "description": "The type of the token.",
        "enum": [
          "UserAccount",
          "UserProfile"
        ]
      },
      "value": {
        "type": "string",
        "description": "The token value used for authenticated requests."
      }
    },
    "additionalProperties": false
  },
  "additionalProperties": false
}