users

Create a new user

[Protected by the users_create scope] This endpoint is used to create a user. A user needs to be logged-in to use the endpoints available in this API (exception : providers).

post/users

Request

  • Base URL: https://api.linxo.com/v2
  • URL: https://api.linxo.com/v2/users
  • Auth: OAuth (defined in the document in a form this page cannot read)

Headers

Authorizationstring

Provided Bearer token following the format: 'Bearer xxxxxxxxx'

Request body

emailstring required

The email of the user

passwordstring required

At least 6 characters, with both a letter and a number

first_namestring

The first name of the user

last_namestring

The last name of the user

gender'MALE' | 'FEMALE'

The gender of the user

postcodestring

The postcode of the user. DEPRECATED : Now located under the address field !

birthdatestring date

Date of the user's birth as UTC timestamp in seconds

professionstring

The profession of the user

marital_status'SINGLE' | 'MARRIED'

The marital status of the user

residence'OWNER' | 'SINGLE_RENTER' | 'MULTIPLE_RENTER' | 'OTHER'

The residential situation of the user

citystring

The city of the user. DEPRECATED : Now located under the address field !

city_of_birthstring

User's city of birth

country_of_birthstring

User's country of birth

Response

User successfully created. The unique identifier of the user can be found in Location header (eg: Location: /users/1234)

Changes

No recorded changes to this operation across all 1 revision of this API.