Retrieve a claim
/v1/claims/{id}Returns one claim by ID. Available to keys belonging to office staff.
Path parameters
ID of the claim.
Response
200The claim.
String representing the object's type. Always claim.
Unique identifier of the claim.
The patient the claim is for.
The caregiver who provided the service.
The visit billed, for single-visit claims.
The related invoice, if any.
Your claim number.
Claim format: professional (837P) or institutional (837I).
Professional837PInstitutional837InullThe payer billed.
The payer's electronic payer ID.
First date of service, as YYYY-MM-DD.
Last date of service, as YYYY-MM-DD.
Total billed. In cents.
Where the claim is in adjudication.
DraftValidatedValidationFailedSubmittedAcknowledgedAcceptedRejectedInAdjudicationPaidPartiallyPaidDeniedAppealedVoidednullLatest status detail from the payer or clearinghouse.
When the status last changed, ISO 8601.
Amount the payer paid. In cents.
Amount the patient owes after the payer. In cents.
Authorization number sent on the claim.
Payment check or EFT trace number.
When the claim was submitted, ISO 8601.
When the claim was created.
When the claim was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 404 | n/a | No such object, or it is not visible to this key (not_found). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.