Claims
Submitting claims, attaching evidence and appealing decisions.
/claimsList claims
The claims this business has filed, newest first. Each row carries the last claim document read from the insurer; read the claim itself for a live view.
Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.
Responses
One page of claim records.
{
"items": [],
"pagination": null
}/api/v1/claimsCode samples
curl -X GET '/api/v1/claims'/claimsSubmit a claim
Files a claim against a policy this business sold. Attach evidence by reserving slots at /uploads, uploading the bytes, and quoting the fileIds here. A claim against a policy another business owns is a 404. When you send formId and formVersion, fetch that form from GET /products/{providerId}/{productId}/form first: a form this API has not fetched from that insurer is 422 VALIDATION_FAILED, not 404.
Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.
Request body
application/json{
"providerId": null,
"policyId": "",
"type": "",
"incidentAt": "",
"formId": "",
"formVersion": 0,
"attachments": [],
"claimedAmount": null,
"payout": null
}Responses
The claim this Idempotency-Key already produced, replayed.
null/api/v1/claimsRequest body
Code samples
curl -X POST '/api/v1/claims' \
-H 'Content-Type: application/json' \
--data-raw '{
"providerId": null,
"policyId": "",
"type": "",
"incidentAt": "",
"formId": "",
"formVersion": 0,
"attachments": [],
"claimedAmount": null,
"payout": null
}'/claims/{providerId}/{claimId}Read one claim
Reads the claim from the insurer, not from the stored row. A claim another business owns is a 404 and the insurer is never called.
Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.
Responses
The claim as the insurer holds it.
null/api/v1/claims/{providerId}/{claimId}Code samples
curl -X GET '/api/v1/claims/{providerId}/{claimId}'/claims/{providerId}/{claimId}/documentsAttach a document to a claim
Quotes a fileId from /uploads against an open claim. Answers 200 with the updated claim, replayed or not.
Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.
Request body
application/jsonnullResponses
The claim after the attachment.
null/api/v1/claims/{providerId}/{claimId}/documentsRequest body
Code samples
curl -X POST '/api/v1/claims/{providerId}/{claimId}/documents'/claims/{providerId}/{claimId}/appealAppeal a claim decision
A claim gets one appeal. A claim in a state that cannot be appealed, and one that has already used its appeal, are both 409 APPEAL_NOT_ALLOWED.
Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.
Request body
application/json{
"reason": "",
"attachments": []
}Responses
The claim after the appeal.
null/api/v1/claims/{providerId}/{claimId}/appealRequest body
Code samples
curl -X POST '/api/v1/claims/{providerId}/{claimId}/appeal' \
-H 'Content-Type: application/json' \
--data-raw '{
"reason": "",
"attachments": []
}'