Request verifications of benefits for a patient
curl --request POST \
--url https://api.example.com/v1/verification-of-benefits-requests \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"patient": {
"external_id": {
"type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "<string>",
"gender": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"comments": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"tags": [
"<string>"
],
"referral": {
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": [
"<string>"
],
"service_types": [],
"file_id": "<string>"
},
"custom_fields": {}
},
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policies": [
{
"insurance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insurance_name": "<string>",
"member_number": "<string>",
"subscriber": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"member_number": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"zip": "<string>"
},
"group_number": "<string>",
"plan_name": "<string>",
"external_id": "<string>"
}
],
"file_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"specialties": [
{
"credentialing_id": "<string>",
"cpt_codes": [
"<string>"
],
"service_locations": [],
"icd_codes": [
"<string>"
]
}
],
"priority": false
}
'import requests
url = "https://api.example.com/v1/verification-of-benefits-requests"
payload = {
"patient": {
"external_id": {
"type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "<string>",
"gender": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"comments": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"tags": ["<string>"],
"referral": {
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": ["<string>"],
"service_types": [],
"file_id": "<string>"
},
"custom_fields": {}
},
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policies": [
{
"insurance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insurance_name": "<string>",
"member_number": "<string>",
"subscriber": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"member_number": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"zip": "<string>"
},
"group_number": "<string>",
"plan_name": "<string>",
"external_id": "<string>"
}
],
"file_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"specialties": [
{
"credentialing_id": "<string>",
"cpt_codes": ["<string>"],
"service_locations": [],
"icd_codes": ["<string>"]
}
],
"priority": False
}
headers = {
"X-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-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patient: {
external_id: {type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'},
first_name: '<string>',
last_name: '<string>',
middle_name: '<string>',
date_of_birth: '<string>',
gender: '<string>',
phone_number: '<string>',
additional_phone_number: '<string>',
email: '<string>',
address: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
comments: '<string>',
assigned_user_id: '<string>',
location_id: '<string>',
organization_id: '<string>',
tags: ['<string>'],
referral: {
physician_name: '<string>',
physician_email: '<string>',
physician_phone: '<string>',
physician_fax: '<string>',
physician_group: '<string>',
physician_npi: '<string>',
physician_address: '<string>',
physician_address_2: '<string>',
physician_city: '<string>',
physician_zip: '<string>',
start_date: '2023-12-25',
end_date: '2023-12-25',
location_id: '<string>',
icd_codes: ['<string>'],
service_types: [],
file_id: '<string>'
},
custom_fields: {}
},
patient_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
policies: [
{
insurance_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
insurance_name: '<string>',
member_number: '<string>',
subscriber: {
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
dob: '2023-12-25',
member_number: '<string>',
address: '<string>',
address2: '<string>',
city: '<string>',
zip: '<string>'
},
group_number: '<string>',
plan_name: '<string>',
external_id: '<string>'
}
],
file_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
specialties: [
{
credentialing_id: '<string>',
cpt_codes: ['<string>'],
service_locations: [],
icd_codes: ['<string>']
}
],
priority: false
})
};
fetch('https://api.example.com/v1/verification-of-benefits-requests', 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.example.com/v1/verification-of-benefits-requests",
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([
'patient' => [
'external_id' => [
'type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>'
],
'first_name' => '<string>',
'last_name' => '<string>',
'middle_name' => '<string>',
'date_of_birth' => '<string>',
'gender' => '<string>',
'phone_number' => '<string>',
'additional_phone_number' => '<string>',
'email' => '<string>',
'address' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'comments' => '<string>',
'assigned_user_id' => '<string>',
'location_id' => '<string>',
'organization_id' => '<string>',
'tags' => [
'<string>'
],
'referral' => [
'physician_name' => '<string>',
'physician_email' => '<string>',
'physician_phone' => '<string>',
'physician_fax' => '<string>',
'physician_group' => '<string>',
'physician_npi' => '<string>',
'physician_address' => '<string>',
'physician_address_2' => '<string>',
'physician_city' => '<string>',
'physician_zip' => '<string>',
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'location_id' => '<string>',
'icd_codes' => [
'<string>'
],
'service_types' => [
],
'file_id' => '<string>'
],
'custom_fields' => [
]
],
'patient_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'policies' => [
[
'insurance_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'insurance_name' => '<string>',
'member_number' => '<string>',
'subscriber' => [
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'dob' => '2023-12-25',
'member_number' => '<string>',
'address' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'zip' => '<string>'
],
'group_number' => '<string>',
'plan_name' => '<string>',
'external_id' => '<string>'
]
],
'file_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'specialties' => [
[
'credentialing_id' => '<string>',
'cpt_codes' => [
'<string>'
],
'service_locations' => [
],
'icd_codes' => [
'<string>'
]
]
],
'priority' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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.example.com/v1/verification-of-benefits-requests"
payload := strings.NewReader("{\n \"patient\": {\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"custom_fields\": {}\n },\n \"patient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"policies\": [\n {\n \"insurance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insurance_name\": \"<string>\",\n \"member_number\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"member_number\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"group_number\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n ],\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"specialties\": [\n {\n \"credentialing_id\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"service_locations\": [],\n \"icd_codes\": [\n \"<string>\"\n ]\n }\n ],\n \"priority\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.example.com/v1/verification-of-benefits-requests")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patient\": {\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"custom_fields\": {}\n },\n \"patient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"policies\": [\n {\n \"insurance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insurance_name\": \"<string>\",\n \"member_number\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"member_number\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"group_number\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n ],\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"specialties\": [\n {\n \"credentialing_id\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"service_locations\": [],\n \"icd_codes\": [\n \"<string>\"\n ]\n }\n ],\n \"priority\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/verification-of-benefits-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patient\": {\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"custom_fields\": {}\n },\n \"patient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"policies\": [\n {\n \"insurance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insurance_name\": \"<string>\",\n \"member_number\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"member_number\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"group_number\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n ],\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"specialties\": [\n {\n \"credentialing_id\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"service_locations\": [],\n \"icd_codes\": [\n \"<string>\"\n ]\n }\n ],\n \"priority\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "created"
},
"policies": [
{
"action": "matched",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "new_member_number",
"source": "request"
}
],
"verifications": [
{
"patient_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "opened",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "no_service_type",
"left_out": [
"medical_care"
]
}
],
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
]
},
"completed_at": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"meta": {}
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"meta": {}
}{
"type": "validation_error",
"code": "invalid_parameter",
"message": "Field validation failed",
"param": "phone_number"
}Verification of Benefits Requests
Request verifications of benefits for a patient
Upsert the patient, store the coverage you know, read the insurance cards you uploaded, and open a verification of benefits for every active policy of the patient, asynchronously. Poll the Location URL until the request is completed or failed.
POST
/
v1
/
verification-of-benefits-requests
Request verifications of benefits for a patient
curl --request POST \
--url https://api.example.com/v1/verification-of-benefits-requests \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"patient": {
"external_id": {
"type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "<string>",
"gender": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"comments": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"tags": [
"<string>"
],
"referral": {
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": [
"<string>"
],
"service_types": [],
"file_id": "<string>"
},
"custom_fields": {}
},
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policies": [
{
"insurance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insurance_name": "<string>",
"member_number": "<string>",
"subscriber": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"member_number": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"zip": "<string>"
},
"group_number": "<string>",
"plan_name": "<string>",
"external_id": "<string>"
}
],
"file_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"specialties": [
{
"credentialing_id": "<string>",
"cpt_codes": [
"<string>"
],
"service_locations": [],
"icd_codes": [
"<string>"
]
}
],
"priority": false
}
'import requests
url = "https://api.example.com/v1/verification-of-benefits-requests"
payload = {
"patient": {
"external_id": {
"type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
},
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"date_of_birth": "<string>",
"gender": "<string>",
"phone_number": "<string>",
"additional_phone_number": "<string>",
"email": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"comments": "<string>",
"assigned_user_id": "<string>",
"location_id": "<string>",
"organization_id": "<string>",
"tags": ["<string>"],
"referral": {
"physician_name": "<string>",
"physician_email": "<string>",
"physician_phone": "<string>",
"physician_fax": "<string>",
"physician_group": "<string>",
"physician_npi": "<string>",
"physician_address": "<string>",
"physician_address_2": "<string>",
"physician_city": "<string>",
"physician_zip": "<string>",
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"location_id": "<string>",
"icd_codes": ["<string>"],
"service_types": [],
"file_id": "<string>"
},
"custom_fields": {}
},
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policies": [
{
"insurance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insurance_name": "<string>",
"member_number": "<string>",
"subscriber": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"member_number": "<string>",
"address": "<string>",
"address2": "<string>",
"city": "<string>",
"zip": "<string>"
},
"group_number": "<string>",
"plan_name": "<string>",
"external_id": "<string>"
}
],
"file_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"specialties": [
{
"credentialing_id": "<string>",
"cpt_codes": ["<string>"],
"service_locations": [],
"icd_codes": ["<string>"]
}
],
"priority": False
}
headers = {
"X-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-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
patient: {
external_id: {type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'},
first_name: '<string>',
last_name: '<string>',
middle_name: '<string>',
date_of_birth: '<string>',
gender: '<string>',
phone_number: '<string>',
additional_phone_number: '<string>',
email: '<string>',
address: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
comments: '<string>',
assigned_user_id: '<string>',
location_id: '<string>',
organization_id: '<string>',
tags: ['<string>'],
referral: {
physician_name: '<string>',
physician_email: '<string>',
physician_phone: '<string>',
physician_fax: '<string>',
physician_group: '<string>',
physician_npi: '<string>',
physician_address: '<string>',
physician_address_2: '<string>',
physician_city: '<string>',
physician_zip: '<string>',
start_date: '2023-12-25',
end_date: '2023-12-25',
location_id: '<string>',
icd_codes: ['<string>'],
service_types: [],
file_id: '<string>'
},
custom_fields: {}
},
patient_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
policies: [
{
insurance_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
insurance_name: '<string>',
member_number: '<string>',
subscriber: {
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
dob: '2023-12-25',
member_number: '<string>',
address: '<string>',
address2: '<string>',
city: '<string>',
zip: '<string>'
},
group_number: '<string>',
plan_name: '<string>',
external_id: '<string>'
}
],
file_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
specialties: [
{
credentialing_id: '<string>',
cpt_codes: ['<string>'],
service_locations: [],
icd_codes: ['<string>']
}
],
priority: false
})
};
fetch('https://api.example.com/v1/verification-of-benefits-requests', 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.example.com/v1/verification-of-benefits-requests",
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([
'patient' => [
'external_id' => [
'type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>'
],
'first_name' => '<string>',
'last_name' => '<string>',
'middle_name' => '<string>',
'date_of_birth' => '<string>',
'gender' => '<string>',
'phone_number' => '<string>',
'additional_phone_number' => '<string>',
'email' => '<string>',
'address' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'comments' => '<string>',
'assigned_user_id' => '<string>',
'location_id' => '<string>',
'organization_id' => '<string>',
'tags' => [
'<string>'
],
'referral' => [
'physician_name' => '<string>',
'physician_email' => '<string>',
'physician_phone' => '<string>',
'physician_fax' => '<string>',
'physician_group' => '<string>',
'physician_npi' => '<string>',
'physician_address' => '<string>',
'physician_address_2' => '<string>',
'physician_city' => '<string>',
'physician_zip' => '<string>',
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'location_id' => '<string>',
'icd_codes' => [
'<string>'
],
'service_types' => [
],
'file_id' => '<string>'
],
'custom_fields' => [
]
],
'patient_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'policies' => [
[
'insurance_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'insurance_name' => '<string>',
'member_number' => '<string>',
'subscriber' => [
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'dob' => '2023-12-25',
'member_number' => '<string>',
'address' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'zip' => '<string>'
],
'group_number' => '<string>',
'plan_name' => '<string>',
'external_id' => '<string>'
]
],
'file_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'specialties' => [
[
'credentialing_id' => '<string>',
'cpt_codes' => [
'<string>'
],
'service_locations' => [
],
'icd_codes' => [
'<string>'
]
]
],
'priority' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-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.example.com/v1/verification-of-benefits-requests"
payload := strings.NewReader("{\n \"patient\": {\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"custom_fields\": {}\n },\n \"patient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"policies\": [\n {\n \"insurance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insurance_name\": \"<string>\",\n \"member_number\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"member_number\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"group_number\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n ],\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"specialties\": [\n {\n \"credentialing_id\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"service_locations\": [],\n \"icd_codes\": [\n \"<string>\"\n ]\n }\n ],\n \"priority\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-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.example.com/v1/verification-of-benefits-requests")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"patient\": {\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"custom_fields\": {}\n },\n \"patient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"policies\": [\n {\n \"insurance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insurance_name\": \"<string>\",\n \"member_number\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"member_number\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"group_number\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n ],\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"specialties\": [\n {\n \"credentialing_id\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"service_locations\": [],\n \"icd_codes\": [\n \"<string>\"\n ]\n }\n ],\n \"priority\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/verification-of-benefits-requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"patient\": {\n \"external_id\": {\n \"type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n },\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"gender\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"additional_phone_number\": \"<string>\",\n \"email\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"comments\": \"<string>\",\n \"assigned_user_id\": \"<string>\",\n \"location_id\": \"<string>\",\n \"organization_id\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"referral\": {\n \"physician_name\": \"<string>\",\n \"physician_email\": \"<string>\",\n \"physician_phone\": \"<string>\",\n \"physician_fax\": \"<string>\",\n \"physician_group\": \"<string>\",\n \"physician_npi\": \"<string>\",\n \"physician_address\": \"<string>\",\n \"physician_address_2\": \"<string>\",\n \"physician_city\": \"<string>\",\n \"physician_zip\": \"<string>\",\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"location_id\": \"<string>\",\n \"icd_codes\": [\n \"<string>\"\n ],\n \"service_types\": [],\n \"file_id\": \"<string>\"\n },\n \"custom_fields\": {}\n },\n \"patient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"policies\": [\n {\n \"insurance_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"insurance_name\": \"<string>\",\n \"member_number\": \"<string>\",\n \"subscriber\": {\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"dob\": \"2023-12-25\",\n \"member_number\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\"\n },\n \"group_number\": \"<string>\",\n \"plan_name\": \"<string>\",\n \"external_id\": \"<string>\"\n }\n ],\n \"file_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"specialties\": [\n {\n \"credentialing_id\": \"<string>\",\n \"cpt_codes\": [\n \"<string>\"\n ],\n \"service_locations\": [],\n \"icd_codes\": [\n \"<string>\"\n ]\n }\n ],\n \"priority\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "created"
},
"policies": [
{
"action": "matched",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "new_member_number",
"source": "request"
}
],
"verifications": [
{
"patient_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "opened",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reason": "no_service_type",
"left_out": [
"medical_care"
]
}
],
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"fields": [
{
"path": "<string>",
"code": "<string>",
"message": "<string>"
}
]
},
"completed_at": "2023-11-07T05:31:56Z"
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"meta": {}
}{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"meta": {}
}{
"type": "validation_error",
"code": "invalid_parameter",
"message": "Field validation failed",
"param": "phone_number"
}Authorizations
APIKeyHeaderHTTPBearer
Headers
Optional durable submission key. Reuse it with an identical body to retrieve the same request; use a new key for a corrected body.
Body
application/json
One intake: a patient, the coverage you know and the insurance cards you have. Solum reads the cards, stores the coverage and opens a verification of benefits (VOB) for every active policy of the patient.
The patient. Send this or patient_id.
Show child attributes
Show child attributes
An existing active patient. Send this or patient.
The coverage you know, one per tier. Send policies, file_ids, or both.
Maximum array length:
4Show child attributes
Show child attributes
1-15 insurance-card files uploaded through POST /v1/files (PDF, PNG or JPEG). Send policies, file_ids, or both.
Required array length:
1 - 15 elementsThe specialties to verify on every VOB, resolved as on POST /v1/verification-of-benefits. Omitted: each policy gets the specialties your company's configuration derives for it.
Minimum array length:
1Show child attributes
Show child attributes
Flag every VOB this request opens as a priority.
Response
Successful Response
Available options:
queued, processing, completed, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes