Payer requests

Get a payer request

GET/api/v1/payer_requests/{id}

One payer request of the key's organization and mode.

Needs a key with read permission.

Request

Path parameters

Path parameters
Name	Type	Required	Description
id	string	required	A payer request ID (prq_...).

Response

The payer request. Status 200.

Response fields
Name	Type	Description
id	string	An ID that starts with prq_.
object	string	Always `payer_request`.
state	string	One of: `open`, `answered`.
source	string	network (it arrived through the network) or staff (recorded by hand, from a letter).One of: `network`, `staff`.
claim_id	string or null	An ID that starts with clm_.
payer	object
payer.id	string	An ID that starts with pyr_.
payer.payer_id	string	The payer's own payer ID.
payer.name	string
reference_number	string	The payer's reference number: the answering attachment carries it.
requested	string	What the payer asks for, in its words.
due_date	string (date) or null
answering_attachment_id	string or null	An ID that starts with att_.
answered_at	string (date-time) or null
created_at	string (date-time)

Errors

Errors
HTTP status	Code	What it means
401	UNAUTHORIZED	A valid API key is required. Send it as "Authorization: Bearer <key>".
403	PERMISSION_DENIED	This API key is not allowed to do that.
404	NOT_FOUND	Not found.
422	INVALID_REQUEST	The request is not valid.
504	TIMEOUT	The request took too long to finish. It may still have taken effect: look it up before sending it again with a new Idempotency-Key. What it made is found with GET /api/v1/eligibility?request_id=<this request_id>, and the same filter on /api/v1/claims and /api/v1/attachments (a key with read permission).
500	INTERNAL	Something went wrong on our side. Quote the request ID if you contact us.

Example

Example request

Shell

curl "https://sandbox.myclaimhouse.com/api/v1/payer_requests/prq_01JM000000E008000000000040" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON

{
  "id": "prq_01JM000000E008000000000040",
  "object": "payer_request",
  "state": "open",
  "source": "network",
  "claim_id": "clm_01JM000000E00800000000002G",
  "payer": {
    "id": "pyr_01JM000000E008000000000004",
    "payer_id": "00000",
    "name": "Example Dental Plan"
  },
  "reference_number": "PRQ000001042",
  "requested": "A narrative of the treatment and a current periapical X-ray of the tooth treated.",
  "due_date": "2026-10-25",
  "answering_attachment_id": null,
  "answered_at": null,
  "created_at": "2026-09-25T21:02:30.000000+00:00"
}