Update an Exception

You can update an exception’s status and assign a user to the exception.

Endpoint

PATCH /exceptions/{exceptionId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

exceptionId REQUIRED

string (UUID)

ID of the exception.

Request Body

assignedTo

object

User that the exception is assigned to.

string (UUID)

User’s ID.

firstName

string, min length:1, max length: 40

User’s first name.

lastName

string, min length:1, max length: 40

User’s last name.

string (email)

User’s email address.

status

string, enum values: NEW, IN_PROGRESS, RESOLVED, REOPENED

Current status of the exception. The following values are supported:

NEW Exception has been created.
IN_PROGRESS Exception has been assigned to a user.
RESOLVED Exception has been resolved. The exception record can no longer be modified.
REOPENED A RESOLVED exception has been reopened.

Returns

Returns the Exception object. This object contains the exception details, such as the type of exception, the exception status, and the user that the exception is assigned to.

SAMPLE REQUEST

				
					{
  "assignedTo": {
    "id": "a22b9df2-49eb-4c54-a93d-13d045e8a019",
    "firstName": "Jack",
    "lastName": "Smith",
    "email": "jsmith@abc.com"
  },
  "status": "IN_PROGRESS"
}

SAMPLE RESPONSE

				
					{
  "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"
}