How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Veterans Affairs Higher-Level Reviews API

The Higher-Level Reviews API from Veterans Affairs — 10 operation(s) for higher-level reviews.

This API exposes 10 operations across 10 paths, and defines 30 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://sandbox-api.va.gov/services/appeals/{version}/decision_reviews, https://api.va.gov/services/appeals/{version}/decision_reviews, https://sandbox-api.va.gov/services/appeals/higher-level-reviews/{version}, https://api.va.gov/services/appeals/higher-level-reviews/{version}.

10 operations 10 paths 30 schemas 6 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.va.gov/services/benefits-intake/v2
Authentication
API Key, HTTP Bearer, OAuth 2.0, OAuth 2.0
Contact
developer.va.gov
Resource Areas
1

Authentication & Security 4

Veterans Affairs Higher-Level Reviews API declares 4 security schemes for authenticating requests. An API key is passed in the header as apikey (apikey). It accepts HTTP bearer tokens (JWT) (bearer_token). It supports OAuth 2.0 (productionOauth) using the authorizationCode and clientCredentials flows, exposing 12 scopes. It supports OAuth 2.0 (sandboxOauth) using the authorizationCode and clientCredentials flows, exposing 12 scopes.

  • productionOauth — The authentication model for the Higher-Level Reviews API uses OAuth 2.0/OpenID Connect. The following authorization models are supported: [Authorization code…
  • sandboxOauth — The authentication model for the Higher-Level Reviews API uses OAuth 2.0/OpenID Connect. The following authorization models are supported: [Authorization code…

Paths & Operations 10

Across 10 paths, the API surfaces 10 operations — 6 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Higher-Level Reviews 10
POST
/higher_level_reviews
Creates a new Higher-Level Review
createHlr 15 params body → 200422500
GET
/higher_level_reviews/{uuid}
Shows a specific Higher-Level Review. (a.k.a. the Show endpoint)
showHlr 1 param → 200404500
GET
/higher_level_reviews/contestable_issues/{benefit_type}
Returns all contestable issues for a specific veteran
hlrContestableIssues 5 params → 200404422500502
GET
/higher_level_reviews/schema
Gets the Higher-Level Review JSON Schema
hlrSchema → 200500
POST
/higher_level_reviews/validate
Validates a POST request body against the JSON schema
hlrValidate 15 params body → 200422500
POST
/forms/200996
Creates a new Higher-Level Review
postForms200996 body → 201400403422500
GET
/forms/200996/{id}
Show a specific Higher-Level Review
getForms200996ById 1 param → 200403404500
GET
/forms/200996/{id}/download
Download a watermarked copy of a submitted Higher-Level Review
downloadHlr 2 params → 200400403404410422500
GET
/schemas/{schema_type}
Gets JSON schema related to Higher-Level Review
getSchemasBySchemaType 1 param → 200404500
POST
/forms/200996/validate
Validates a POST request body against the JSON schema
postForms200996Validate body → 200400422500

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are address (8 properties), hlrCreatePhone (4 properties), phone (4 properties), contestableIssue (3 properties). Each schema is shown below with its type and property counts.

X-VA-Birth-Date
string
Veteran's birth date
hlrCreatePhone
object
4 properties 1 required
contestableIssue
object
A contestable issue (to contest this, you include it as a RequestIssue when creating a HigherLevelReview, SupplementalClaim, or Appeal)
3 properties
hlrCreate
object
2 properties 2 required
hlrShow
object
1 property 1 required
X-VA-NonVeteranClaimant-First-Name
X-VA-Insurance-Policy-Number
X-VA-ICN
string
Veteran's Integration Control Number, a unique identifier established via the Master Person Index (MPI)
X-VA-NonVeteranClaimant-Last-Name
X-VA-Receipt-Date
string
(yyyy-mm-dd) Date to limit the contestable issues
X-VA-NonVeteranClaimant-Middle-Initial
X-VA-File-Number
nonBlankString
string
X-VA-NonVeteranClaimant-Birth-Date
string
Non-veteran claimant's birth date
errorModel
object
1 property 1 required
X-VA-Last-Name
uuid
string
X-VA-SSN
string
social security number
contestableIssues
object
1 property
X-VA-Middle-Initial
X-VA-First-Name
X-VA-NonVeteranClaimant-SSN
string
Non-Veteran claimants's SSN
ssn
string
Social Security Number
phone
object
4 properties 2 required
timezone
string
hlrCreate_2
object
JSON Schema for VA Form 20-0996
2 properties 2 required
icn
string
Veteran's Master Person Index (MPI) Integration Control Number (ICN)
address
object
8 properties 4 required
hlrShow_2
object
1 property 1 required
fileNumber
string
Veteran's VA file number (c-file / css)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

va-higher-level-reviews-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Veterans Affairs Higher-Level Reviews API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.