curl --request GET \
--url https://api.example.com/v1/verification-of-benefits/{vob_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/v1/verification-of-benefits/{vob_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.example.com/v1/verification-of-benefits/{vob_id}', 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/{vob_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/verification-of-benefits/{vob_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/verification-of-benefits/{vob_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/verification-of-benefits/{vob_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_id": "<string>",
"version": 123,
"status": "<string>",
"patient_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": false,
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"reviewer_user_id": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"completed_by_user_id": "<string>",
"missing_information_since": "2023-11-07T05:31:56Z",
"sla_paused_seconds": 0,
"backfilled": false,
"specialties": [],
"result_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {},
"created_by": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>",
"user_type": "<string>"
},
"patient": {},
"missing_information_ask": {
"comment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"missing_information_answered_at": "2023-11-07T05:31:56Z",
"auto_cancel_on": "2023-12-25",
"cancellation": {
"reason": "<string>",
"cancelled_at": "2023-11-07T05:31:56Z",
"cancelled_by": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>",
"user_type": "<string>"
}
}
}{
"type": "validation_error",
"code": "invalid_parameter",
"message": "Field validation failed",
"param": "phone_number"
}Get a verification of benefits
Returns the VOB — its policy, requested specialties, creator and patient — and its result: the benefits Solum verified, with services and location rates, read-only; null until anything has been written.
curl --request GET \
--url https://api.example.com/v1/verification-of-benefits/{vob_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.example.com/v1/verification-of-benefits/{vob_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.example.com/v1/verification-of-benefits/{vob_id}', 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/{vob_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/verification-of-benefits/{vob_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/verification-of-benefits/{vob_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/verification-of-benefits/{vob_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by_id": "<string>",
"version": 123,
"status": "<string>",
"patient_policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"priority": false,
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"reviewer_user_id": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"completed_by_user_id": "<string>",
"missing_information_since": "2023-11-07T05:31:56Z",
"sla_paused_seconds": 0,
"backfilled": false,
"specialties": [],
"result_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {},
"created_by": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>",
"user_type": "<string>"
},
"patient": {},
"missing_information_ask": {
"comment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"missing_information_answered_at": "2023-11-07T05:31:56Z",
"auto_cancel_on": "2023-12-25",
"cancellation": {
"reason": "<string>",
"cancelled_at": "2023-11-07T05:31:56Z",
"cancelled_by": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>",
"user_type": "<string>"
}
}
}{
"type": "validation_error",
"code": "invalid_parameter",
"message": "Field validation failed",
"param": "phone_number"
}Authorizations
Path Parameters
Response
Successful Response
One VOB as its own endpoints return it (get, create, update, cancel):
VobOut plus what the VOB's page shows beside the request.
Show child attributes
Show child attributes
The id of the VOB's result (result.id), on the list with or without include=result; null while it has none.
Show child attributes
Show child attributes
While the VOB is missing information: the latest comment in which Solum asked for it. Null in any other status, or while nobody has asked yet.
Show child attributes
Show child attributes
Your latest comment after that ask (your update notes included); null until you answer.
The date Solum will cancel the VOB if the ask stays unanswered, once Solum has warned. Null once you have answered (missing_information_answered_at is set): an answered VOB is not cancelled.
Set once the VOB is cancelled.
Show child attributes
Show child attributes

