Skip to main content
Records a decision on a submitted application. Use this endpoint when a downstream provider (e.g. a bank, payment provider, or credit bureau) returns an outcome for an application and you want Klara to have a canonical record of that decision.

Authentication

Requires an API key with applications:write scope. The application must belong to the organization associated with the API key.

Path parameters

string
required
UUID of the application. Must match the applicationId in the request body.

Request body

string
required
Decision type. One of:
  • application.approved
  • application.rejected
  • application.referred
string
required
ISO 8601 timestamp of when the provider made the decision (not when you are relaying it to Klara).
string
required
UUID of the application. Must match the {id} in the URL path.
object
Free-form object containing any provider-specific context you want stored alongside the decision — for example a provider reference number, reason codes, or reviewer notes. Stored verbatim.
Provider decisions can only be recorded against applications that have been submitted. Calling this endpoint for an application still in created, sent, or in_progress state returns 400.

Idempotency

Recording the same decision type twice for an application is a safe no-op. The second call returns 200 OK with already_recorded: true and does not create a duplicate record. Different decision types are all recorded in order — e.g. a referred decision followed later by an approved decision will both be stored.

Response

Returns 201 Created when a new decision is recorded, or 200 OK if the decision was already recorded.
boolean
true when the decision was accepted.
string
Normalized decision type (approved, rejected, or referred) — the application. prefix is stripped. Only present on 201.
string
UUID of the application. Only present on 201.
boolean
true when the same decision type was already recorded. Only present on 200.
string
Human-readable explanation. Only present on 200.

Examples

Approving an application

Response (new decision):
Response (already recorded):

Referring for manual review

Errors