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
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | required | A Claim House payer ID (pyr_...), a payer ID or an alias. |
Response
The payer. Status 200.
| Name | Type | Description |
|---|---|---|
| id | string | An ID that starts with pyr_. |
| object | string | Always `payer`. |
| payer_id | string | The payer's own payer ID, used for routing. |
| name | string | |
| additional_info | value | |
| aliases | array of string | |
| status | string | One of: `active`, `removed`. |
| transactions | object | |
| transactions.eligibility | object | |
| transactions.eligibility.supported | boolean | |
| transactions.eligibility.enrollment_required | boolean | |
| transactions.eligibility.enrollment_type | object or null | |
| transactions.eligibility.enrollment_type.code | string | The enrollment code from the payer listing, such as S or WL. |
| transactions.eligibility.enrollment_type.label | string | |
| transactions.eligibility.enrollment_type.explanation | string | |
| transactions.eligibility.connection_type | string or null | One of: `real_time`. |
| transactions.eligibility.response_level | string or null | One of: `detailed`, `general`. |
| transactions.eligibility.returns | object | |
| transactions.eligibility.returns.coinsurance | value | |
| transactions.eligibility.returns.deductibles | value | |
| transactions.eligibility.returns.benefit_descriptions | value | |
| transactions.eligibility.returns.benefit_limitations | value | |
| transactions.eligibility.returns.frequency_limitations | value | |
| transactions.eligibility.notes | value | |
| transactions.claims | object | |
| transactions.claims.supported | boolean | |
| transactions.claims.enrollment_required | boolean | |
| transactions.claims.enrollment_type | object or null | |
| transactions.claims.enrollment_type.code | string | The enrollment code from the payer listing, such as S or WL. |
| transactions.claims.enrollment_type.label | string | |
| transactions.claims.enrollment_type.explanation | string | |
| transactions.claims.submission_type | string or null | One of: `batch`, `real_time`, `ibatch`, `images`. |
| transactions.era | object | |
| transactions.era.supported | boolean | |
| transactions.era.enrollment_required | boolean | |
| transactions.era.enrollment_type | object or null | |
| transactions.era.enrollment_type.code | string | The enrollment code from the payer listing, such as S or WL. |
| transactions.era.enrollment_type.label | string | |
| transactions.era.enrollment_type.explanation | string | |
| transactions.era.paper_eob_shutoff_when_enrolled | boolean | |
| transactions.era.notes | value | |
| transactions.attachments | object | |
| transactions.attachments.supported | boolean | |
| transactions.attachments.enrollment_required | boolean | |
| transactions.attachments.enrollment_type | object or null | |
| transactions.attachments.enrollment_type.code | string | The enrollment code from the payer listing, such as S or WL. |
| transactions.attachments.enrollment_type.label | string | |
| transactions.attachments.enrollment_type.explanation | string | |
| transactions.attachments.processor | string or null | One of: `nea`, `claim_house`, `nea_claim_house`. |
| transactions.attachments.nea_payer_id | value | |
| transactions.attachments.nea_master_id | value | |
| updated_at | string (date-time) |
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
curl "https://sandbox.myclaimhouse.com/api/v1/payers/pyr_01JM000000E008000000000004" \
-H "Authorization: Bearer $CLAIMHOUSE_KEY"Example response: 200
{
"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"
}