Skip to main content
POST
/
v1
/
members
cURL
curl --request POST \
  --url https://api.onsi.com/v1/members \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "jane-smith@onsi.com",
  "firstName": "John",
  "lastName": "Smith",
  "tier": "Gold",
  "phone": "+447123456789",
  "workerId": "ID_123",
  "accountDetails": {
    "accountHolder": "John Smith",
    "sortCode": "123456",
    "accountNumber": "12345678"
  },
  "enablePayroll": true,
  "dob": "1990-01-01",
  "gender": "Female"
}
'
{
  "email": "jsmith@example.com",
  "memberId": "mem_q5sdae3se6eg9m9dcvug",
  "firstName": "John",
  "lastName": "Smith",
  "phone": "+447123456789",
  "tier": "Gold",
  "workerId": "ID_123",
  "status": "active",
  "accountDetails": {
    "accountHolder": "John Smith",
    "sortCode": "123456",
    "accountNumber": "12345678"
  },
  "enablePayroll": true,
  "dob": "1990-01-01",
  "gender": "Female"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onsi.com/llms.txt

Use this file to discover all available pages before exploring further.

This invites a new member to your platform, when they are created they will have the status of invited, if their email already has an associated Onsi account their status will go straight to active.

​
Relevant Error Codes

If there are any issues with the member add, the API will return a 400 status code with the following error codes:

Authorizations

​
x-api-key
string
header
required

Headers

​
x-idempotency-key
string

Unique key to ensure idempotency of the request

Body

application/json

Body

​
email
string<email>
required

A unique email address for the member

Pattern: ^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$
Example:

"jane-smith@onsi.com"

​
firstName
string
required
Example:

"John"

​
lastName
string
required
Example:

"Smith"

​
tier
string
required

Tier name for the member

Example:

"Gold"

​
phone
string

An optional phone number for the member

Example:

"+447123456789"

​
workerId
string

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

Example:

"ID_123"

​
accountDetails
BankAccountUK · object

A UK bank account

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

Date of birth of the member, must later than 1900

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"1990-01-01"

​
gender
enum<string> | null

Gender of the member

Available options:
Female,
Male,
NonBinary

Response

201 - application/json

A member on the platform.

A member on the platform.

​
email
string<email>
required
Pattern: ^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$
​
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
BankAccountUK · 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

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"1990-01-01"

​
gender
enum<string> | null

Gender of the member

Available options:
Female,
Male,
NonBinary