A member is the core entity in the Onsi platform, they are the end users who you invite to the platform. You should manage members via the Member Management API

A member on the platform.

​
email
string<email>
required
​
memberId
string
required

Onsi's ID of the member

Example:

"mem_q5sdae3se6eg9m9dcvug"

​
firstName
string
required
Example:

"John"

​
lastName
string
required
Example:

"Smith"

​
phone
string | null
required
Example:

"+447123456789"

​
tier
string
required

Tier name for the member

Example:

"Gold"

​
workerId
string | null
required

Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)

Example:

"ID_123"

​
status
enum<string>
required

The status of the member.

Available options:
active,
invited,
inactive
​
accountDetails
object
required

A UK bank account

Example:
{
  "accountHolder": "John Smith",
  "sortCode": "123456",
  "accountNumber": "12345678"
}
​
enablePayroll
boolean
required
Example:

true

​
dob
string | null
required

Date of birth of the member, must later than 1900 Date in ISO8601 YYYY-MM-DD format

Example:

"1990-01-01"

​
gender
enum<string> | null

Gender of the member

Available options:
Female,
Male,
NonBinary