{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/underwriting/assessments/{assessment_id}/adverse-action","version":"1.0.0","description":"Adverse-action reasons for an assessment"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/underwriting/assessments/{assessment_id}/adverse-action":{"get":{"tags":["credit"],"summary":"Adverse-action reasons for an assessment","description":"The scorecard criteria the assessment measured and failed, required ones first and then by weight, each with what was measured, the threshold, which side of it the figure fell, and a template sentence. Empty while the assessment is pending or when nothing failed. No notice is sent.","operationId":"get_adverse_action","parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string","title":"Assessment Id"}},{"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_AdverseActionResponse_"}}}},"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"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","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_adverse_action_api_v1_credit_underwriting_assessments__assessment_id__adverse_action_get"}}},"components":{"schemas":{"AdverseActionReasonDetail":{"properties":{"criterion_key":{"type":"string","title":"Criterion Key"},"criterion_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Criterion Id"},"label":{"type":"string","title":"Label"},"measured":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Measured"},"threshold":{"anyOf":[{"type":"number"},{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Threshold"},"comparator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comparator"},"direction":{"type":"string","title":"Direction","description":"below, above, not_equal, equal, or outside: where the figure fell."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"required":{"type":"boolean","title":"Required","default":false},"weight":{"type":"integer","title":"Weight","default":0},"contribution_bps":{"type":"integer","title":"Contribution Bps","description":"The criterion's weight over the points available.","default":0},"sentence":{"type":"string","title":"Sentence"}},"type":"object","required":["criterion_key","label","direction","sentence"],"title":"AdverseActionReasonDetail","description":"A reason with its template sentence."},"AdverseActionResponse":{"properties":{"assessment_id":{"type":"string","title":"Assessment Id"},"status":{"type":"string","title":"Status"},"credit_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Line Id"},"external_application_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Application Id"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"reasons":{"items":{"$ref":"#/components/schemas/AdverseActionReasonDetail"},"type":"array","title":"Reasons"},"decision":{"type":"null","title":"Decision","description":"Always null. The lending decision is the partner's."},"counsel_note":{"type":"string","title":"Counsel Note"}},"type":"object","required":["assessment_id","status","counsel_note"],"title":"AdverseActionResponse","description":"The reasons behind an assessment's failed criteria. Not a notice."},"SuccessEnvelope_AdverseActionResponse_":{"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/AdverseActionResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[AdverseActionResponse]"},"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":[]}]}