Profile Signup

Send Signup Invitations

POST /(company_code)/v2/auth/invite

Invite to sign up profile

Allows authorized users to invite new users to sign up for profile creation. Email messages with signup links will be sent to supplied email addresses.

Signup links sent by authorized user with PARTNER role allow signup of USER role profiles. Signup links sent by authorized user with COMPANY role allow signup of EMPLOYEE role profiles.

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Request JSON Object:
 
  • primary_emails (array) – Primary email addresses for new profile
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • request.validation.failed

See Error Codes for details.

Sign Up Profile

POST /(company_code)/v2/auth/signup

Sign up for profile with invitation link

This endpoint verifies a token from invitation link sent to email and creates a new profile for user.

Signup links sent by authorized user with PARTNER role allow signup of USER role profiles. Signup links sent by authorized user with COMPANY role allow signup of EMPLOYEE role profiles.

If email address of invitation link is already used as primary identifier for a profile, returns profile.identifier.used error code.

If quality of supplied new password is too low, returns request.validation.failed error code with HTTP status code 422.

Request JSON Object:
 
  • token (string) – Token from invitation link sent to email address
  • captcha_response (string) – User captcha response token, as provided by Recaptcha
  • new_password (string) – New user password
Response JSON Object:
 
  • status (string) – success or error
  • error_code (string) – (Optional) If status is error: one of error codes listed below

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.expired
  • auth.token.invalid
  • auth.captcha.invalid
  • auth.restricted
  • profile.identifier.used
  • request.validation.failed

See Error Codes for details.