Create Payor

Create or submit payor via the Junction API. Requires authentication with your team API key.

POST /v3/payor

Create Payor

cURL

curl --request POST \
  --url https://api.tryvital.io/v3/payor \
  --header 'Content-Type: application/json' \
  --header 'x-vital-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "address": {
    "first_line": "<string>",
    "country": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "second_line": "",
    "access_notes": "<string>"
  },
  "provider": "change_healthcare",
  "provider_payor_id": "<string>"
}
'

200

{
  "payor_code": "<string>",
  "name": "<string>",
  "aliases": [
    "<string>"
  ],
  "org_address": {
    "first_line": "<string>",
    "country": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "state": "<string>",
    "second_line": "",
    "access_notes": "<string>"
  },
  "source": "platform"
}

This feature is in closed beta.

Interested in this feature? Get in touch with your Customer Success Manager.

Create a new payor.

Allows the creation of new payors that don’t already exist in Junction’s system. Created payors are tied to the team that created them, so they will only be returned as search results when searched by that same team.

Authorizations

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

Vital Team API Key

Body

application/json

name · string · required

address · Address · object · required

Show child attributes

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