API reference›CAMT.054 candidates›Retrieve Settlement Candidate
104 operations ↓ OpenAPI JSON Get API key
GET /v1/settlement-candidates/{candidate_id}

Retrieve Settlement Candidate

Retrieve one settlement candidate with review metadata and preview-only suggested allocation.

Requires API key OpenAPI v1

Authentication

Use a HelvCore API key in the Authorization header. Keys are server-side secrets and must not be exposed to browser JavaScript.

GETHeader
Authorization: Bearer hc_...

Parameters

candidate_idstringrequiredpath

Documented field.

Returns

Returns a documented JSON response on success and the standard HelvCore error envelope on failure.

200Successful response.
defaultStructured error response.
401invalid_auth - missing, expired, or invalid Bearer key

Stable error codes

api_key_disabledDocumented HelvCore error code for this operation.
api_key_expiredDocumented HelvCore error code for this operation.
invalid_authDocumented HelvCore error code for this operation.
invalid_requestDocumented HelvCore error code for this operation.
validation_failedDocumented HelvCore error code for this operation.