curl --request POST \
--url https://api.example.com/v1/verification-of-benefits/{vob_id}/review \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"reviewed": true
}
'import requests
url = "https://api.example.com/v1/verification-of-benefits/{vob_id}/review"
payload = { "reviewed": True }
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({reviewed: true})
};
fetch('https://api.example.com/v1/verification-of-benefits/{vob_id}/review', 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}/review",
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([
'reviewed' => true
]),
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/{vob_id}/review"
payload := strings.NewReader("{\n \"reviewed\": true\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/{vob_id}/review")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reviewed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/verification-of-benefits/{vob_id}/review")
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 \"reviewed\": true\n}"
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": {},
"sync": {
"status": "not_synced",
"attempted_at": "2023-11-07T05:31:56Z"
},
"clinic_reviewed_at": "2023-11-07T05:31:56Z",
"clinic_reviewed_by": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>",
"user_type": "<string>"
},
"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"
}Mark a verification of benefits reviewed
Marks one of your completed VOBs reviewed (reviewed: true) or reopens it (false). Your VOB board hides reviewed VOBs by default. Reviewing never changes the VOB’s status or version and posts nothing to its comments; marking a reviewed VOB again keeps who reviewed it first, and when. A VOB marked through an API key records no reviewer.
curl --request POST \
--url https://api.example.com/v1/verification-of-benefits/{vob_id}/review \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"reviewed": true
}
'import requests
url = "https://api.example.com/v1/verification-of-benefits/{vob_id}/review"
payload = { "reviewed": True }
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({reviewed: true})
};
fetch('https://api.example.com/v1/verification-of-benefits/{vob_id}/review', 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}/review",
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([
'reviewed' => true
]),
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/{vob_id}/review"
payload := strings.NewReader("{\n \"reviewed\": true\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/{vob_id}/review")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reviewed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/verification-of-benefits/{vob_id}/review")
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 \"reviewed\": true\n}"
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": {},
"sync": {
"status": "not_synced",
"attempted_at": "2023-11-07T05:31:56Z"
},
"clinic_reviewed_at": "2023-11-07T05:31:56Z",
"clinic_reviewed_by": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"image": "<string>",
"user_type": "<string>"
},
"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
Body
Body of POST /{id}/review: true marks a completed VOB reviewed,
false reopens it.
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
On a completed VOB, whether its results reached your integrations that sync VOBs (POST /{id}/sync pushes them); null while the VOB is not completed, or when none of your integrations syncs VOBs.
Show child attributes
Show child attributes
When your clinic marked this completed VOB reviewed (POST /{id}/review); null while it isn't. Reviewing never changes the VOB's status.
Who marked it reviewed; null while not reviewed, when it was marked through an API key, or when no reviewer is recorded.
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

