Peach Finance

Workflows

Get case workflow

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

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

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

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

The case object unique identifier.

Responses
200

OK

get/companies/{companyId}/people/{personId}/cases/{caseId}/workflow
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update workflow step status

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

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

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

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

The case object unique identifier.

workflowStepId
required
string

The workflow step ID

Request Body schema: application/json
required
status
string (WorkflowStepStatus)
Enum: "due" "approved" "rejected" "skipped"
Responses
204

No Content

put/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}
Request samples
application/json
{
  • "status": "due"
}

Update workflow workitem status

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

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

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

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

The case object unique identifier.

workflowStepId
required
string

The workflow step ID

workflowWorkitemId
required
string

The workflow work item ID

Request Body schema: application/json
required
status
string (WorkflowWorkitemStatus)
Enum: "due" "completed" "skipped"
Responses
204

No Content

put/companies/{companyId}/people/{personId}/cases/{caseId}/workflow/steps/{workflowStepId}/workitems/{workflowWorkitemId}
Request samples
application/json
{
  • "status": "due"
}
➔ Next to Workflow Types