Payers

Search payers

GET/api/v1/payers/search

Finds payers by name, payer ID or alias, best matches first (at most 25). The filters of the list apply inside the search. Search has no pages: next_cursor is always null.

Needs a key with read permission.

Request

Query parameters

Query parameters
Name	Type	Required	Description
q	string	required	What to search for: part of a name, a payer ID or an alias. Use up to 100 characters, with no control characters.At least 1 character.At most 100 characters.
supports	string	optional	Only payers that support this transaction.One of: `eligibility`, `claims`, `era`, `attachments`.
enrollment_required	string	optional	true for payers that need enrollment for any transaction, false for those that need none.One of: `true`, `false`.
include_removed	string	optional	true to include payers that are no longer in the directory. Default false.One of: `true`, `false`.

Response

The best matches. Status 200.

Response fields
Name	Type	Description
data	array of object
data[].id	string	An ID that starts with pyr_.
data[].object	string	Always `payer`.
data[].payer_id	string	The payer's own payer ID, used for routing.
data[].name	string
data[].additional_info	value
data[].aliases	array of string
data[].status	string	One of: `active`, `removed`.
data[].transactions	object
data[].transactions.eligibility	object
data[].transactions.eligibility.supported	boolean
data[].transactions.eligibility.enrollment_required	boolean
data[].transactions.eligibility.enrollment_type	object or null
data[].transactions.eligibility.enrollment_type.code	string	The enrollment code from the payer listing, such as S or WL.
data[].transactions.eligibility.enrollment_type.label	string
data[].transactions.eligibility.enrollment_type.explanation	string
data[].transactions.eligibility.connection_type	string or null	One of: `real_time`.
data[].transactions.eligibility.response_level	string or null	One of: `detailed`, `general`.
data[].transactions.eligibility.returns	object
data[].transactions.eligibility.returns.coinsurance	value
data[].transactions.eligibility.returns.deductibles	value
data[].transactions.eligibility.returns.benefit_descriptions	value
data[].transactions.eligibility.returns.benefit_limitations	value
data[].transactions.eligibility.returns.frequency_limitations	value
data[].transactions.eligibility.notes	value
data[].transactions.claims	object
data[].transactions.claims.supported	boolean
data[].transactions.claims.enrollment_required	boolean
data[].transactions.claims.enrollment_type	object or null
data[].transactions.claims.enrollment_type.code	string	The enrollment code from the payer listing, such as S or WL.
data[].transactions.claims.enrollment_type.label	string
data[].transactions.claims.enrollment_type.explanation	string
data[].transactions.claims.submission_type	string or null	One of: `batch`, `real_time`, `ibatch`, `images`.
data[].transactions.era	object
data[].transactions.era.supported	boolean
data[].transactions.era.enrollment_required	boolean
data[].transactions.era.enrollment_type	object or null
data[].transactions.era.enrollment_type.code	string	The enrollment code from the payer listing, such as S or WL.
data[].transactions.era.enrollment_type.label	string
data[].transactions.era.enrollment_type.explanation	string
data[].transactions.era.paper_eob_shutoff_when_enrolled	boolean
data[].transactions.era.notes	value
data[].transactions.attachments	object
data[].transactions.attachments.supported	boolean
data[].transactions.attachments.enrollment_required	boolean
data[].transactions.attachments.enrollment_type	object or null
data[].transactions.attachments.enrollment_type.code	string	The enrollment code from the payer listing, such as S or WL.
data[].transactions.attachments.enrollment_type.label	string
data[].transactions.attachments.enrollment_type.explanation	string
data[].transactions.attachments.processor	string or null	One of: `nea`, `claim_house`, `nea_claim_house`.
data[].transactions.attachments.nea_payer_id	value
data[].transactions.attachments.nea_master_id	value
data[].updated_at	string (date-time)
next_cursor	value	Pass as cursor to get the next page; null when there is no next page.

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.
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/payers/search?q=example&supports=eligibility" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON

{
  "data": [
    {
      "id": "pyr_01JM000000E008000000000004",
      "object": "payer",
      "payer_id": "00000",
      "name": "Example Dental Plan",
      "additional_info": null,
      "aliases": [
        "EXAMPLE",
        "EXDENTAL"
      ],
      "status": "active",
      "transactions": {
        "eligibility": {
          "supported": true,
          "enrollment_required": false,
          "enrollment_type": null,
          "connection_type": "real_time",
          "response_level": "detailed",
          "returns": {
            "coinsurance": true,
            "deductibles": true,
            "benefit_descriptions": true,
            "benefit_limitations": true,
            "frequency_limitations": true
          },
          "notes": null
        },
        "claims": {
          "supported": true,
          "enrollment_required": true,
          "enrollment_type": {
            "code": "S",
            "label": "Claim House facilitates",
            "explanation": "Claim House can handle enrollment with the payer. The provider requests it by completing the Claim House enrollment request form and supplying the demographic details asked for, including tax ID and NPIs."
          },
          "submission_type": "real_time"
        },
        "era": {
          "supported": true,
          "enrollment_required": true,
          "enrollment_type": {
            "code": "W",
            "label": "Payer paperwork (fax or email)",
            "explanation": "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."
          },
          "paper_eob_shutoff_when_enrolled": false,
          "notes": null
        },
        "attachments": {
          "supported": true,
          "enrollment_required": false,
          "enrollment_type": null,
          "processor": "nea",
          "nea_payer_id": null,
          "nea_master_id": "EXAMPLE01"
        }
      },
      "updated_at": "2026-01-05T00:00:00Z"
    }
  ],
  "next_cursor": null
}