{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/underwriting/scorecard-vocabulary","version":"1.0.0","description":"What a scorecard may be written with"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/underwriting/scorecard-vocabulary":{"get":{"tags":["credit"],"summary":"What a scorecard may be written with","description":"Comparators, units, threshold bases, the facts a condition may test, scoring policies and manual-check statuses. An editor builds its controls from this, so it needs no change when one is added. `score_formula` states how `score_bps` is computed.","operationId":"get_scorecard_vocabulary","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScorecardVocabularyResponse_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"get_scorecard_vocabulary_api_v1_credit_underwriting_scorecard_vocabulary_get"}}},"components":{"schemas":{"ConditionFieldItem":{"properties":{"key":{"type":"string","title":"Key"},"label":{"type":"string","title":"Label"},"unit":{"type":"string","title":"Unit"}},"type":"object","required":["key","label","unit"],"title":"ConditionFieldItem"},"ScorecardVocabularyResponse":{"properties":{"comparators":{"items":{"$ref":"#/components/schemas/VocabularyItem"},"type":"array","title":"Comparators"},"units":{"items":{"$ref":"#/components/schemas/VocabularyItem"},"type":"array","title":"Units"},"threshold_bases":{"items":{"$ref":"#/components/schemas/ThresholdBasisItem"},"type":"array","title":"Threshold Bases"},"condition_fields":{"items":{"$ref":"#/components/schemas/ConditionFieldItem"},"type":"array","title":"Condition Fields"},"condition_ops":{"items":{"$ref":"#/components/schemas/VocabularyItem"},"type":"array","title":"Condition Ops"},"scoring_methods":{"items":{"$ref":"#/components/schemas/VocabularyItem"},"type":"array","title":"Scoring Methods"},"unmeasured_policies":{"items":{"$ref":"#/components/schemas/VocabularyItem"},"type":"array","title":"Unmeasured Policies"},"manual_check_statuses":{"items":{"$ref":"#/components/schemas/VocabularyItem"},"type":"array","title":"Manual Check Statuses"},"default_scoring":{"$ref":"#/components/schemas/ScoringPolicy"},"score_formula":{"type":"string","title":"Score Formula","description":"How `score_bps` is computed, in words."}},"type":"object","required":["comparators","units","threshold_bases","condition_fields","condition_ops","scoring_methods","unmeasured_policies","manual_check_statuses","default_scoring","score_formula"],"title":"ScorecardVocabularyResponse","description":"Everything a scorecard may be written with.\n\nAn editor builds its controls from this, so a new comparator, basis or\ncondition field needs no client change."},"ScoringPolicy":{"properties":{"method":{"type":"string","title":"Method","description":"How `score_bps` is computed. One method exists today.","default":"weighted_pass_ratio"},"unmeasured_policy":{"type":"string","title":"Unmeasured Policy","description":"`exclude_from_denominator`: unmeasured criteria are left out of the score. `count_as_zero`: their weight counts as not earned.","default":"exclude_from_denominator"}},"type":"object","title":"ScoringPolicy"},"SuccessEnvelope_ScorecardVocabularyResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/ScorecardVocabularyResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ScorecardVocabularyResponse]"},"ThresholdBasisItem":{"properties":{"key":{"type":"string","title":"Key"},"label":{"type":"string","title":"Label"},"description":{"type":"string","title":"Description"},"requires":{"items":{"type":"string"},"type":"array","title":"Requires","description":"Facts about the application the basis needs."},"units":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Units","description":"Units it makes sense for. Null means any."}},"type":"object","required":["key","label","description"],"title":"ThresholdBasisItem"},"VocabularyItem":{"properties":{"key":{"type":"string","title":"Key"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["key"],"title":"VocabularyItem"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}