API Reference
Get policy by ID
Retrieve a single coverage policy by its ID with optional related data.
Authorization
bearerAuth AuthorizationBearer <token>
API keys are prefixed with vrt_live_ for production or vrt_test_ for testing.
Example: vrt_live_abc123xyz
In: header
Path Parameters
id*string
Policy ID (e.g., L33831)
Query Parameters
include?string
Comma-separated list of related data
_format?string
FHIR-standard output format parameter. When set, overrides the default JSON envelope
and returns FHIR R4 resources directly. Supports: json (FHIR JSON), application/fhir+json.
Use format=csv or format=fhir as convenience aliases.
Value in
"json" | "application/fhir+json"format?string
Output format. json (default Verity envelope), csv (CSV download), fhir (FHIR R4).
Default
"json"Value in
"json" | "csv" | "fhir"Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://verity.backworkai.com/api/v1/policies/L33831?include=criteria%2Ccodes%2Cattachments%2Cversions"{
"success": true,
"data": {
"policy_id": "string",
"title": "string",
"policy_type": "string",
"jurisdiction": "string",
"effective_date": "2019-08-24",
"retire_date": "2019-08-24",
"last_reviewed_date": "2019-08-24",
"version": "string",
"status": "string",
"source_url": "string",
"pdf_url": "string",
"description": "string",
"summary": "string",
"specialty": [
"string"
],
"keywords": [
"string"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"sections": {
"indications": "string",
"limitations": "string",
"documentation": "string"
},
"mac": {
"name": "Palmetto GBA",
"code": "11502",
"jurisdiction_name": "Jurisdiction M",
"states": [
"TX",
"OK",
"NM"
]
},
"payer": {
"name": "string",
"code": "string",
"type": "string"
},
"criteria": {
"property1": [
{
"block_id": "string",
"text": "string",
"logic_ast": {},
"tags": [
"string"
],
"requires_manual_review": true,
"confidence_score": 0.1
}
],
"property2": [
{
"block_id": "string",
"text": "string",
"logic_ast": {},
"tags": [
"string"
],
"requires_manual_review": true,
"confidence_score": 0.1
}
]
},
"criteria_count": 0,
"codes": {
"property1": [
{
"code": "string",
"display": "string",
"disposition": "covered",
"condition_reference": "string",
"notes": "string"
}
],
"property2": [
{
"code": "string",
"display": "string",
"disposition": "covered",
"condition_reference": "string",
"notes": "string"
}
]
},
"code_count": 0,
"attachments": [
{
"file_type": "string",
"url": "string",
"title": "string",
"page_number": 0,
"file_size_bytes": 0
}
],
"versions": [
{
"old_version": "string",
"new_version": "string",
"change_type": "string",
"change_summary": "string",
"changed_fields": [
"string"
],
"timestamp": "2019-08-24T14:15:22Z"
}
]
},
"meta": {
"includes": [
"string"
]
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}