Confirm user email

​

Confirm email and set password for new user invitation. First name and last name are required but may have been pre-populated at invite time. If names were provided during invite, they can be omitted here (or overridden with new values).

Path Parameters
  • id
    Type: stringFormat: uuid
    required

    User ID

Body
required
application/json
  • password
    Type: string
    min length:  
    12
    max length:  
    50     Pattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[`!@#$%^&*()_+\-=\[\]{};':"\\|,.<>/?~])(?!.*\s).{12,50}$Format: password
    required

    Password must meet complexity requirements:

    • Between 12 and 50 characters
    • No spaces allowed
    • At least one uppercase letter (A-Z)
    • At least one lowercase letter (a-z)
    • At least one number (0-9)
    • At least one special character (no space)
  • token
    Type: string
    required

    Password reset token from email

  • firstName
    Type: string

    Optional if pre-populated at invite time. Required otherwise.

  • lastName
    Type: string

    Optional if pre-populated at invite time. Required otherwise.

Responses
  • application/json
Request Example for post/users/{id}/confirm-email
curl https://api.gpcn.com/v1/users/123e4567-e89b-12d3-a456-426614174000/confirm-email \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "",
  "password": "",
  "firstName": "",
  "lastName": ""
}'

{
  "success": true,
  "message": "Your password has successfully been set.",
  "data": {
    "message": "Your password has successfully been set."
  },
  "meta": null
}

Email confirmed successfully