File Claim
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
Platform GUID of the participant.
Path Parameters
The public UUID identifying the worksheet, returned from POST /v1/claims.
Body Parameters
Whether to send notifications to the participant after filing.
Whether to attach receipts to the filed claim.
Whether to send an auto-denial letter if the claim is denied.
Original claim submissions used to create the draft. Required to adjudicate the claim.
Show child attributes
Optional public UUID of a consumer-tracked expense to link to the filed claim. For immediately paid claims, the service validates the expense, creates a capped ConsumerTrackedExpenseAllocation, and updates the expense status to Paid or PartiallyPaid. For deferred claims, the service creates a zero-amount association and leaves the expense status unchanged until the claim becomes payable. Omit for standard claim filing.
Response
Claim filed successfully.
Response Attributes
Gets or sets the public UUID of the worksheet (ClaimWorksheetExternal_guid).
Gets or sets the list of filed claim summaries.
Show child attributes
Invalid request or draft already processed/expired.
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.
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.
Draft not found.
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.
Internal 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: