cases

post

/api/v1/cases/{id}/decision

Record a binding credit decision, or send the case to a human.

Scope: cases:decide
Rate limit: 50 requests / min
Idempotency: Idempotency-Key supported

Authentication

Send your key as Authorization: Bearer …. It must carry the scope cases:decide; a key without it receives 403 forbidden.

Headers

Idempotency-Keystring

Replays the first response for a repeated request. Reusing a key with a different body is idempotency_key_reused (409), never a silent replay.

Request body

application/jsonrequired

decisionstring (enum)requiredapproveapproveddeclinedeclinedreview

approve, decline or review; the past-tense spellings are aliases. Matched case-insensitively.

reasonstringrequiredmin length 1

The justification. Recorded as the override reason on an approval or decline, and as the review note on a review.

conditionsarray | nullnullable

Only with approve. Each is stored as a required prior-to-funding condition.

approved_amountnumber | string | nullnullable

Only with approve. WHOLE DOLLARS, never cents: greater than zero and at most 2147483647, as a number or a numeric string.

Response

200application/jsonSerializedCaseDecision

idstringrequired

statusstring (enum)requiredpendingapproveddeclinedreviewinvited

decisionstring | nullrequirednullable

The recorded outcome, or null. Null is the review case: a review records no outcome, and status (review) is the whole answer.

decided_bystringrequired

api_key:<key id> — the API key that recorded the decision.

decided_atstring | nullrequirednullable

approved_amountnumber | nullrequirednullable

Whole dollars. Null when the decision carries no approved amount.

interest_ratenumber | nullrequirednullable

term_monthsnumber | nullrequirednullable

monthly_paymentnumber | nullrequirednullable

decline_reasonsstring[]required

conditionsstring[]required

Echoed back only when the caller sent conditions; [] otherwise.

Errors

The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.

400validation_error

401unauthorized

403forbidden

404not_found

409idempotency_key_reused

429rate_limit_exceeded

500internal_error

curl -X POST "https://<your-host>/api/v1/cases/<id>/decision" \ -H "Authorization: Bearer hlh_test_YOUR_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: <idempotency-key>" \ -d '{ "decision": "approve", "reason": "<reason>" }'

{ "id": string, "status": "pending" | "approved" | "declined" | "review" | "invited", "decision": string | null, "decided_by": string, "decided_at": string | null, "approved_amount": number | null, "interest_rate": number | null, "term_months": number | null, "monthly_payment": number | null, "decline_reasons": [ string ], "conditions": [ string ] }

cases

post

/api/v1/cases/{id}/decision

Record a binding credit decision, or send the case to a human.

Scope: cases:decide
Rate limit: 50 requests / min
Idempotency: Idempotency-Key supported

Authentication

Send your key as Authorization: Bearer …. It must carry the scope cases:decide; a key without it receives 403 forbidden.

Path parameters

idstringrequired

Headers

Idempotency-Keystring

Replays the first response for a repeated request. Reusing a key with a different body is idempotency_key_reused (409), never a silent replay.

Request body

application/jsonrequired

decisionstring (enum)requiredapproveapproveddeclinedeclinedreview

approve, decline or review; the past-tense spellings are aliases. Matched case-insensitively.

reasonstringrequiredmin length 1

The justification. Recorded as the override reason on an approval or decline, and as the review note on a review.

conditionsarray | nullnullable

Only with approve. Each is stored as a required prior-to-funding condition.

approved_amountnumber | string | nullnullable

Only with approve. WHOLE DOLLARS, never cents: greater than zero and at most 2147483647, as a number or a numeric string.

Response

200application/jsonSerializedCaseDecision

idstringrequired

statusstring (enum)requiredpendingapproveddeclinedreviewinvited

decisionstring | nullrequirednullable

The recorded outcome, or null. Null is the review case: a review records no outcome, and status (review) is the whole answer.

decided_bystringrequired

api_key:<key id> — the API key that recorded the decision.

decided_atstring | nullrequirednullable

approved_amountnumber | nullrequirednullable

Whole dollars. Null when the decision carries no approved amount.

interest_ratenumber | nullrequirednullable

term_monthsnumber | nullrequirednullable

monthly_paymentnumber | nullrequirednullable

decline_reasonsstring[]required

conditionsstring[]required

Echoed back only when the caller sent conditions; [] otherwise.

Errors

The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.

400validation_error

401unauthorized

403forbidden

404not_found

409idempotency_key_reused

429rate_limit_exceeded

500internal_error