curl --request PATCH \
--url https://api.example.com/v1/verification-of-benefits/{vob_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"version": 123,
"priority": true,
"specialties": [
{
"credentialing_id": "<string>",
"cpt_codes": [
"<string>"
],
"service_locations": [],
"icd_codes": [
"<string>"
]
}
]
}
'import requests
url = "https://api.example.com/v1/verification-of-benefits/{vob_id}"
payload = {
"version": 123,
"priority": True,
"specialties": [
{
"credentialing_id": "<string>",
"cpt_codes": ["<string>"],
"service_locations": [],
"icd_codes": ["<string>"]
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
version: 123,
priority: true,
specialties: [
{
credentialing_id: '<string>',
cpt_codes: ['<string>'],
service_locations: [],
icd_codes: ['<string>']
}
]
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'version' => 123,
'priority' => true,
'specialties' => [
[
'credentialing_id' => '<string>',
'cpt_codes' => [
'<string>'
],
'service_locations' => [
],
'icd_codes' => [
'<string>'
]
]
]
]),
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}"
payload := strings.NewReader("{\n \"version\": 123,\n \"priority\": true,\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}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/v1/verification-of-benefits/{vob_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"version\": 123,\n \"priority\": true,\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}")
.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::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"version\": 123,\n \"priority\": true,\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}"
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"
}Update a verification of benefits
Edits the request. version is required and must be current. priority and specialties can be changed while the VOB is pending or missing information; specialties replaces the whole set and is resolved like on create. Once Solum is working the VOB (in progress) or it is closed, an edit is refused with 400. A VOB’s status is Solum’s to change: a request that changes status is refused with 403 (to stop a VOB, use the cancel action). Answer missing information by editing the request or correcting the policy: Solum is notified on the VOB’s thread and resumes it. Omit a field to keep it; none accepts null.
curl --request PATCH \
--url https://api.example.com/v1/verification-of-benefits/{vob_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"version": 123,
"priority": true,
"specialties": [
{
"credentialing_id": "<string>",
"cpt_codes": [
"<string>"
],
"service_locations": [],
"icd_codes": [
"<string>"
]
}
]
}
'import requests
url = "https://api.example.com/v1/verification-of-benefits/{vob_id}"
payload = {
"version": 123,
"priority": True,
"specialties": [
{
"credentialing_id": "<string>",
"cpt_codes": ["<string>"],
"service_locations": [],
"icd_codes": ["<string>"]
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
version: 123,
priority: true,
specialties: [
{
credentialing_id: '<string>',
cpt_codes: ['<string>'],
service_locations: [],
icd_codes: ['<string>']
}
]
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'version' => 123,
'priority' => true,
'specialties' => [
[
'credentialing_id' => '<string>',
'cpt_codes' => [
'<string>'
],
'service_locations' => [
],
'icd_codes' => [
'<string>'
]
]
]
]),
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}"
payload := strings.NewReader("{\n \"version\": 123,\n \"priority\": true,\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}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/v1/verification-of-benefits/{vob_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"version\": 123,\n \"priority\": true,\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}")
.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::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"version\": 123,\n \"priority\": true,\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}"
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
Body
PATCH body for /v1/verification-of-benefits/{id}.
The VOB's current version; a stale one is refused.
A VOB's status is Solum's to move: a request that changes it is refused with 403. Cancel a VOB with the cancel action.
pending, in_progress, completed, missing_information, cancelled Omit to keep the current priority.
Replaces the whole set of specialties, resolved like on create. Clinics can edit them while the VOB is pending or missing information.
1Show child attributes
Show child attributes
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

