Create a user

post

https://au-api.basiq.io/users

Creates a new Basiq user object

Body Params

string

The end-users email address. Mandatory if mobile is not supplied.

mobile

string

The end-users mobile number, supplied in international format. +[country-code][mobileno]. Mandatory if email is not supplied.

firstName

string

The end-users first name as an optional additional parameter.

middleName

string

The end-users middle name as an optional additional parameter.

lastName

string

The end-users last name as an optional additional parameter.

businessName

string

The official name of the business.

businessIdNo

string

This number is used to identify a business when they’re dealing with the government, other businesses, and the public.

businessIdNoType

string

enum

Type of business ID could be ABN Or ACN.

Allowed:

businessAddress

object

verificationStatus

boolean

Indicates if the business information provided is verified against the Australian Business Register.

verificationDate

string

when the verification was done.

Responses

Language

Credentials

Bearer

JWT

Response

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

application/json

201Returns the user object if the creation succeeded.

400Returns error that server cannot or will not process the request due to something that is perceived to be a client error.

401Error status response code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

403Error that access is forbidden and tied to the application logic, such as insufficient rights to a resource.

404Returns error indicating that server can't find requested resource.

500Returns error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.