openapi: 3.0.1
info:
title: Address Validation 5103 Waiver Disability API
description: "The Address Validation API accepts and validates an address and standardizes it for mailing. It can also help you process an address by:\n* Inferring missing or incorrect address components\n* Supplementing an address with additional information, such as geocode, latitude and longitude, and postal service metadata (when available)\n## Technical Overview\nThe Address Validation API returns validated addresses as they appear in the USPS database for domestic addresses. It validates by separating the address into individual components and then providing component-level validation checks.\n\nThis API is certified by the United States Postal Service (USPS) Coding Accuracy Support System (CASS) and adheres to [United States Postal Service (USPS) Publication 28 standards](https://pe.usps.com/text/pub28/welcome.htm) for domestic, military, and US territory addresses.\n\nFor international addresses, validation relies on Universal Postal Union (UPU) standards. \n\n## Validation\nIf an address is found, it is considered valid based on metadata returned by the Address Validation service, such as the confidence score and the [Delivery Point Validation (DPV)](https://postalpro.usps.com/address-quality/dpv).\n\nIf an address is found, there are multiple checks performed on the validated address. The address can fail validation for a variety of reasons, such as the inability to deliver (for domestic mailing addresses) or the format. For specific reasons why an address failed, refer to the error messages returned.\n\nIf an address is not found, it automatically fails validation.\n\n## Address override indicator\nSometimes an entered address is accurate for a Veteran but does not pass validation rules. These instances can occur when an address is newer than what is in the CASS software or in regions where address data is less accurate.\n\nSystems can accept these addresses despite the lack of address validation by submitting an \"accepted address\" (usually confirmed by the Veteran) to the Contact Information API (see Requirements below). An address is considered accepted after the address has been sent to the validation API and has failed validation, but the Veteran has confirmed the address is correct as entered. The accepted address can then be passed to the Contact Information API using an address override indicator set to show that the validation was overridden. To set an override indicator, the original address and the `overrideValidationKey` returned in the validation API response must be provided to the Contact Information API, in order to prove that a validation attempt has been made before overriding.\n\n## Version Interoperability\n\nTo ensure interoperability between APIs and eliminate the need for transforming data as one API feeds into the other, we strongly recommend using versions of the following APIs that are compatible.\n\n| <h3>If Using</h3> | <h3>Then Use...</h3> |\n| :------------------------------:|:----------------------------------------------:|\n| Address Validation API v1/v2 | Contact Information API v1<br><br>Profile Service API v1/v2 |\n| Address Validation API v3 | Contact Information API v2<br><br>Profile Service API v3 |\n\n## Authorization\nAPI requests are authorized through a symmetric API token provided in an HTTP header with name apikey.\n\n**Important**: To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us)."
license:
name: Creative Commons
url: https://developer.va.gov/terms-of-service
version: '3'
servers:
- url: https://sandbox-api.va.gov/services/address-validation/{version}
description: Sandbox
variables:
version:
default: v3
- url: https://api.va.gov/services/address-validation/{version}
description: Production
variables:
version:
default: v3
security:
- apikey: []
tags:
- name: Disability
description: Used for 526 claims.
paths:
/forms/526:
get:
summary: Get a 526 schema for a claim.
deprecated: true
tags:
- Disability
operationId: GET:/forms/526
description: 'Returns a single 526 schema to automatically generate a form. Using this GET endpoint allows users to download our current validations.
'
responses:
'200':
description: schema response
content:
application/json:
example:
data:
- $schema: http://json-schema.org/draft-07/schema#
description: Claims API 526 Schema
type: object
additionalProperties: false
required:
- veteran
- serviceInformation
- disabilities
- standardClaim
- autoCestPDFGenerationDisabled
properties:
veteran:
description: Veteran Object being submitted in Claim
type: object
additionalProperties: false
required:
- currentMailingAddress
- currentlyVAEmployee
properties:
flashes:
description: Attributes that describe special circumstances which apply to a Veteran.
type: array
items:
type: string
enum:
- Agent Orange - Vietnam
- Amyotrophic Lateral Sclerosis
- Blind
- Blue Water Navy
- Formerly Homeless
- GW Undiagnosed Illness
- Hardship
- Homeless
- Medal of Honor
- POW
- Priority Processing - Veteran over age 85
- Purple Heart
- Seriously Injured/Very Seriously Injured
- Specially Adapted Housing Claimed
- Terminally Ill
example: Hardship
currentlyVAEmployee:
type: boolean
description: Flag if Veteran is VA Employee.
example: false
currentMailingAddress:
description: Current Mailing Address Object being submitted.
type: object
additionalProperties: false
properties:
addressLine1:
description: Address Veteran resides in.
type: string
pattern: ^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$
maxLength: 30
example: 1234 Couch Street
addressLine2:
description: Additional Address Information Veteran resides in.
type: string
pattern: ^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$
maxLength: 10
example: Apt. 22
addressLine3:
description: Additional Address Information Veteran resides in.
type: string
pattern: ^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$
maxLength: 10
example: Box 123
city:
description: City Veteran resides in.
type: string
pattern: ^([-a-zA-Z0-9'.#]([-a-zA-Z0-9'.# ])?)+$
maxLength: 20
example: Portland
country:
description: Country Veteran resides in. Value must match the values returned by the "/countries" endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).
type: string
example: USA
zipFirstFive:
description: Zipcode (First 5 digits) Veteran resides in.
type: string
pattern: ^\d{5}?$
example: '12345'
zipLastFour:
description: Zipcode (Last 4 digits) Veteran resides in.
type: string
pattern: ^\d{4}?$
example: '6789'
internationalPostalCode:
type: string
type:
description: "Type of residence Veteran resides in. \n If value is \"INTERNATIONAL\", then \"addressLine1\", \"city\", \"country\", and \"internationalPostalCode\" are required. \n If value is \"DOMESTIC\", then \"addressLine1\", \"city\", \"state\", \"country\", and \"zipFirstFive\" are required. \n If value is \"MILITARY\", then \"addressLine1\", \"country\", \"militaryStateCode\", \"militaryPostOfficeTypeCode\", and \"zipFirstFive\" are required."
type: string
default: DOMESTIC
enum:
- INTERNATIONAL
- MILITARY
- DOMESTIC
example: DOMESTIC
state:
description: State or province Veteran resides in.
type: string
pattern: ^[a-z,A-Z]{2}$
example: OR
allOf:
- if:
properties:
type:
const: INTERNATIONAL
then:
required:
- addressLine1
- city
- country
- type
- internationalPostalCode
- if:
properties:
type:
const: DOMESTIC
then:
required:
- addressLine1
- city
- country
- zipFirstFive
- type
- state
- if:
properties:
type:
const: MILITARY
then:
required:
- addressLine1
- country
- zipFirstFive
- militaryStateCode
- militaryPostOfficeTypeCode
- type
changeOfAddress:
description: A Change of Address Object being submitted.
type: object
additionalProperties: false
required:
- country
- type
- addressLine1
- addressChangeType
- beginningDate
properties:
beginningDate:
description: Date in YYYY-MM-DD the Veteran changed address. Date must be in the future if change is temporary.
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
type: string
example: '2018-06-04'
endingDate:
description: Date in YYYY-MM-DD the changed address expires, if change is temporary.
type: string
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
example: '2018-06-04'
addressChangeType:
description: Temporary or Permanent change of address.
type: string
example: PERMANENT
addressLine1:
description: New Address Veteran resides in.
type: string
pattern: ^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$
maxLength: 30
example: 1234 Couch Street
addressLine2:
description: New Additional Address Information Veteran resides in.
type: string
pattern: ^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$
maxLength: 30
example: Apt. 22
city:
description: New city Veteran resides in.
type: string
pattern: ^([-a-zA-Z0-9'.#]([-a-zA-Z0-9'.# ])?)+$
maxLength: 20
example: Portland
country:
description: New country Veteran resides in. Value must match the values returned by the "/countries" endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).
type: string
example: USA
zipFirstFive:
description: New zipcode (First 5 digits) Veteran resides in.
type: string
pattern: ^\d{5}?$
example: '12345'
zipLastFour:
description: New zipcode (Last 4 digits) Veteran resides in.
type: string
pattern: ^\d{4}?$
example: '6789'
internationalPostalCode:
type: string
type:
description: "New type of residence Veteran resides in. \n If value is \"INTERNATIONAL\", then \"city\" and \"internationalPostalCode\" are required. \n If value is \"DOMESTIC\", then \"city\", \"state\", and \"zipFirstFive\" are required. \n If value is \"MILITARY\", then \"militaryStateCode\", \"militaryPostOfficeTypeCode\", and \"zipFirstFive\" are required."
type: string
default: DOMESTIC
enum:
- INTERNATIONAL
- MILITARY
- DOMESTIC
example: DOMESTIC
militaryStateCode:
type: string
militaryPostOfficeTypeCode:
type: string
state:
description: New state or province Veteran resides in.
type: string
pattern: ^[a-z,A-Z]{2}$
example: OR
allOf:
- if:
properties:
type:
const: INTERNATIONAL
then:
required:
- city
- internationalPostalCode
- if:
properties:
type:
const: DOMESTIC
then:
required:
- city
- zipFirstFive
- state
- if:
properties:
type:
const: MILITARY
then:
required:
- zipFirstFive
- militaryStateCode
- militaryPostOfficeTypeCode
homelessness:
description: Object describing Veteran Homelessness if applicable.
type: object
additionalProperties: false
properties:
pointOfContact:
description: Object describing Homeless Veteran Point of Contact.
type: object
additionalProperties: false
required:
- pointOfContactName
- primaryPhone
properties:
pointOfContactName:
description: Point of contact in direct contact with Veteran.
type: string
minLength: 1
maxLength: 100
pattern: ^([-a-zA-Z0-9/']+( ?))*$
example: Jane Doe
primaryPhone:
description: Phone Number Object for Point of Contact.
type: object
additionalProperties: false
required:
- areaCode
- phoneNumber
properties:
areaCode:
description: Area code of Point of Contact.
type: string
example: '555'
phoneNumber:
description: Primary phone of Point of Contact.
type: string
example: '5555555'
currentlyHomeless:
type: object
additionalProperties: false
required:
- homelessSituationType
- otherLivingSituation
properties:
homelessSituationType:
description: Current state of the veteran's homelessness.
type: string
default: other
enum:
- fleeing
- shelter
- notShelter
- anotherPerson
- other
example: fleeing
otherLivingSituation:
description: For a 'homelessSituationType' of value 'other', please provide additional comments on the living situation.
type: string
maxLength: 500
example: other living situation
homelessnessRisk:
type: object
additionalProperties: false
required:
- homelessnessRiskSituationType
- otherLivingSituation
properties:
homelessnessRiskSituationType:
type: string
default: other
enum:
- losingHousing
- leavingShelter
- other
otherLivingSituation:
description: For a 'homelessnessRiskSituationType' of value 'other', please provide additional comments on the living situation.
type: string
maxLength: 500
example: other living situation
isTerminallyIll:
type: boolean
serviceInformation:
description: Overview of Veteran's service history.
type: object
additionalProperties: false
required:
- servicePeriods
properties:
servicePeriods:
description: Identifies the Service dates and Branch the Veteran served in.
type: array
minItems: 1
uniqueItems: true
items:
type: object
required:
- serviceBranch
- activeDutyBeginDate
- activeDutyEndDate
properties:
serviceBranch:
description: Branch of Service during period.
type: string
example: Air Force
enum:
- Air Force
- Air Force Academy
- Air Force Reserves
- Air Force Civilian
- Air National Guard
- Army
- Army Air Corps
- Army Air Corps or Army Air Force
- Army National Guard
- Army Nurse Corps
- Army Reserves
- Coast Guard
- Coast Guard Academy
- Coast Guard Reserves
- Commonwealth Army Veteran
- Guerrilla Combination Service
- Marine
- Marine Corps
- Marine Corps Reserves
- Merchant Marine
- National Oceanic & Atmospheric Administration
- National Oceanic and Atmospheric Administration
- Naval Academy
- Navy
- Navy Reserves
- Other
- Public Health Service
- Regular Philippine Scout
- Regular Scout Service
- Space Force
- Special Philippine Scout
- Unknown
- US Military Academy
- Woman Air Corps
- Women's Army Corps
activeDutyBeginDate:
description: Date Started Active Duty. This date must be in the past.
type: string
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
example: '1980-02-05'
activeDutyEndDate:
description: Date Completed Active Duty. Cannot be more than 180 days in the future, unless past service is also included.
type: string
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
example: '1990-01-02'
separationLocationCode:
description: Code for the facility the Veteran plans to separate from. Code must match the values returned by the /intake-sites endpoint on the [Benefits reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).
type: string
example: '98283'
confinements:
description: Used if the Veteran was ever a prisoner of war.
type: array
minItems: 1
uniqueItems: true
items:
type: object
additionalProperties: false
required:
- confinementBeginDate
- confinementEndDate
properties:
confinementBeginDate:
type: string
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
confinementEndDate:
type: string
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
reservesNationalGuardService:
type: object
additionalProperties: false
required:
- obligationTermOfServiceFromDate
- obligationTermOfServiceToDate
properties:
title10Activation:
description: Include if the Veteran is currently activated on federal orders within the National Guard or Reserves
type: object
additionalProperties: false
required:
- anticipatedSeparationDate
- title10ActivationDate
properties:
anticipatedSeparationDate:
description: Anticipated date of separation. Date must be in the future.
type: string
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
title10ActivationDate:
description: Date cannot be in the future and must be after the earliest servicePeriod.activeDutyBeginDate.
type: string
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
obligationTermOfServiceFromDate:
type: string
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
obligationTermOfServiceToDate:
type: string
pattern: ^(\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$
unitName:
type: string
pattern: ([a-zA-Z0-9\-'.,# ][a-zA-Z0-9\-'.,# ]?)*$
unitPhone:
type: object
additionalProperties: false
required:
- areaCode
- phoneNumber
properties:
areaCode:
type: string
example: '555'
phoneNumber:
type: string
example: '5555555'
receivingInactiveDutyTrainingPay:
type: boolean
alternateNames:
description: List any other names under which the Veteran served, if applicable.
type: array
minItems: 1
maxItems: 100
items:
type: object
additionalProperties: false
required:
- firstName
- lastName
properties:
firstName:
type: string
min: 1
max: 30
pattern: ^([-a-zA-Z0-9/']+( ?))+$
middleName:
type: string
min: 1
max: 30
pattern: ^([-a-zA-Z0-9/']+( ?))+$
lastName:
type: string
min: 1
max: 30
pattern: ^([-a-zA-Z0-9/']+( ?))+$
disabilities:
description: Any current disabilities or symptoms the Veteran is claiming are related to their military service and/or are service-connected.
type: array
minItems: 1
uniqueItems: true
items:
type: object
additionalProperties: false
required:
- disabilityActionType
- name
properties:
specialIssues:
description: 'The special issues related to the disability. Note :: Only add special issues that you are certain about. Incorrect special issues can lead to processing delays or denials. [See special issue descriptions.](https://www.knowva.ebenefits.va.gov/system/templates/selfservice/va_ssnew/help/customer/locale/en-US/portal/554400000001018/content/554400000179710/Appendix-E-Index-of-Corporate-Flashes-and-Special-Issues#2b)'
type: array
items:
type: string
enum:
- ALS
- HEPC
- PTSD/1
- PTSD/2
- PTSD/3
- PTSD/4
- MST
- 38 USC 1151
- ABA Election
- Abandoned VDC Claim
# --- truncated at 32 KB (257 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/va-gov/refs/heads/main/openapi/va-gov-disability-api-openapi.yml