Get search payor

Retrieve insurance search payor via the Junction API. Requires authentication with your team API key.

GET /v3/insurance/search/payor

cURL

curl --request GET \
     --url '{{BASE_URL}}/v3/insurance/search/payor?insurance_name=AETNA' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}'

Response

[
  {
    "code": "AARPA",
    "name": "AARP",
    "aliases": [
      "AARP",
      "AARP"
    ],
    "org_address": {
      "first_line": "PO BOX 740819",
      "second_line": null,
      "country": "US",
      "zip": "30374",
      "city": "ATLANTA",
      "state": "GA"
    }
  }
]

cURL

curl --request GET \
     --url '{{BASE_URL}}/v3/insurance/search/payor?insurance_name=AETNA' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}'

Response

[
  {
    "code": "AARPA",
    "name": "AARP",
    "aliases": [
      "AARP",
      "AARP"
    ],
    "org_address": {
      "first_line": "PO BOX 740819",
      "second_line": null,
      "country": "US",
      "zip": "30374",
      "city": "ATLANTA",
      "state": "GA"
    }
  }
]

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Query Parameters

insurance_name · string | null

provider · enum<string> | null

ℹ️ This enum is non-exhaustive.

Available options: change_healthcare, availity, stedi, waystar, claim_md, apero, pverify

provider_payor_id · string | null

Response

200

application/json

Successful Response

payor_code · string · required

Payor code returned for the insurance information.

name · string · required

Insurance name returned for the insurance information.

aliases · string[] · required

Insurance name aliases returned for the insurance information.

org_address · Address · object · required

Insurance business address returned for the insurance information.

Show child attributes

source · enum<string> · required

The source of the payor, can be one of (platform, team). ℹ️ This enum is non-exhaustive.

Available options: platform, team