Schedule a pilot

Validate a scorecard before putting it on a program

POST/api/v1/credit/scorecards/validate

The framework for the partner's underwriting scorecard (§9.4). Checks the criteria shape and reports which keys DayZero can measure today. Unmeasured keys are allowed and report as unmeasured on every assessment; a required unmeasured key means an assessment can never pass, so it is called out. Nothing is saved: put the scorecard on the program with PATCH /credit/programs/{id} (underwriting_criteria), or author it as a version under /credit/programs/{id}/scorecards. messages addresses each finding to its row and field; pass strict: true for the rules a version must meet to be approved.

Operation ID: validate_scorecard·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: ScorecardValidateRequest

underwriting_criteriaarray · objectrequired

Criteria items: key, comparator (gte, lte, gt, lt, eq, between), threshold (number, [low, high] for between, or {"basis": "requested_limit", "value": 0.5} for a multiple of the requested limit), optional label, unit, weight, required (true, false, or a condition such as {"when": "requested_limit", "op": "gt", "value": 100000}), applies_when, segments.

manual_checksarray · object

Manual checks to validate alongside the criteria.

grade_bandsarray · object
scoringobject
strictboolean

Apply the rules a scorecard version must meet to be approved: a required criterion nothing can measure, and a unit that disagrees with its measurer, become errors instead of warnings.

Responses

201Successful Response

Schema: SuccessEnvelope_ScorecardValidateResponse_

successboolean
messagestring
codestring
dataScorecardValidateResponse

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.

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.