TRANXACT.AI Help

EHR · Revenue Cycle

Insurance Verification

Coverage on file, and whether it has been verified. A claim will not pass the scrub without it.

Type REST8 operationsBase path /api/ehr/insurance-policiesPublished as /api/v1/insurance-policies

Download specification (OpenAPI 3.1) Screen: Insurance Verification

Overview

PackageEHR
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold EHR › Insurance Verification on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableehr.insurance_policies · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ehr/insurance-policiesList insurance verification

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "policy_no": "POL-000001",
      "group_no": "GRO-000001",
      "coverage_rank": "primary",
      "subscriber_name": "Example",
      "relationship": "text",
      "effective_from": "2026-10-30",
      "effective_to": "2026-10-30",
      "copay_amount": "1250.00",
      "deductible": "1250.00",
      "deductible_met": "1250.00",
      "coinsurance_pct": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ehr/insurance-policies?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ehr/insurance-policies/{id}Read one insurance policies

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "policy_no": "POL-000001",
  "group_no": "GRO-000001",
  "coverage_rank": "primary",
  "subscriber_name": "Example",
  "relationship": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "copay_amount": "1250.00",
  "deductible": "1250.00",
  "deductible_met": "1250.00",
  "coinsurance_pct": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/ehr/insurance-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/insurance-policiesCreate a insurance policies

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
patient_iduuidYesPatient
payer_iduuidYesPayer
policy_notextYesPolicy number
group_notextNoGroup number
coverage_ranktextNoRank
Allowed: primary secondary tertiary
subscriber_nametextNoSubscriber
relationshiptextNoRelationship
effective_fromdateNoEffective from
effective_todateNoEffective to
copay_amountnumericNoCopay
deductiblenumericNoDeductible
deductible_metnumericNoDeductible met
coinsurance_pctnumericNoCoinsurance %
out_of_pocket_maxnumericNoOut of pocket max
is_activebooleanNoActive

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "policy_no": "POL-000001",
  "group_no": "GRO-000001",
  "coverage_rank": "primary",
  "subscriber_name": "Example",
  "relationship": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "policy_no": "POL-000001",
  "group_no": "GRO-000001",
  "coverage_rank": "primary",
  "subscriber_name": "Example",
  "relationship": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "copay_amount": "1250.00",
  "deductible": "1250.00",
  "deductible_met": "1250.00",
  "coinsurance_pct": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/insurance-policies" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","payer_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","policy_no":"POL-000001","group_no":"GRO-000001","coverage_rank":"primary","subscriber_name":"Example","relationship":"text"}'
PUT/api/ehr/insurance-policies/{id}Change a insurance policies

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
patient_iduuidYesPatient
payer_iduuidYesPayer
policy_notextYesPolicy number
group_notextNoGroup number
coverage_ranktextNoRank
Allowed: primary secondary tertiary
subscriber_nametextNoSubscriber
relationshiptextNoRelationship
effective_fromdateNoEffective from
effective_todateNoEffective to
copay_amountnumericNoCopay
deductiblenumericNoDeductible
deductible_metnumericNoDeductible met
coinsurance_pctnumericNoCoinsurance %
out_of_pocket_maxnumericNoOut of pocket max
is_activebooleanNoActive

Sample body

{
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "patient_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "policy_no": "POL-000001",
  "group_no": "GRO-000001",
  "coverage_rank": "primary",
  "subscriber_name": "Example",
  "relationship": "text",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "copay_amount": "1250.00",
  "deductible": "1250.00",
  "deductible_met": "1250.00",
  "coinsurance_pct": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ehr/insurance-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"patient_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","payer_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/ehr/insurance-policies/{id}Delete a insurance policies

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/ehr/insurance-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ehr/insurance-policies/{id}/check-eligibilityCheck eligibility

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

serviceType

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/insurance-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check-eligibility" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"serviceType":"value"}'
POST/api/ehr/insurance-policies/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/insurance-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/ehr/insurance-policies/{id}/verifyVerify

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

status, note, deductibleMet, copayAmount; status one of verified|inactive|invalid|pending

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/ehr/insurance-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/verify" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"value","note":"value","deductibleMet":"value","copayAmount;":"value"}'

Data model

Every field of a insurance policies, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
patient_iduuidread, writePatient
payer_iduuidread, writePayer
policy_notextread, writePolicy number
group_notextread, writeGroup number
coverage_ranktextread, writeRank
Allowed: primary secondary tertiary
subscriber_nametextread, writeSubscriber
relationshiptextread, writeRelationship
effective_fromdateread, writeEffective from
effective_todateread, writeEffective to
copay_amountnumericread, writeCopay
deductiblenumericread, writeDeductible
deductible_metnumericread, writeDeductible met
coinsurance_pctnumericread, writeCoinsurance %
out_of_pocket_maxnumericread, writeOut of pocket max
verification_statustextread onlyVerification status
verified_attimestamp with time zoneread onlyVerified at
verified_byuuidread onlyVerified by
verification_notetextread onlyVerification note
is_activebooleanread, writeActive
org_unit_iduuidread onlyOrg unit id
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
eligibility_statustextread onlyEligibility status
eligibility_checked_attimestamp with time zoneread onlyEligibility checked at
plan_nametextread onlyPlan name
out_of_pocket_metnumericread onlyOut of pocket met

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold EHR › Insurance Verification for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.