{ "openapi": "3.1.0", "info": { "title": "VetPulse API", "description": "Global veterans benefits intelligence API. AI-synthesized guidance on disability compensation, Aid & Attendance-style pensions, TDIU/unemployability, claim strategy, caregiver stipends, education benefits, state/regional benefits, healthcare, and home-loan assistance — covering the US (VA), UK (Veterans UK, AFCS, WPS), Canada (VAC), Australia (DVA), New Zealand, and Germany (Bundeswehr Versorgung), with best-effort support for any other country via the ?country= parameter. Surfaces the benefits most veterans never claim. All endpoints return structured JSON and require x402 micropayment (USDC on Base mainnet) via the PAYMENT-SIGNATURE header. All endpoints support any language via ?lang= parameter.", "version": "1.3.0", "contact": { "url": "https://vetpulse.theaslangroupllc.com" } }, "servers": [ { "url": "https://vetpulse.theaslangroupllc.com" } ], "components": { "securitySchemes": { "x402": { "type": "apiKey", "in": "header", "name": "PAYMENT-SIGNATURE", "description": "x402 payment signature (USDC on Base mainnet). Send a GET request without this header to receive a 402 Payment Required response with payment details in the PAYMENT-REQUIRED header. Sign the payment and retry.", "required": true } } }, "security": [ { "x402": [] } ], "paths": { "/api/vet/disability": { "get": { "summary": "Veteran disability rating analysis (US, UK, Canada, Australia, NZ, Germany)", "description": "Analyzes likely disability ratings per condition for the country specified, applies the relevant combined-rating math (US VA whole-person formula, UK AFCS/WPS tariff, Canadian VAC assessment table, Australian DVA impairment rating, etc.), projects monthly compensation, assesses presumptive/toxic-exposure conditions (e.g. US PACT Act), identifies secondary conditions worth adding, and outlines evidence/nexus-letter topics. Pass ?country= for UK, Canada, Australia, New Zealand, Germany, or any other nation; defaults to US guidance if omitted and not inferable.", "operationId": "vetDisability", "x-price-usd": 0.15, "x-agent-use-case": "on-demand", "x-agent-chaining": "Follow with /api/vet/claim-builder to build the evidence package; follow with /api/vet/tdiu if combined rating may reach 60%+", "parameters": [ { "name": "conditions", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Comma-separated medical conditions (e.g. 'tinnitus,PTSD,lumbar strain,sleep apnea')" }, { "name": "service_era", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Service era for presumptive condition assessment (e.g. 'Vietnam', 'Gulf War', 'OEF', 'OIF', 'Korea')" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country whose veteran disability system to assess: US, UK, Canada, Australia, New Zealand, or Germany (other countries supported on a best-effort basis). Defaults to US if omitted and cannot be inferred." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language \u2014 any language supported" } ], "responses": { "200": { "description": "Disability rating analysis with compensation projections and claim strategy" }, "402": { "description": "Payment required \u2014 see PAYMENT-REQUIRED header for x402 payment details" } } } }, "/api/vet/aid-attendance": { "get": { "summary": "Veteran pension / Aid & Attendance-style eligibility (US, UK, Canada, Australia, NZ, Germany)", "description": "Assesses VA Aid & Attendance pension eligibility (US) \u2014 the most underutilized major VA benefit, worth up to $2,727/month for a veteran couple \u2014 or the equivalent care-needs pension/allowance elsewhere (UK AFCS/WPS attendance allowance, Canada VAC Attendance Allowance, Australia DVA attendant-care support, New Zealand and Germany equivalents). Covers pension rates by family status, net worth/income limits, medical expense deductions, and qualifying service period. Pass ?country= for a non-US assessment; defaults to US guidance if omitted and not inferable.", "operationId": "vetAidAttendance", "x-price-usd": 0.15, "x-agent-use-case": "on-demand", "x-agent-chaining": "Pairs with SeniorPulse /api/senior/veterans for surviving spouses; follow with /api/vet/claim-builder for application strategy", "parameters": [ { "name": "age", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Veteran age" }, { "name": "needs", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Care needs description (e.g. 'requires daily assistance with bathing, dressing, and medication management')" }, { "name": "income", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Monthly gross income in USD (Social Security, pension, other)" }, { "name": "assets", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Total net worth in USD excluding primary home and one vehicle" }, { "name": "care_cost", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Monthly unreimbursed care costs in USD \u2014 deducted from income for pension calculation" }, { "name": "surviving_spouse", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Set true if applicant is a surviving spouse of a veteran \u2014 unlocks Survivors Pension and different Aid & Attendance rates" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country whose veteran pension/care-allowance system to assess: US, UK, Canada, Australia, New Zealand, or Germany (other countries supported on a best-effort basis). Defaults to US if omitted and cannot be inferred." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language \u2014 any language supported" } ], "responses": { "200": { "description": "Aid & Attendance eligibility assessment with estimated monthly benefit and application steps" }, "402": { "description": "Payment required" } } } }, "/api/vet/tdiu": { "get": { "summary": "TDIU / unemployability eligibility (US, UK, Canada, Australia, NZ, Germany)", "description": "Assesses TDIU eligibility (US) \u2014 pays at the 100% disability rate regardless of actual combined rating \u2014 or the closest equivalent elsewhere: Australia's Totally and Permanently Incapacitated (TPI) pension, Canada's Diminished Earning Capacity/Income Replacement Benefit, UK's AFCS Guaranteed Income Payment, and New Zealand/Germany equivalents. Covers the schedular pathway, extraschedular pathway, income/employment thresholds, evidence requirements, and application process. Pass ?country= for a non-US assessment; defaults to US guidance if omitted and not inferable.", "operationId": "vetTdiu", "x-price-usd": 0.15, "x-agent-use-case": "on-demand", "x-agent-chaining": "Use after /api/vet/disability to assess TDIU eligibility based on identified ratings; follow with /api/vet/claim-builder for evidence strategy", "parameters": [ { "name": "rating", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Current combined disability rating (e.g. '70' or '60')" }, { "name": "work_history", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Work history and current work status (e.g. 'cannot maintain substantially gainful employment due to PTSD and chronic pain')" }, { "name": "income", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Current annual income \u2014 TDIU requires below federal poverty threshold for marginal employment (~$15,000)" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country whose unemployability/full-compensation system to assess: US, UK, Canada, Australia, New Zealand, or Germany (other countries supported on a best-effort basis). Defaults to US if omitted and cannot be inferred." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language \u2014 any language supported" } ], "responses": { "200": { "description": "TDIU eligibility assessment with pathway analysis and application strategy" }, "402": { "description": "Payment required" } } } }, "/api/vet/claim-builder": { "get": { "summary": "Veteran disability claim evidence strategy (US, UK, Canada, Australia, NZ, Germany)", "description": "Builds a complete evidence strategy for a disability claim under the VA (US), Veterans UK/AFCS, VAC (Canada), DVA (Australia), or New Zealand/Germany claims process. Returns: which records to request, buddy/witness statement structure, exam preparation tactics, nexus/causation letter topics, secondary conditions worth adding, and prioritized claim strategy adapted to the country's actual forms and appeal lanes. The highest-value VetPulse endpoint \u2014 prevents the most common claim mistakes that lead to years of delays. Pass ?country= for a non-US assessment; defaults to US guidance if omitted and not inferable.", "operationId": "vetClaimBuilder", "x-price-usd": 0.2, "x-agent-use-case": "on-demand", "x-agent-chaining": "Use after /api/vet/disability to build evidence for identified conditions; the output of this endpoint feeds directly into claim preparation \u2014 agents building veteran advocacy workflows should call this before any filing guidance", "parameters": [ { "name": "conditions", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Comma-separated conditions to build evidence strategy for (e.g. 'PTSD,sleep apnea,hypertension,tinnitus')" }, { "name": "service_era", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Service era (e.g. 'Vietnam', 'Gulf War', 'OEF', 'OIF')" }, { "name": "current_rating", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Current combined rating if filing a supplemental or new claim" }, { "name": "previous_denials", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Description of any previous claim denials \u2014 affects strategy (HLR vs. Board appeal vs. supplemental)" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country whose claims process to build the evidence strategy for: US, UK, Canada, Australia, New Zealand, or Germany (other countries supported on a best-effort basis). Defaults to US if omitted and cannot be inferred." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language \u2014 any language supported" } ], "responses": { "200": { "description": "Evidence strategy brief with records to gather, exam prep, nexus letter topics, and secondary conditions" }, "402": { "description": "Payment required" } } } }, "/api/vet/caregiver": { "get": { "summary": "Veteran family caregiver stipend and benefits (US, UK, Canada, Australia, NZ, Germany)", "description": "PCAFC (US Program of Comprehensive Assistance for Family Caregivers) eligibility and benefits \u2014 monthly stipend from approximately $800 to $3,300+/month plus CHAMPVA and respite care \u2014 or the equivalent elsewhere: Canada's VAC Caregiver Recognition Benefit, Australia's DVA Carer Allowance/Payment, and UK/New Zealand/Germany caregiver support. Eligible for family caregivers of veterans with a serious injury or illness incurred or aggravated in the line of duty. Pass ?country= for a non-US assessment; defaults to US guidance if omitted and not inferable.", "operationId": "vetCaregiver", "x-price-usd": 0.1, "x-agent-use-case": "on-demand", "x-agent-chaining": "Follow with /api/vet/healthcare for CHAMPVA health coverage details for dependents; pairs with SeniorPulse /api/senior/caregiver for aging veteran caregiver situations", "parameters": [ { "name": "service_era", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Veteran's service era (e.g. 'post-9/11', 'Vietnam')" }, { "name": "condition", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Veteran's condition(s) requiring care" }, { "name": "caregiver_relationship", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Caregiver's relationship to veteran (e.g. 'spouse')" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" }, "description": "US state/region (helps infer country if omitted)" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country whose caregiver system to assess: US, UK, Canada, Australia, New Zealand, Germany. Defaults to US." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language" } ], "responses": { "200": { "description": "PCAFC eligibility assessment with stipend estimate, CHAMPVA details, and application steps" }, "402": { "description": "Payment required" } } } }, "/api/vet/education": { "get": { "summary": "Veteran education benefit comparison (US GI Bill; UK, Canada, Australia, NZ, Germany equivalents)", "description": "Compares GI Bill chapters for the US (Chapter 33, 30, 35, 1606, plus Chapter 31 Vocational Rehab) or the closest real equivalents elsewhere: UK Enhanced/Standard Learning Credits, Canada's VAC Education and Training Benefit, Australia's DVA education schemes, and New Zealand/Germany vocational-training support. The GI Bill's scale has no exact 1:1 foreign equivalent \u2014 non-US responses name the real program and are direct about scope. Pass ?country= for a non-US assessment; defaults to US guidance if omitted and not inferable.", "operationId": "vetEducation", "x-price-usd": 0.1, "x-agent-use-case": "on-demand", "x-agent-chaining": "Use before /api/vet/state-benefits to find state tuition waivers that stack with GI Bill; pairs with CareerPulse for career transition planning post-service", "parameters": [ { "name": "chapter", "in": "query", "required": false, "schema": { "type": "string" }, "description": "GI Bill chapter of interest (e.g. '33', '30', '35', '1606') \u2014 or omit for full comparison" }, { "name": "branch", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Military branch \u2014 affects reserve component benefit calculations" }, { "name": "school_location", "in": "query", "required": false, "schema": { "type": "string" }, "description": "School city and state \u2014 used to estimate monthly housing allowance (E-5 with dependent BAH rate)" }, { "name": "dependents", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Whether veteran has dependents \u2014 affects DEA transferability and some benefit calculations" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country whose education benefit system to assess: US, UK, Canada, Australia, New Zealand, or Germany (other countries supported on a best-effort basis). Defaults to US if omitted and cannot be inferred." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language \u2014 any language supported" } ], "responses": { "200": { "description": "GI Bill comparison with estimated benefits, housing allowance, and Voc Rehab analysis" }, "402": { "description": "Payment required" } } } }, "/api/vet/state-benefits": { "get": { "summary": "State/regional veteran benefits (US states; UK, Canada, Australia, NZ, Germany regions)", "description": "Comprehensive regional veteran benefit analysis for any US state (property tax exemptions, tuition waivers, employment preference, DMV/hunting-fishing benefits, burial benefits, state veterans homes) or the equivalent sub-national programs elsewhere: UK devolved nations/local authorities, Canadian provinces, Australian states/territories, and New Zealand/German regions. Most veterans claim fewer than 25% of available regional benefits. Pass ?country= (or a recognized region name in ?state=) for a non-US assessment; defaults to US guidance if omitted and not inferable.", "operationId": "vetStateBenefits", "x-price-usd": 0.1, "x-agent-use-case": "on-demand", "x-agent-chaining": "Always pair with /api/vet/disability \u2014 most state benefits are enhanced for 100% or P&T ratings; follow with SeniorPulse /api/senior/property-tax for additional senior-specific property tax relief that stacks", "parameters": [ { "name": "state", "in": "query", "required": true, "schema": { "type": "string" }, "description": "US state, UK devolved nation/council, Canadian province, Australian state/territory, or other region name (e.g. 'Texas', 'Scotland', 'Ontario', 'Queensland')" }, { "name": "disability_rating", "in": "query", "required": false, "schema": { "type": "string" }, "description": "VA disability rating percentage \u2014 many state benefits require minimum rating (e.g. '70', '100', 'P&T')" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country the region belongs to: US, UK, Canada, Australia, New Zealand, or Germany (other countries supported on a best-effort basis). Inferred from a recognized region name if omitted; defaults to US otherwise." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language \u2014 any language supported" } ], "responses": { "200": { "description": "State veteran benefits analysis with eligibility, estimated value, and application steps" }, "402": { "description": "Payment required" } } } }, "/api/vet/healthcare": { "get": { "summary": "Veteran healthcare priority/coverage analysis (US, UK, Canada, Australia, NZ, Germany)", "description": "Determines VA healthcare priority group placement (US, 1\u20138) and copay schedules, or the equivalent elsewhere: UK NHS veteran priority treatment and Op COURAGE, Canada's VAC health/treatment benefits, Australia's DVA Gold Card/White Card, and New Zealand/Germany veteran healthcare entitlements. Covers dependent coverage (e.g. CHAMPVA), community/civilian care eligibility, mental health access, and coordination with the national health system. Pass ?country= for a non-US assessment; defaults to US guidance if omitted and not inferable.", "operationId": "vetHealthcare", "x-price-usd": 0.08, "x-agent-use-case": "on-demand", "x-agent-chaining": "Follow with SeniorPulse /api/senior/medicare for aging veterans coordinating VA healthcare with Medicare; pairs with SeniorPulse /api/senior/meds for medication safety review using VA formulary context", "parameters": [ { "name": "priority_group", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Current VA priority group if known (1\u20138)" }, { "name": "income", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Annual household income \u2014 affects priority group 5\u20138 placement and copay amounts" }, { "name": "disability_rating", "in": "query", "required": false, "schema": { "type": "string" }, "description": "VA disability rating \u2014 service-connected veterans (any rating) are Priority Group 1\u20133" }, { "name": "dependents", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Set true to include CHAMPVA coverage analysis for dependents" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country whose veteran healthcare system to assess: US, UK, Canada, Australia, New Zealand, or Germany (other countries supported on a best-effort basis). Defaults to US if omitted and cannot be inferred." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language \u2014 any language supported" } ], "responses": { "200": { "description": "VA healthcare priority group placement with copay schedule and coverage analysis" }, "402": { "description": "Payment required" } } } }, "/api/vet/home-loan": { "get": { "summary": "Veteran home-buying assistance analysis (US VA loan; Australia DHOAS; UK Forces Help to Buy)", "description": "Analyzes VA home loan advantages for a specific US purchase scenario (funding fee exemption, no PMI, COE process, entitlement restoration), or the closest real equivalent elsewhere: Australia's Defence Home Ownership Assistance Scheme (DHOAS) interest-rate subsidy, or the UK's Forces Help to Buy interest-free deposit loan. Canada, New Zealand, and Germany have no dedicated veteran home-loan guaranty \u2014 the response says so plainly and points to general first-time-buyer assistance instead. The VA loan guaranty has no direct 1:1 foreign equivalent; pass ?country= for a non-US assessment.", "operationId": "vetHomeLoan", "x-price-usd": 0.08, "x-agent-use-case": "on-demand", "x-agent-chaining": "Pairs with PropPulse /api/prop/mortgage for full mortgage analysis; follow with /api/vet/state-benefits to identify state housing assistance that stacks with VA loan", "parameters": [ { "name": "disability_rating", "in": "query", "required": false, "schema": { "type": "string" }, "description": "VA disability rating \u2014 any service-connected rating eliminates funding fee (saves $5k\u2013$15k)" }, { "name": "purchase_price", "in": "query", "required": false, "schema": { "type": "number" }, "description": "Target home purchase price in USD \u2014 used to calculate funding fee savings and PMI comparison" }, { "name": "prior_va_loan", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Whether veteran has used a VA loan before \u2014 triggers entitlement restoration guidance" }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string" }, "description": "State of purchase \u2014 for state housing assistance programs that stack with VA loan" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country whose home-buying assistance to assess: US, UK, Canada, Australia, New Zealand, or Germany (other countries supported on a best-effort basis). Note: the VA loan guaranty has no direct 1:1 equivalent outside the US. Defaults to US if omitted and cannot be inferred." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language \u2014 any language supported" } ], "responses": { "200": { "description": "VA home loan analysis with funding fee savings, PMI comparison, COE guidance, and stacking programs" }, "402": { "description": "Payment required" } } } }, "/api/vet/discounts": { "get": { "summary": "Verified veteran discounts by category (US, UK, Canada, Australia, NZ, Germany)", "description": "Returns verified veteran discounts organized by category. US: airlines, hotels, retail (Home Depot, Lowe's, Amazon Prime Military), dining, the America the Beautiful national parks pass, and financial services (USAA, Navy Federal, PenFed). UK: Defence Discount Service and Blue Light Card retailer discounts. Australia: RSL-partner discounts. New Zealand: RSA-partner discounts. Canada and Germany: less centralized \u2014 the response surfaces what's verifiable and is honest where no broad program exists. Pass ?country= for a non-US assessment; defaults to US guidance if omitted and not inferable.", "operationId": "vetDiscounts", "x-price-usd": 0.05, "x-agent-use-case": "on-demand", "x-agent-chaining": "Chain at end of any veteran benefit discovery workflow \u2014 highest query volume, lowest cost; good for consumer-facing veteran agents as a value-add endpoint after disability or state benefits queries", "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "travel", "retail", "dining", "recreation", "financial", "all" ] }, "description": "Discount category. Defaults to all." }, { "name": "disability_rating", "in": "query", "required": false, "schema": { "type": "string" }, "description": "VA disability rating \u2014 some discounts (national parks pass, additional state benefits) require service-connected disability" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Country whose veteran discount landscape to search: US, UK, Canada, Australia, New Zealand, or Germany (other countries supported on a best-effort basis). Defaults to US if omitted and cannot be inferred." }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Response language \u2014 any language supported" } ], "responses": { "200": { "description": "Verified veteran discounts by category with eligibility requirements and access instructions" }, "402": { "description": "Payment required" } } } } } }