Cancel Claim
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
The GUID of the person (participant) cancelling the claim.
Path Parameters
The human-readable claim number (e.g. ROHEMP260511P0000101) identifying the claim to cancel.
Response
Claim successfully cancelled.
Response Attributes
The human-readable claim number (e.g. ROHEMP260511P0000101).
Serialised as claim_number.
The status of the claim after cancellation. Always "Denied".
Serialised as claim_status.
The receipt status after cancellation. Always "Not Needed".
Serialised as receipt_status.
The UTC timestamp when the claim was cancelled.
Serialised as cancelled_at.
The person_id (GUID) of the participant who cancelled the claim.
Serialised as cancelled_by.
claim_number or person_id is missing or invalid.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized. Missing or invalid JWT token.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Forbidden. Authenticated user does not own this claim.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
No claim found for the given claim_number.
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Claim is not in a cancellable status (e.g. already Denied or Paid).
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected server error.
Unexpected error
Response Attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Base URL
Production:
Sandbox: