/api/applications/{applicationId}/request-information

POST /api/applications/{applicationId}/request-information

Request additional information from applicant

Sends a request for additional information to the applicant via email. This endpoint will:

Update the application status to PENDING_INFORMATION
Send a branded email to the applicant with the request details
Log the activity in underwriting activity log
Create a note visible to both internal and external users

Requires writeUnderwriting permission.

Required Parameters

applicationId path string

The unique ID of the application

{
  "subject": "Additional Bank Statements Required",
  "message": "We need your last 3 months of bank statements to complete our underwriting review. Please upload them to your application portal."
}

{
  "subject": "Additional Bank Statements Required",
  "message": "We need your last 3 months of bank statements to complete our underwriting review. Please upload them to your application portal.",
  "requestedItems": [
    "string"
  ]
}

Try it out

Output:

Responses

Description

Information request sent successfully

{
  "success": true,
  "message": "Information request sent successfully",
  "data": {
    "applicationId": "APP-2024-001",
    "newStatus": "PENDING_INFORMATION",
    "emailSentTo": "merchant@example.com"
  }
}

Description

Bad request - validation error or invalid state transition

{
  "error": "Cannot request information from application in 'DECLINED' state"
}

Or the swagger.yaml spec this documentation was generated from: /applications/[applicationId]/request-information/swagger.yaml