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 identifier.

Responses

200

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": [{"stepTypeRefId": "fc6c461a-62df-4868-a501-42351cf66c89",
"stepStatus": "due"
}
],
"completedAt": "2019-08-24T14:15:22Z",
"steps": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"workflowId": "string",
"workflowStepTypeId": "string",
"completedAt": "2019-08-24T14:15:22Z",
"skippedAt": "2019-08-24T14:15:22Z",
"descriptionShort": "string",
"descriptionLong": "string",
"decisionQuestion": "string",
"decisionQuestionType": "yesNo",
"mandatory": true,
"visibility": "normal",
"status": "due",
"updatedBy": "string",
"workItems": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"workflowStepId": "string",
"workflowWorkitemTypeId": "string",
"descriptionShort": "string",
"descriptionLong": "string",
"completedAt": "2019-08-24T14:15:22Z",
"skippedAt": "2019-08-24T14:15:22Z",
"status": "due",
"updatedBy": "string",
"history": [{"time": "2019-08-24T14:15:22Z",
"user": 0,
"status": "string"
}
]
}
],
"history": [{"time": "2019-08-24T14:15:22Z",
"user": 0,
"status": "string"
}
]
}
]
}

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 identifier.
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

Payload

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 identifier.
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

Payload

application/json

{"status": "due"
}

➔ Next to Workflow Types