Skip to main content

Create a user

POST 
/api/users

Create a user in the Ownli System. This method requires the caller to pass the user attributes. If a user with the same email or cell phone exists return an error.

Request​

Query Parameters

    returnExistingUserIfExists boolean

    Return the user object if a user matching the email or phone number exists. Default behavior is to return an error.

    Example: true

Header Parameters

    partnerId stringrequired

    Partner Id

    clientId stringrequired

    Client Id

    clientSecret stringrequired

    Client Secret

Body

required

    firstName stringrequired

    User's First Name. (Required)

    lastName stringrequired

    User's Last Name. (Required)

    email string

    User's Email.

    phone stringrequired

    Cell Phone Number of the User. The phone number should be in the E.164 format +15556667777 (Required)

    address

    object

    required

    Address

    addressLine1 string

    Street Address

    addressLine2 string
    city string

    City

    state stringrequired

    2 Letter State Code (eg. AL, CA, CO etc.

    country string

    2 Letter Country Code. Must be US.

    zip string

    Zipcode

Responses​

The created user object.

Schema

    id string

    Unique Id for the user

    firstName string

    User's first name

    lastName string

    User's last name

    email string

    User's email address

    phone string

    User's cell phone number

    address

    object

    Address

    addressLine1 string

    Street Address Line 1

    addressLine2 string

    Street Address Line 2

    city string

    City

    state string

    2 Letter State Code

    country string

    2 Letter Country Code

    zip string

    Zip

    tosAnswer string

    Possible values: [None, Accepted, Declined]

    User's answer to terms of service for sharing data with Partner. (Only valid for certain partners)

    partnerCode string

    A code generated for the user to share with Partner. (Only valid for certain partners)

    dateRegistered string

    Time at which user was registered on the system

    updated string

    Last updated timestamp

Loading...