You are viewing the latest API docs through the legacy docs viewer. The modern viewer can be found here: https://docs.peachfinance.com/api-docs.
Peach Finance

Users

Get users

Securityoauth2 or bearerAuth or apiKeyHeader
Request
query Parameters
sortBy
Array of strings

The data attributes by which to sort the results.

userType
string

User type.

limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

Responses
200

Success

get/users
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Create user

Creates a user.

authType.email or authType.phone is required depending on company configuration.

authType.password is required unless the company is configured to OneTimeCodeEmail or OneTimeCodeText in which case sends an empty string.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
Request Body schema: application/json
required
externalId
string or null
status
string
Enum: "active" "inactive"
type
string

The type of user to create:

  • borrower - This user allows a borrower to log in to the system.
  • agent - This user allows an agent to log in to the system.
  • service - This user is used in conjunction with an API key to perform background tasks.
Enum: "borrower" "agent" "service"
roleIds
Array of strings or null

List of role IDs associated with this user.

userType
string

DEPRECATED ATTRIBUTE Use type.

Enum: "borrower" "agent" "service"
roles
Array of strings or null

DEPRECATED ATTRIBUTE Use roleIds.

List of role IDs to associate with this user upon creation.

associatedPersonId
string or null

DEPRECATED ATTRIBUTE Use borrowerId.

The ID of the borrower to be associated with this user. Only applicable when userType is set to borrower.

borrowerId
string or null

The ID of the borrower to be associated with this user. Only applicable when userType is set to borrower.

object
Responses
201

Success

post/users
Request samples
application/json
{
  • "externalId": "string",
  • "status": "active",
  • "type": "borrower",
  • "roleIds": [
    ],
  • "userType": "borrower",
  • "roles": [
    ],
  • "associatedPersonId": "string",
  • "borrowerId": "string",
  • "authType": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get user

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
userId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Unique user identifier.

Responses
200

Success

get/users/{userId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update user

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
userId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Unique user identifier.

Request Body schema: application/json
required
externalId
string or null
status
string
Enum: "active" "inactive"
type
string

The type of user to create:

  • borrower - This user allows a borrower to log in to the system.
  • agent - This user allows an agent to log in to the system.
  • service - This user is used in conjunction with an API key to perform background tasks.
Enum: "borrower" "agent" "service"
roleIds
Array of strings or null

List of role IDs associated with this user.

userType
string

DEPRECATED ATTRIBUTE Use type.

Enum: "borrower" "agent" "service"
roles
Array of strings or null

DEPRECATED ATTRIBUTE Use roleIds.

List of role IDs to associate with this user upon creation.

associatedPersonId
string or null

DEPRECATED ATTRIBUTE Use borrowerId.

The ID of the borrower to be associated with this user. Only applicable when userType is set to borrower.

borrowerId
string or null

The ID of the borrower to be associated with this user. Only applicable when userType is set to borrower.

Responses
200

Success

put/users/{userId}
Request samples
application/json
{
  • "externalId": "string",
  • "status": "active",
  • "type": "borrower",
  • "roleIds": [
    ],
  • "userType": "borrower",
  • "roles": [
    ],
  • "associatedPersonId": "string",
  • "borrowerId": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}
➔ Next to Investors

Request sandbox access