Skip to the page
Chapters

Payers

Get a payer

GET/api/v1/payers/{id}

One payer, by its Claim House ID (pyr_...), its payer ID or any alias. When several payers share a payer ID or alias, the first active one by name is returned. Removed payers are still found.

Needs a key with read permission.

Request

Path parameters

Path parameters
NameTypeRequiredDescription
idstringrequiredA Claim House payer ID (pyr_...), a payer ID or an alias.

Response

The payer. Status 200.

Response fields
NameTypeDescription
idstringAn ID that starts with pyr_.
objectstringAlways `payer`.
payer_idstringThe payer's own payer ID, used for routing.
namestring
additional_infovalue
aliasesarray of string
statusstringOne of: `active`, `removed`.
transactionsobject
transactions.eligibilityobject
transactions.eligibility.supportedboolean
transactions.eligibility.enrollment_requiredboolean
transactions.eligibility.enrollment_typeobject or null
transactions.eligibility.enrollment_type.codestringThe enrollment code from the payer listing, such as S or WL.
transactions.eligibility.enrollment_type.labelstring
transactions.eligibility.enrollment_type.explanationstring
transactions.eligibility.connection_typestring or nullOne of: `real_time`.
transactions.eligibility.response_levelstring or nullOne of: `detailed`, `general`.
transactions.eligibility.returnsobject
transactions.eligibility.returns.coinsurancevalue
transactions.eligibility.returns.deductiblesvalue
transactions.eligibility.returns.benefit_descriptionsvalue
transactions.eligibility.returns.benefit_limitationsvalue
transactions.eligibility.returns.frequency_limitationsvalue
transactions.eligibility.notesvalue
transactions.claimsobject
transactions.claims.supportedboolean
transactions.claims.enrollment_requiredboolean
transactions.claims.enrollment_typeobject or null
transactions.claims.enrollment_type.codestringThe enrollment code from the payer listing, such as S or WL.
transactions.claims.enrollment_type.labelstring
transactions.claims.enrollment_type.explanationstring
transactions.claims.submission_typestring or nullOne of: `batch`, `real_time`, `ibatch`, `images`.
transactions.eraobject
transactions.era.supportedboolean
transactions.era.enrollment_requiredboolean
transactions.era.enrollment_typeobject or null
transactions.era.enrollment_type.codestringThe enrollment code from the payer listing, such as S or WL.
transactions.era.enrollment_type.labelstring
transactions.era.enrollment_type.explanationstring
transactions.era.paper_eob_shutoff_when_enrolledboolean
transactions.era.notesvalue
transactions.attachmentsobject
transactions.attachments.supportedboolean
transactions.attachments.enrollment_requiredboolean
transactions.attachments.enrollment_typeobject or null
transactions.attachments.enrollment_type.codestringThe enrollment code from the payer listing, such as S or WL.
transactions.attachments.enrollment_type.labelstring
transactions.attachments.enrollment_type.explanationstring
transactions.attachments.processorstring or nullOne of: `nea`, `claim_house`, `nea_claim_house`.
transactions.attachments.nea_payer_idvalue
transactions.attachments.nea_master_idvalue
updated_atstring (date-time)

Errors

Errors
HTTP statusCodeWhat it means
401UNAUTHORIZEDA valid API key is required. Send it as "Authorization: Bearer <key>".
403PERMISSION_DENIEDThis API key is not allowed to do that.
404NOT_FOUNDNot found.
422INVALID_REQUESTThe request is not valid.
504TIMEOUTThe 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).
500INTERNALSomething 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/pyr_01JM000000E008000000000004" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON
{
  "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"
}