API Reference

Create new user

post
https://connect-sandbox.onehub.global/users

Create a new user on the Benifex platform

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the user to create

string
required
length ≤ 100

User's first name.

string
required
length ≤ 100

User's surname.

date
required

User's date of birth.

string

This is an individual's personal title and will vary depending on age, gender and married status.

string

User's preferred name. Used for personalised notifications and emails.

string

Full name in local language

string

Private phone number

address
object
required
string
required
length ≤ 100

User's email address.

string
enum
required

User's gender. Only allowable values are Male, Female, Undefined, Unknown.

Allowed:
string
enum

Dependant's nationality.

string

User's preferred language used in countries where there are multiple official languages e.g. Belgium Switzerland, Canada Must be a valid ISO 639-2 language code (three-letter format).

string
enum
required

Used internationally to determine eligibiity to e.g. add family members to medical cover. Only allowable values are Single, Married, Widowed, and Unknown.

Allowed:
date

The date the user's marital status was updated. This date needs to be reported to some providers

employment
object
required

The employment details of the user

nationalIdentity
object
required
customAttributes
object

Arbitrary customer-specific key-value pairs.

Headers
string

An id that uniquely identifies the request. If added, this will aid any request debugging and can be used for idempotency checks

Responses

Updated 10 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago