Retrieve all exceptions. You can filter the results based on criteria such as the exception status, type, and category. You can also sort the results and limit the number of results returned.
Note Exceptions will be retrieved for the Business Account associated with the request access token.
GET /exceptions
Authorization: Bearer <access_token>
createdDateFrom
string (date-time)
Date the exception was created in the RocketKOR system. This filter will return transactions created on or after this date.
Note The date is interpreted using the time zone specified in the timeZone filter. UTC format is used if timeZone is not provided.
createdDateTo
string (date-time)
Date the exception was created in the RocketKOR system. This filter will return transactions created on or before this date.
Note The date is interpreted using the time zone specified in the timeZone filter. UTC format is used if timeZone is not provided.
timeZone
string (timeZone), default value: UTC
Time zone for the createdDateFrom and createdDateTo filters. The following values are supported:
assignedTo
array of strings (UUID)
UUID of one or more users that exceptions are assigned to. To find unassigned exceptions, use the value UNASSIGNED.
category
string, enum values: BANK_ACCOUNT_VERIFICATION, CUSTOMER | TRANSACTION
Exception category. The following values are supported:
type
string, enum values: ACH_RETURN, ACH_NOC, BANK_ACCOUNT_VERIFICATION_DECLINED, BANK_ACCOUNT_VERIFICATION_NOC, EARNED_WAGE_ACCESS, RECONCILIATION
Type of exception. The following values are supported:
status
array of strings
Current status of the exception. The following values are supported:
sort
array of strings
Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.
page
integer (int32)
Page number to return, based on zero-based page indexing.
size
integer (int32)
Maximum number of results to return per page.
None
Returns a paginated response with an array of Exception objects.
SAMPLE RESPONSE
{
"totalElements": 3,
"totalPages": 1,
"number": 0,
"numberOfElements": 3,
"hasNext": false,
"content": [
{
"id": "52320ec1-3ccb-46db-9811-d3601c544676",
"entityId": "93bccda2-6741-4ce2-b65e-4e8e0415d0ec",
"businessAccountId": "233fcff1-caab-4ed2-a125-275e14f6d22b",
"assignedTo": {
"id": "a22b9df2-49eb-4c54-a93d-13d045e8a019",
"firstName": "Jack",
"lastName": "Smith",
"email": "jsmith@abc.com"
},
"category": "BANK_ACCOUNT_VERIFICATION",
"type": "BANK_ACCOUNT_VERIFICATION_DECLINED",
"notes": {
"id": "edc7f1fa-d625-4f6b-a550-05b4a7a34d06",
"entityId": "ab520487-407b-4ac5-b6d9-1b76a9fb3097",
"entityType": "FINANCIAL_ACCOUNT",
"title": "verification",
"contentText": "Verification required",
"businessAccountId": "fb440de4-246b-4116-a8b5-3bd71ec9827f",
"createdBy": {
"id": "b00c9272-8173-45b6-84ad-ca1c3bab9975",
"type": "employee"
},
"createdAt": "2025-03-30T15:33:21.390Z",
"updatedBy": {
"id": "b00c9272-8173-45b6-84ad-ca1c3bab9975",
"type": "employee"
},
"updatedAt": "2025-03-31T15:33:21.390Z"
},
"status": "IN_PROGRESS",
"description": "need to resubmit verification",
"createdBy": {
"id": "3dd45b73-d3d8-4861-8109-50e0e227991a",
"type": "employee"
},
"createdAt": "2025-04-02T15:33:21.390Z",
"updatedBy": {
"id": "3dd45b73-d3d8-4861-8109-50e0e227991a",
"type": "employee"
},
"updatedAt": "2025-04-03T15:33:21.390Z"
},
{...},
{...}
]
}
Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.
A Rocket Financial Inc. company
@ 2024 RocketKOR, Inc. All rights reserved.
