Skip to main content
POST
Create User

Authorizations

Authorization
string
header
required


You can register for a new Lendflow API key on our client portal in less than 60 seconds. The Bearer Token needs to be included in all API requests made to the API Service in the following form:

Authorization: Bearer [YOUR_TOKEN]
You must replace [YOUR_TOKEN] with your personal API key.

Body

application/json
first_name
string
required
Example:

"architecto"

last_name
string
required
Example:

"architecto"

email
string
required

Must be a valid email address.

Example:

"zbailey@example.net"

roles
object
required

Must match an existing stored value.

Example:
permissions_preset_id
string

Provide a permissions preset id if the user is assigned to a specific published permissions preset. Must match an existing stored value.

Example:

null

assigned_client_ids
object | null

Provide client IDs if the user is assigned to specific clients. This cannot be provided for users tied to a client, or when using a specified preset. Must match an existing stored value.

Example:

null

assigned_workflow_template_ids
object | null

Provide workflow template IDs if the user is assigned to specific workflow templates.This cannot be provided when using a specified preset.

Example:

null

client_id
string

Provide client id if the new user is under the client. Must match an existing stored value.

Example:

null

funder_id
string

Provide funder id if the new user is under the funder. Must match an existing stored value.

Example:

null

funder_contact_role
enum<string>
Available options:
manager,
sales_rep,
underwriter
Example:

"underwriter"

responsible_for_products
object

Must match an existing stored value.

Example:

null

phone
string | null
Example:

null

Must be a valid URL.

Example:

"http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html"

Response

200 - application/json
data
object