Loan Labels

Get loan labels

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
createdBefore
string <date-time>

Returns loan labels created before a specific timestamp. If used in conjunction with createdAfter, a time range can be created to return labels created between two timestamps.

createdAfter
string <date-time>

Returns loan labels created before a specific timestamp. If used in conjunction with createdBefore, a time range can be created to return labels created between two timestamps.

loanId
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Filter by Loan's unique identifier. Can be Peach or lender's external identifier.

Responses
200

Success

get/companies/{companyId}/loan-labels
Response samples
application/json
{
  • "status": 0,
  • "total": 0,
  • "count": 0,
  • "nextUrl": "string",
  • "previousUrl": "string",
  • "data": [
    ]
}

Create loan label

Creates a new loan label.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
required
externalId
string or null [ 1 .. 50 ] characters

A lender's identifier for an object.

After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object.

To fetch the object using externalId you need to add ext- to the URL.

Note: Don't add ext- to the identifier value. For example: if the external identifier is ABCDE, then pass externalId=ACBCE and NOT ext-ABCDE when creating the object.

name
required
string

The name of the label. This is the name that will appear in the agent (and admin, if applicable) portals.

description
string

An optional description of the loan label. Typically used to store additional details or an explanation about the label. Not displayed in any user interfaces.

Responses
200

Success

post/companies/{companyId}/loan-labels
Request samples
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get loan label by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanLabelId
required
string

The ID of the loan label

Responses
200

Success

get/companies/{companyId}/loan-labels/{loanLabelId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update loan label

Updates a loan label.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
loanLabelId
required
string

The ID of the loan label

companyId
required
string

The unique company identifier.

Request Body schema: application/json
required
externalId
string or null [ 1 .. 50 ] characters

A lender's identifier for an object.

After the object is successfully created, a lender can use ID or externalId identifiers to fetch the object.

To fetch the object using externalId you need to add ext- to the URL.

Note: Don't add ext- to the identifier value. For example: if the external identifier is ABCDE, then pass externalId=ACBCE and NOT ext-ABCDE when creating the object.

name
string

The name of the label. This is the name that will appear in the agent (and admin, if applicable) portals.

description
string

An optional description of the loan label. Typically used to store additional details or an explanation about the label. Not displayed in any user interfaces.

Responses
200

Success

put/companies/{companyId}/loan-labels/{loanLabelId}
Request samples
application/json
{
  • "externalId": "string",
  • "name": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete loan label

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanLabelId
required
string

The ID of the loan label

Responses
204

Success

delete/companies/{companyId}/loan-labels/{loanLabelId}

Get loans by loan labels

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanLabelIds
required
Array of strings <= 100 items

The IDs of the loan labels

Responses
200

Success

get/companies/{companyId}/loan-labels/{loanLabelIds}/loans
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Add labels to loans

Adds loans to the specified labels.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanLabelIds
required
Array of strings <= 100 items

The IDs of the loan labels

Request Body schema: application/json
required
loanIds
Array of strings <= 100 items

The unique identifier of the loans. Can be Peach or lender's external identifier.

Responses
204

Success

put/companies/{companyId}/loan-labels/{loanLabelIds}/loans
Request samples
application/json
{
  • "loanIds": [
    ]
}

Remove labels from loans

Remove loans from the specified labels.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanLabelIds
required
Array of strings <= 100 items

The IDs of the loan labels

Request Body schema: application/json
required
loanIds
Array of strings <= 100 items

The unique identifier of the loans. Can be Peach or lender's external identifier.

Responses
204

Success

put/companies/{companyId}/loan-labels/{loanLabelIds}/loans/remove
Request samples
application/json
{
  • "loanIds": [
    ]
}

Request sandbox access