Skip to content
Open appSchedule a pilot

Request an underwriting assessment

POST/api/v1/credit/underwriting/assessments

Returns a pending assessment. Bank backfill, categorisation, and trailing-ratio history can take up to three days, so callers must not assume a synchronous answer — poll the get endpoint or subscribe to the completion event. While it waits, waiting_on names the data still landing and wait_deadline when the sweep completes it regardless. We return evidence; the lending decision stays the partner's. The assessment is measured against the active version of the program's scorecard unless scorecard_version_id names another, and records which one. Send requested_limit_cents: rules written as a multiple of the limit report unmeasured without it. An unknown program_id is 404; a program with no active scorecard (and no scorecard_version_id or criteria_override in the request) is 409 CREDIT_POLICY_UNDECIDED.

Operation ID: request_underwriting_assessment·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: UnderwritingAssessmentRequest

credit_line_idstring
external_application_idstring
program_idstring
criteria_overridearray · object

Evaluate against these instead of the program's scorecard. The assessment records them as an ad-hoc snapshot rather than a scorecard version.

scorecard_version_idstring

Assess against this scorecard version. Defaults to the active version of the program's default scorecard.

requested_limit_centsinteger

The limit being applied for, in cents. Rules written as a multiple of the limit, or that apply only in a limit band, report unmeasured (requested_limit_missing) without it.

requested_term_daysinteger

The term being applied for.

subject_business_idstring

The business whose data is measured. Defaults to the line's merchant_business_id, else the business in x-business-id. Must be a business the caller can access.

Responses

201Successful Response

Schema: SuccessEnvelope_UnderwritingAssessmentResponse_

successboolean
messagestring
codestring
dataUnderwritingAssessmentResponse

400Bad Request - Invalid input

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

404Not Found - Resource does not exist

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

409Conflict - Resource already exists or is in an incompatible state

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired

Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.

messagestringrequired

Human-readable explanation, safe to show to end users.

codestringrequired

Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).

request_idstring

Correlation id for support requests. Echoes the x-request-id request header when one was supplied.

errorsobject

Field-level validation messages keyed by field name. Present on 400/422 validation failures only.