API Reference

Submits the one-time passcode (OTP) to retreive an API access token

Log in to see full request history

📘

Log a user into the Noba platform

Noba leverages a one-time passcode (OTP) for secure login. The OTP returned from the https://api.noba.com/v1/auth/login endpoint is submitted via this endpoint to receive an access token.

Noba's partners may only use the "CONSUMER" identityType, as "PARTNER_ADMIN" and "NOBA_ADMIN" identity types are restricted to Noba administrators.

🚧

Email-only login

Currently, Noba supports login only via email. However, a forthcoming release will allow login via phone number to improve the user experience for mobile-first users.

Body Params
string

Email or phone value to identify the user

string

This attribute is deprecated and will be removed in future, please use emailOrPhone instead

string
required

Identity type of the user logging in

number
required

One-time password sent to email or phone

Headers
string
required
string
string

Timestamp in milliseconds, use: new Date().getTime().toString()

Responses

401

Invalid OTP

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json