Workflows

Get case workflow

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

personId
required
string^ext-|^[A-Z]{2}-[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^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The case object unique indentifier.

Responses
200

OK

get/companies/{companyId}/people/{personId}/cases/{caseId}/workflow
Response samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "workflowTypeId": "string",
  • "name": "string",
  • "description": "string",
  • "approvalConditions": [
    ],
  • "completedAt": "2019-08-24T14:15:22Z",
  • "steps": [
    ]
}

Update workflow step status

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

personId
required
string^ext-|^[A-Z]{2}-[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^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The case object unique indentifier.

workflowStepId
required
string

The workflow step ID

Request Body schema: application/json
status
string
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^ext-|^[A-Z]{2}-[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^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The case object unique indentifier.

workflowStepId
required
string

The workflow step ID

workflowWorkitemId
required
string

The workflow work item ID

Request Body schema: application/json
status
string
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"
}