Enrollments

Get an enrollment

GET/api/v1/enrollments/{id}

One enrollment of the key's organization and mode. One of another organization or mode is not found.

Needs a key with read permission.

Request

Path parameters

Path parameters
Name	Type	Required	Description
id	string	required	An enrollment ID (enr_...).

Response

The enrollment. Status 200.

Response fields
Name	Type	Description
id	string	An ID that starts with enr_.
object	string	Always `enrollment`.
provider_id	string	An ID that starts with prv_.
provider_name	string
payer_id	string	An ID that starts with pyr_.
payer_name	string
type	string	One of: `claims`, `era`, `era_eft`.
method	object or null	How the payer enrolls a provider, from the payer directory; null when the payer needs no enrollment for this (it started active).
method.code	string	The payer directory's enrollment code when the enrollment was started (S, O, W, F, I or U, with * or L).
method.label	string
method.instructions	string	What has to be done, in plain words.
status	string	One of: `not_started`, `awaiting_signature`, `provider_action`, `submitted`, `active`.
next_step	string	What someone has to do now, in plain words.
sent_on	string (date) or null
expected_on	string (date) or null
note	string
mode	string	One of: `test`, `live`.
activated_at	string (date-time) or null	When it last became active; null while it is not.
created_at	string (date-time)
updated_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/enrollments/enr_01JM000000E00800000000004M" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON

{
  "id": "enr_01JM000000E00800000000004M",
  "object": "enrollment",
  "provider_id": "prv_01JM000000E008000000000005",
  "provider_name": "Dr. Riley Example, DDS",
  "payer_id": "pyr_01JM000000E008000000000004",
  "payer_name": "Example Dental Plan",
  "type": "claims",
  "method": {
    "code": "W",
    "label": "Payer paperwork (fax or email)",
    "instructions": "The payer requires its own enrollment paperwork. Claim House supplies a copy, and the provider returns it by fax, email or mail so Claim House can submit it to the payer."
  },
  "status": "not_started",
  "next_step": "Start the paperwork.",
  "sent_on": null,
  "expected_on": null,
  "note": "",
  "mode": "test",
  "activated_at": null,
  "created_at": "2026-09-20T15:00:00+00:00",
  "updated_at": "2026-09-20T15:00:00+00:00"
}

An enrollment of another organization or mode: 404

JSON

{
  "error": "NOT_FOUND",
  "message": "Enrollment not found.",
  "errors": [],
  "request_id": "req_01JM000000E008000000000010"
}