Create Payor
curl --request POST \
--url https://api.us.junction.com/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_payor_id": "<string>"
}
'import requests
url = "https://api.us.junction.com/v3/payor"
payload = {
"name": "<string>",
"address": {
"first_line": "<string>",
"country": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"second_line": "",
"access_notes": "<string>"
},
"provider_payor_id": "<string>"
}
headers = {
"x-vital-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-vital-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
address: {
first_line: '<string>',
country: '<string>',
zip: '<string>',
city: '<string>',
state: '<string>',
second_line: '',
access_notes: '<string>'
},
provider_payor_id: '<string>'
})
};
fetch('https://api.us.junction.com/v3/payor', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.us.junction.com/v3/payor",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'address' => [
'first_line' => '<string>',
'country' => '<string>',
'zip' => '<string>',
'city' => '<string>',
'state' => '<string>',
'second_line' => '',
'access_notes' => '<string>'
],
'provider_payor_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-vital-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.us.junction.com/v3/payor"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": {\n \"first_line\": \"<string>\",\n \"country\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"second_line\": \"\",\n \"access_notes\": \"<string>\"\n },\n \"provider_payor_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-vital-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.us.junction.com/v3/payor")
.header("x-vital-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": {\n \"first_line\": \"<string>\",\n \"country\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"second_line\": \"\",\n \"access_notes\": \"<string>\"\n },\n \"provider_payor_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.junction.com/v3/payor")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-vital-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"address\": {\n \"first_line\": \"<string>\",\n \"country\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"second_line\": \"\",\n \"access_notes\": \"<string>\"\n },\n \"provider_payor_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}{
"detail": "<unknown>"
}Health Insurance
Create Payor
Create or submit payor via the Junction API. Requires authentication with your team API key.
POST
/
v3
/
payor
Create Payor
curl --request POST \
--url https://api.us.junction.com/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_payor_id": "<string>"
}
'import requests
url = "https://api.us.junction.com/v3/payor"
payload = {
"name": "<string>",
"address": {
"first_line": "<string>",
"country": "<string>",
"zip": "<string>",
"city": "<string>",
"state": "<string>",
"second_line": "",
"access_notes": "<string>"
},
"provider_payor_id": "<string>"
}
headers = {
"x-vital-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-vital-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
address: {
first_line: '<string>',
country: '<string>',
zip: '<string>',
city: '<string>',
state: '<string>',
second_line: '',
access_notes: '<string>'
},
provider_payor_id: '<string>'
})
};
fetch('https://api.us.junction.com/v3/payor', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.us.junction.com/v3/payor",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'address' => [
'first_line' => '<string>',
'country' => '<string>',
'zip' => '<string>',
'city' => '<string>',
'state' => '<string>',
'second_line' => '',
'access_notes' => '<string>'
],
'provider_payor_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-vital-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.us.junction.com/v3/payor"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": {\n \"first_line\": \"<string>\",\n \"country\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"second_line\": \"\",\n \"access_notes\": \"<string>\"\n },\n \"provider_payor_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-vital-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.us.junction.com/v3/payor")
.header("x-vital-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": {\n \"first_line\": \"<string>\",\n \"country\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"second_line\": \"\",\n \"access_notes\": \"<string>\"\n },\n \"provider_payor_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.junction.com/v3/payor")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-vital-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"address\": {\n \"first_line\": \"<string>\",\n \"country\": \"<string>\",\n \"zip\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"second_line\": \"\",\n \"access_notes\": \"<string>\"\n },\n \"provider_payor_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}
}{
"detail": "<unknown>"
}This feature is in closed beta.Interested in this feature? Get in touch with your Customer Success Manager.
Authorizations
Vital Team API Key
Body
application/json
Response
Successful Response
Payor code returned for the insurance information.
Insurance name returned for the insurance information.
Insurance name aliases returned for the insurance information.
Insurance business address returned for the insurance information.
Show child attributes
Show child attributes
The source of the payor, can be one of (platform, team). ℹ️ This enum is non-exhaustive.
Available options:
platform, team Was this page helpful?
⌘I