User account

The user account endpoints are used to register and verify Bloom user accounts, and to reset passwords.

Register user

Registering a user is the first step in creating a Bloom account. After registering a new account, the user will receive an email with a link to verify their email address, which includes a new user verification token.

The verification token must be verified using the verify endpoint before the user can log in to their account. The verification token is valid for 72 hours.

POST /user/register

{
  "email": "user@example.com",
  "password": "examplePassword123!",
  "meta": {
    "name_first": "Jon",
    "name_last": "Doe"
  }
}

Fields

• email
  required string
  Email address of the user.
• password
  required string
  Password for the user account. The password must meet the following requirements:

  • Minimum length of 12 characters
  • Contain at least one lowercase letter
  • Contain at least one uppercase letter
  • Contain at least one number
• meta.name_first
  required string
  First name of the user.
• meta.name_last
  required string
  Last name of the user.

Response

Verification request

The verification request endpoint is used to request a new user verification token if not received when registering a new user account.

Verification requests can be made no more than once every 3 minutes for a given email address.

POST /user/verification-request

{
  "email": "user@example.com"
}

Fields

• email
  required string
  Email address of the user.

Response

Verify

The verify endpoint is used to verify a new email address using a valid user verification token.

POST /user/verify

{
  "email": "user@example.com",
  "token": "USER_VERIFICATION_TOKEN"
}

Fields

• email
  required string
  Email address of the user.
• token
  required string
  User verification token provided from the register user or verification request endpoints.

Response

Password reset request

The password reset request endpoint is used to request a password reset for an existing user account. After requesting a password request, the user will receive an email with a password reset token if an active user account exists with the given email address. This token can be used with the password reset endpoint.

Password requests can be made no more than once every 3 minutes for a given email address. Emailed password reset tokens are valid for 15 minutes.

POST /user/password-request

{
  "email": "user@example.com"
}

Fields

• email
  required string
  Email address of the user.

Response

Password reset

The password reset endpoint is used to reset the password for an existing user account using a valid password reset token provided from the password reset request endpoint.

POST /user/password

{
  "email": "user@example.com",
  "password": "examplePassword123!",
  "token": "PASSWORD_RESET_TOKEN"
}

Fields

• email
  required string
  Email address of the user.
• password
  required string
  Password for the user account. The password must meet the following requirements:

  • Minimum length of 12 characters
  • Contain at least one lowercase letter
  • Contain at least one uppercase letter
  • Contain at least one number
• token
  required string
  Password reset token provided from the password reset request endpoint.

Response