Take an underwriting action

Approves, declines, requests documents for, or withdraws the application, as the dashboard's status update does. Live keys only: a key without live_ gets a 400.

  • outcome_id is required for approve and decline when your tenant has any active outcome of that kind (Approve outcomes for approve; Decline, Identity Decline or Credit Decline outcomes for decline), and the outcome must be of that kind. For request_docs and withdraw any of your outcomes can be passed.
  • decline, request_docs and withdraw set the stage directly (Declined 2, Document 3, Withdrawn 6). approve resets the application to Processing and continues its flow (offer and contract steps), so the returned stage is wherever the flow ends up, 1 (Approved) when it completes.
  • note is added to the application's notes. The matching application.approved / application.declined / application.request_docs / application.withdrawn webhook is queued; for approve only if the application ends up approved.
  • outcome in the result is the outcome name, or null. completed is unchanged by request_docs.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The application's session UUID (the session value, not the numeric app_id). A value that is not a UUID does not match the route.

Body Params
string
enum
required
Allowed:
integer | null

One of your outcomes (see Underwriting summary). Required for approve/decline when you have matching active outcomes.

string

Added to the application's notes.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json