API spec

The Underwriting API provides comprehensive endpoints for float and loan eligibility evaluation, profile management, and evaluation history.

All endpoint documentation, request/response examples, and behavioral details are included in the interactive API explorer below.

Error responses

All non-2xx responses share the Error schema. Alongside the long-standing code (integer) and message (string) fields, error responses now carry two additive fields:

Field Type Description

status_code

integer

Duplicate of code going forward. Lets consumers migrate off code in a later release.

error_code

string enum (GenericErrorCode)

Machine-readable failure category: INVALID_CALLER, UNEXPECTED_ERROR, ENTITY_NOT_FOUND, INVALID_REQUEST_BODY.

status_code and error_code are additive — existing consumers that parse only code/message are unaffected. Both the old and new fields are populated on every error response.

Framework-level validation failures that happen before a handler runs also return this same JSON Error shape (not a plaintext body):

  • A missing or malformed path/query parameter (for example, amount absent or non-integer) returns 400 with error_code: INVALID_CALLER.

  • An undecodable request body returns 400 with error_code: INVALID_REQUEST_BODY.

See Also