Skip to main content
POST
/
api
/
v1
/
auth
/
signup
Create a new User
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    authEmail: 'jsmith@example.com',
    otp: '<string>',
    referralCouponCode: '<string>',
    marketingCampaign: '<string>',
    partnerId: '<string>'
  })
};

fetch('https://api.valox.co/api/v1/auth/signup', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "<string>",
  "token": "<string>",
  "hasSignedUp": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
authEmail
string<email>
required

Email address for the new user

​
otp
string

One-time password for email verification (optional during transition period)

Required string length: 6
​
referralCouponCode
string

Referral coupon code for the new user

​
marketingCampaign
string

Marketing campaign identifier

​
partnerId
string

Optional ID of the partner that referred the user

Response

User was created successfully

​
id
string
required

Unique identifier of the created user

​
token
string
required

JWT token for authentication

​
hasSignedUp
boolean
required

Indicates if the user has completed signup