openapi: 3.0.0 info: title: Appealable Issues Supplemental Claims API version: v0 contact: name: developer.va.gov description: "The Appealable Issues API lets you retrieve a list of a claimant’s appealable issues and any chains of preceding issues. Appealable issues are issues from claims about which VA has made a decision that may be eligible for appeal. Not all appealable issues are guaranteed to be eligible for appeal; for example, claimants may have another appeal in progress for an issue.\n\nTo check the status of all decision reviews and appeals for a specified individual, use the [Appeals Status API](https://developer.va.gov/explore/api/appeals-status/docs).\n\nTo file an appeal or decision review, use one of these APIs: \n* [Higher-Level Reviews API](https://developer.va.gov/explore/api/higher-level-reviews/docs)\n* [Notice of Disagreements API](https://developer.va.gov/explore/api/notice-of-disagreements/docs)\n* [Supplemental Claims API](https://developer.va.gov/explore/api/supplemental-claims/docs)\n\n## Technical overview\nThe Appealable Issues API pulls data from Caseflow, a case management system. It provides decision review and appeal data that can be used for submitting a Higher Level Review, Notice of Disagreement, or Supplemental Claim.\n\n### Authorization and Access\nThe authentication model for the Appealable Issues API uses OAuth 2.0/OpenID Connect. The following authorization models are supported:\n* [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code)\n* [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials)\n\n**Important:** To get production access using client credentials grant, 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).\n\n### Test data\n\nOur sandbox environment is populated with [Veteran test data](https://github.com/department-of-veterans-affairs/vets-api-clients/blob/master/test_accounts/appealable_issues_test_accounts.md) that can be used to test various response scenarios. This sandbox data contains no PII or PHI, but mimics real Veteran account information.\n" servers: - url: https://sandbox-api.va.gov/services/appeals/appealable-issues/{version} description: VA.gov API sandbox environment variables: version: default: v0 - url: https://api.va.gov/services/appeals/appealable-issues/{version} description: VA.gov API production environment variables: version: default: v0 tags: - name: Supplemental Claims description: '' paths: /supplemental_claims: post: summary: Creates a new Supplemental Claim tags: - Supplemental Claims operationId: createSc description: 'Submits an appeal of type Supplemental Claim. This endpoint is the same as submitting [VA form 200995](https://www.vba.va.gov/pubs/forms/VBA-20-0995-ARE.pdf) via mail or fax directly to the Board of Veterans’ Appeals.

Note about the 5103 Notice of Acknowledgement

The 5103 Notice regarding new & relevant evidence must be acknowledged when the issue(s) being contested is a Disability Compensation issue. The notice can be found here: [http://www.va.gov/disability/how-to-file-claim/evidence-needed](http://www.va.gov/disability/how-to-file-claim/evidence-needed). If the issue(s) being submitted are Disability Compensation and ''No'' is selected, the API will return an error. Please ensure the Veteran reviews the content about the 5103 Notice at the link above.

Supplemental Claims submitted via other avenues that do NOT select ''Yes'' for the 5103 Notice are subject to a 30 day suspense so the 5103 Notice can be mailed to the Veteran. ' security: - apikey: [] parameters: - in: header name: X-VA-SSN required: true description: Veteran's SSN example: '706547821' schema: $ref: '#/components/schemas/X-VA-SSN' - in: header name: X-VA-ICN required: false description: Veteran's ICN example: 1013062086V794840 schema: $ref: '#/components/schemas/X-VA-ICN' - in: header name: X-VA-First-Name required: true description: Veteran's first name example: Cara schema: $ref: '#/components/schemas/X-VA-First-Name' - in: header name: X-VA-Middle-Initial required: false description: Veteran's middle initial schema: $ref: '#/components/schemas/X-VA-Middle-Initial' - in: header name: X-VA-Last-Name required: true description: Veteran's last name example: Bartlett schema: $ref: '#/components/schemas/X-VA-Last-Name' - in: header name: X-VA-Birth-Date required: true description: Veteran's birth date example: '1975-02-14' schema: $ref: '#/components/schemas/X-VA-Birth-Date' - in: header name: X-VA-File-Number required: false description: Veteran's file number schema: $ref: '#/components/schemas/X-VA-File-Number' - in: header name: X-VA-NonVeteranClaimant-First-Name required: false description: Non-Veteran claimant's first name schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-First-Name' - in: header name: X-VA-NonVeteranClaimant-Middle-Initial required: false description: Non-Veteran claimant's middle initial schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-Middle-Initial' - in: header name: X-VA-NonVeteranClaimant-Last-Name required: false description: Non-Veteran claimant's last name schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-Last-Name' - in: header name: X-Consumer-Username required: false description: Consumer User Name (passed from Kong) schema: type: string - in: header name: X-Consumer-ID required: false description: Consumer GUID schema: type: string - in: header name: X-Alternate-Signer-First-Name required: false description: Alternate signer's first name schema: $ref: '#/components/schemas/X-Alternate-Signer-First-Name' - in: header name: X-Alternate-Signer-Middle-Initial required: false description: Alternate signer's middle initial schema: $ref: '#/components/schemas/X-Alternate-Signer-Middle-Initial' - in: header name: X-Alternate-Signer-Last-Name required: false description: Alternate signer's last name schema: $ref: '#/components/schemas/X-Alternate-Signer-Last-Name' responses: '200': description: Info about a single Supplemental Claim content: application/json: examples: minimum fields used: value: data: id: 00000000-1111-2222-3333-444444444444 type: supplementalClaim attributes: status: pending updatedAt: '2020-01-02T03:04:05.067Z' createdAt: '2020-01-02T03:04:05.067Z' formData: data: type: supplementalClaim attributes: benefitType: fiduciary claimantType: veteran veteran: address: addressLine1: 123 Main St city: New York countryCodeISO2: US zipCode5: '30012' phone: areaCode: '555' phoneNumber: '8001111' email: josie@example.com timezone: America/Chicago socOptIn: false evidenceSubmission: evidenceType: - upload included: - type: contestableIssue attributes: issue: right shoulder decisionDate: '1900-01-06' all fields used: value: data: id: 00000000-1111-2222-3333-444444444444 type: supplementalClaim attributes: status: pending updatedAt: '2020-01-02T03:04:05.067Z' createdAt: '2020-01-02T03:04:05.067Z' formData: data: type: supplementalClaim attributes: benefitType: compensation claimantType: other claimantTypeOtherValue: Veteran Attorney homeless: true homelessLivingSituation: - I LIVE OR SLEEP IN A PLACE THAT IS NOT MEANT FOR REGULAR SLEEPING - I LIVE IN A SHELTER - I AM STAYING WITH A FRIEND OR FAMILY MEMBER, BECAUSE I AM UNABLE TO OWN A HOME RIGHT NOW - IN THE NEXT 30 DAYS, I WILL HAVE TO LEAVE A FACILITY, LIKE A HOMELESS SHELTER - IN THE NEXT 30 DAYS, I WILL LOSE MY HOME - NONE OF THESE SITUATIONS APPLY TO ME - OTHER homelessLivingSituationOther: 'random words for other living situation ' homelessPointOfContact: Shawn Hobkens Veteran Care Network mstUpcomingEventDisclosure: NOT APPLICABLE AND/OR NOT ENROLLED IN VHA HEALTHCARE homelessPointOfContactPhone: areaCode: '777' phoneNumber: '9957023' veteran: address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeISO2: US stateCode: NY zipCode5: '30012' phone: countryCode: '03' areaCode: '555' phoneNumber: '8001111' email: bobsemail@bobbytablesemail.com timezone: America/Chicago claimant: address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Montreal countryCodeISO2: CA zipCode5: '00000' internationalPostalCode: A9999AAA phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: joe@email.com timezone: America/Detroit socOptIn: true form5103Acknowledged: true evidenceSubmission: treatmentLocations: - PRIVATE HEALTH CARE PROVIDER - VA VET CENTER - COMMUNITY CARE - VA MEDICAL CENTERS (VAMC) AND COMMUNITY-BASED OUTPATIENT CLINICS (CBOC) - DEPARTMENT OF DEFENSE (DOD) MILITARY TREATMENT FACILITY(IES) (MTF) treatmentLocationOther: hospital that is not standard other more words more words hospital that is not standard other more words more words evidenceType: - upload - retrieval retrieveFrom: - type: retrievalEvidence attributes: locationAndName: X-Ray VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' - startDate: '2020-01-02' endDate: '2020-02-01' - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2019-02-02' endDate: '2020-02-03' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: Blood Lab VA Facility evidenceDates: - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2020-02-02' endDate: '2020-02-07' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: Doctor's Notes VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: CT scan VA Medical Facility evidenceDates: - startDate: '2020-07-19' endDate: '2020-07-19' - startDate: '2018-03-06' endDate: '2019-02-12' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: Lab work VAMC evidenceDates: - startDate: '2018-03-06' endDate: '2018-03-06' - startDate: '2018-01-15' endDate: '2018-01-15' noTreatmentDates: false included: - type: contestableIssue attributes: issue: right shoulder decisionDate: '2000-01-08' socDate: '2020-04-30' - type: contestableIssue attributes: issue: lower back decisionDate: '1900-01-06' socDate: '2021-02-24' - type: contestableIssue attributes: issue: torn rotator cuff decisionDate: '1989-03-07' socDate: '2020-04-30' - type: contestableIssue attributes: issue: hearing loss decisionDate: '1930-10-20' socDate: '2016-05-30' - type: contestableIssue attributes: issue: sciatica decisionDate: '2007-01-19' socDate: '2012-01-02' - type: contestableIssue attributes: issue: bowel obstruction decisionDate: '1999-12-29' socDate: '2019-08-13' - type: contestableIssue attributes: issue: right eye decisionDate: '1920-04-02' socDate: '2019-11-19' - type: contestableIssue attributes: issue: left index finger decisionDate: '2018-08-17' socDate: '2021-03-20' - type: contestableIssue attributes: issue: spinal compression decisionDate: '2013-09-11' socDate: '2020-08-24' schema: $ref: '#/components/schemas/scCreateResponse' '422': description: Violates JSON schema content: application/json: example: errors: - title: Missing required fields detail: One or more expected fields were not found code: '145' source: pointer: /data/attributes status: '422' meta: missing_fields: - form5103Acknowledged schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/scCreate' examples: minimum fields used: value: data: type: supplementalClaim attributes: benefitType: fiduciary claimantType: veteran veteran: address: addressLine1: 123 Main St city: New York countryCodeISO2: US zipCode5: '30012' phone: areaCode: '555' phoneNumber: '8001111' email: josie@example.com timezone: America/Chicago socOptIn: false evidenceSubmission: evidenceType: - upload included: - type: contestableIssue attributes: issue: right shoulder decisionDate: '1900-01-06' all fields used: value: data: type: supplementalClaim attributes: benefitType: compensation claimantType: other claimantTypeOtherValue: Veteran Attorney homeless: true homelessLivingSituation: - I LIVE OR SLEEP IN A PLACE THAT IS NOT MEANT FOR REGULAR SLEEPING - I LIVE IN A SHELTER - I AM STAYING WITH A FRIEND OR FAMILY MEMBER, BECAUSE I AM UNABLE TO OWN A HOME RIGHT NOW - IN THE NEXT 30 DAYS, I WILL HAVE TO LEAVE A FACILITY, LIKE A HOMELESS SHELTER - IN THE NEXT 30 DAYS, I WILL LOSE MY HOME - NONE OF THESE SITUATIONS APPLY TO ME - OTHER homelessLivingSituationOther: 'random words for other living situation ' homelessPointOfContact: Shawn Hobkens Veteran Care Network mstUpcomingEventDisclosure: NOT APPLICABLE AND/OR NOT ENROLLED IN VHA HEALTHCARE homelessPointOfContactPhone: areaCode: '777' phoneNumber: '9957023' veteran: address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeISO2: US stateCode: NY zipCode5: '30012' phone: countryCode: '03' areaCode: '555' phoneNumber: '8001111' email: bobsemail@bobbytablesemail.com timezone: America/Chicago claimant: address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Montreal countryCodeISO2: CA zipCode5: '00000' internationalPostalCode: A9999AAA phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: joe@email.com timezone: America/Detroit socOptIn: true form5103Acknowledged: true evidenceSubmission: treatmentLocations: - PRIVATE HEALTH CARE PROVIDER - VA VET CENTER - COMMUNITY CARE - VA MEDICAL CENTERS (VAMC) AND COMMUNITY-BASED OUTPATIENT CLINICS (CBOC) - DEPARTMENT OF DEFENSE (DOD) MILITARY TREATMENT FACILITY(IES) (MTF) treatmentLocationOther: hospital that is not standard other more words more words hospital that is not standard other more words more words evidenceType: - upload - retrieval retrieveFrom: - type: retrievalEvidence attributes: locationAndName: X-Ray VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' - startDate: '2020-01-02' endDate: '2020-02-01' - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2019-02-02' endDate: '2020-02-03' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: Blood Lab VA Facility evidenceDates: - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2020-02-02' endDate: '2020-02-07' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: Doctor's Notes VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: CT scan VA Medical Facility evidenceDates: - startDate: '2020-07-19' endDate: '2020-07-19' - startDate: '2018-03-06' endDate: '2019-02-12' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: Lab work VAMC evidenceDates: - startDate: '2018-03-06' endDate: '2018-03-06' - startDate: '2018-01-15' endDate: '2018-01-15' noTreatmentDates: false included: - type: contestableIssue attributes: issue: right shoulder decisionDate: '2000-01-08' socDate: '2020-04-30' - type: contestableIssue attributes: issue: lower back decisionDate: '1900-01-06' socDate: '2021-02-24' - type: contestableIssue attributes: issue: torn rotator cuff decisionDate: '1989-03-07' socDate: '2020-04-30' - type: contestableIssue attributes: issue: hearing loss decisionDate: '1930-10-20' socDate: '2016-05-30' - type: contestableIssue attributes: issue: sciatica decisionDate: '2007-01-19' socDate: '2012-01-02' - type: contestableIssue attributes: issue: bowel obstruction decisionDate: '1999-12-29' socDate: '2019-08-13' - type: contestableIssue attributes: issue: right eye decisionDate: '1920-04-02' socDate: '2019-11-19' - type: contestableIssue attributes: issue: left index finger decisionDate: '2018-08-17' socDate: '2021-03-20' - type: contestableIssue attributes: issue: spinal compression decisionDate: '2013-09-11' socDate: '2020-08-24' /supplemental_claims/{uuid}: get: summary: Shows a specific Supplemental Claim. (a.k.a. the Show endpoint) tags: - Supplemental Claims operationId: showSc description: Returns all of the data associated with a specific Supplemental Claim. security: - apikey: [] parameters: - name: uuid in: path description: Supplemental Claim UUID example: 7efd87fc-fac1-4851-a4dd-b9aa2533f57f required: true schema: type: string responses: '200': description: Info about a single Supplemental Claim content: application/json: example: data: id: 00000000-1111-2222-3333-444444444444 type: supplementalClaim attributes: status: pending updatedAt: '2020-01-02T03:04:05.067Z' createdAt: '2020-01-02T03:04:05.067Z' schema: $ref: '#/components/schemas/scCreateResponse' '404': description: Supplemental Claim not found content: application/json: example: errors: - code: '404' detail: SupplementalClaim with uuid invalid not found status: '404' title: Record not found schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /supplemental_claims/schema: get: summary: Gets the Supplemental Claims JSON Schema. tags: - Supplemental Claims operationId: scSchema description: Returns the [JSON Schema](https://json-schema.org/) for the `POST /supplemental_claims` endpoint. security: - apikey: [] responses: '200': description: the JSON Schema for POST /supplemental_claims content: application/json: example: '{"$schema":"http://json-schema.org/draft-07/schema#","description":"JSON Schema for VA Form 20-0995","$ref":"#/definitions/scCreate","definitions":{"address":{"type":"object","properties":{"addressLine1":{"type":"string","minLength":1,"maxLength":60},"addressLine2":{"type":"string","minLength":1,"maxLength":30},"addressLine3":{"type":"string","minLength":1,"maxLength":10},"city":{"type":"string","minLength":1,"maxLength":60},"stateCode":{"type":"string","enum":["AL","AK","AS","AZ","AR","AA","AE","AP","CA","CO","CT","DE","DC","FM","FL","GA","GU","HI","ID","IL","IN","IA","KS","KY","LA","ME","MH","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","MP","OH","OK","OR","PW","PA","PR","RI","SC","SD","TN","TX","UT","VT","VI","VA","WA","WV","WI","WY"]},"countryCodeISO2":{"type":"string","pattern":"^[A-Z]{2}$","minLength":2,"maxLength":2},"zipCode5":{"type":"string","description":"5-digit zipcode. Use \"00000\" if address is outside the United States","pattern":"^[0-9]{5}$","minLength":5,"maxLength":5},"internationalPostalCode":{"type":"string","minLength":1,"maxLength":16}},"required":["addressLine1","city","countryCodeISO2","zipCode5"]},"phone":{"type":"object","properties":{"countryCode":{"type":"string","pattern":"^[0-9]+$","minLength":1,"maxLength":3},"areaCode":{"type":"string","pattern":"^[0-9]{1,4}$","minLength":1,"maxLength":4},"phoneNumber":{"type":"string","pattern":"^[0-9]{1,14}$","minLength":1,"maxLength":14},"phoneNumberExt":{"type":"string","pattern":"^[a-zA-Z0-9]{1,10}$","minLength":1,"maxLength":10}},"required":["phoneNumber"]},"timezone":{"type":"string","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Ciudad_Juarez","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Kyiv","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","Factory","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"]},"scCreate":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["supplementalClaim"]},"attributes":{"type":"object","properties":{"benefitType":{"type":"string","description":"If the contested issue is a Disability Compensation issue, acknowledgement of form 5103 is required - see form5103Acknowledged.","enum":["compensation","pensionSurvivorsBenefits","fiduciary","lifeInsurance","veteransHealthAdministration","veteranReadinessAndEmployment","loanGuaranty","education","nationalCemeteryAdministration"]},"homeless":{"type":"boolean","description":"Indicates if the claimant is currently homeless or at risk of becoming homeless."},"homelessLivingSituation":{"description":"Claimant''s current living situation; provide all that apply. For Other: ''A living situation not described by the previous options.''","type":"array","items":{"type":"string","enum":["I LIVE OR SLEEP IN A PLACE THAT IS NOT MEANT FOR REGULAR SLEEPING","I LIVE IN A SHELTER","I AM STAYING WITH A FRIEND OR FAMILY MEMBER, BECAUSE I AM UNABLE TO OWN A HOME RIGHT NOW","IN THE NEXT 30 DAYS, I WILL HAVE TO LEAVE A FACILITY, LIKE A HOMELESS SHELTER","IN THE NEXT 30 DAYS, I WILL LOSE MY HOME","NONE OF THESE SITUATIONS APPLY TO ME","OTHER"]}},"homelessLivingSituationOther":{"description":"Details for homeless living situation other","type":"string","maxLength":100},"homelessPointOfContact":{"description":"The name of a contact that can be used by VA in order to get in touch with a homeless claimant.","type":"string","maxLength":150},"homelessPointOfContactPhone":{"description":"Phone number for the Claimant''s point of contact in order to get in touch with a homeless claimant.","allOf":[{"$ref":"#/definitions/phone"},{}]},"mstUpcomingEventDisclosure":{"description":"Allows the Claimant to indicate their consent for VBA to communicate with VHA regarding upcoming events related to the appeals process.","type":"string","enum":["I CONSENT","I DO NOT CONSENT","I REVOKE PRIOR CONSENT","NOT APPLICABLE AND/OR NOT ENROLLED IN VHA HEALTHCARE"]},"claimantType":{"type":"string","enum":["veteran","spouse_of_veteran","child_of_veteran","parent_of_veteran","other"]},"claimantTypeOtherValue":{"type":"string","minLength":1,"maxLength":25},"veteran":{"type":"object","properties":{"address":{"$ref":"#/definitions/address"},"phone":{"allOf":[{"$ref":"#/definitions/phone"},{}]},"email":{"type":"string","format":"email","minLength":6,"maxLength":255},"timezone":{"allOf":[{"description":"Veteran''s timezone. Used for adding the current date to the signature according to the veteran''s local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date)."},{"$ref":"#/definitions/timezone"}]}},"required":["address","phone","email"]},"claimant":{"type":"object","description":"If the claimant is a non-Veteran, claimant information is required. Without this information, we will be unable to identify the claimant. If you''re a healthcare provider or an employee of a healthcare provider requesting review of a VA payment decision, you must identify the healthcare provider as the claimant and complete all relevant information in the claimant object.","properties":{"address":{"$ref":"#/definitions/address"},"phone":{"allOf":[{"$ref":"#/definitions/phone"},{}]},"email":{"type":"string","format":"email","minLength":6,"maxLength":255},"timezone":{"allOf":[{"description":"Claimant''s timezone. Used for adding the current date to the signature according to the claimant''s local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date)."},{"$ref":"#/definitions/timezone"}]}},"required":["address","phone","email"]},"evidenceSubmission":{"description":"Evidence may be uploaded up to 7 days from the ''created_at'' date of the associated Supplemental Claim via ''supplemental_claims/evidence_submissions''.","type":"object","properties":{"treatmentLocations":{"type":"array","description":"Claimant’s treatment locations; provide all that apply. For Other: ''A treatment location not described by the previous options.''","items":{"type":"string","enum":["PRIVATE HEALTH CARE PROVIDER","VA VET CENTER","COMMUNITY CARE","VA MEDICAL CENTERS (VAMC) AND COMMUNITY-BASED OUTPATIENT CLINICS (CBOC)","DEPARTMENT OF DEFENSE (DOD) MILITARY TREATMENT FACILITY(IES) (MTF)","OTHER"]},"treatmentLocationOther":{"description":"Details for treatment location other","type":"string","maxLength":115}},"evidenceType":{"type":"array","description":"''upload'' indicates that the Veteran has supplied additional evidence as uploaded documents. ''retrieval'' indicates that the Veteran has supplied contact information for facilities holding evidence relevant to the claim; the ''retrieveFrom'' field will contain the facility''s contact information. ''none'' indicates that the Veteran has not supplied additional evidence.","items":{"type":"string","enum":["upload","retrieval","none"]},"minItems":1,"uniqueItems":true,"if":{"contains":{"const":"none"}},"then":{"maxItems":1},"else":{"maxItems":2}},"retrieveFrom":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["retrievalEvidence"]},"attributes":{"type":"object","properties":{"locationAndName":{"type":"string","minLength":1,"maxLength":255},"evidenceDates":{"type":"array","items":{"type":"object","properties":{"startDate":{"type":"string","format":"date"},"endDate":{"type":"string","format":"date"}}},"minItems":1,"maxItems":4},"noTreatmentDates":{"type":"boolean","description":"Don''t have treatment date"}},"required":["locationAndName"]}},"required":["type","attributes"]},"minItems":1,"uniqueItems":true}},"required":["evidenceType"],"if":{"properties":{"evidenceType":{"contains":{"const":"retrieval"}}}},"then":{"required":["retrieveFrom"]}},"form5103Acknowledged":{"type":"boolean","description":"The 5103 Notice regarding new & relevant evidence must be acknowledged when the issue(s) being contested is a Disability Compensation issue. The notice can be found here: http://www.va.gov/disability/how-to-file-claim/evidence-needed. If the issue(s) being submitted are Disability Compensation and ''No'' is selected, the API will return an error. Please ensure the Veteran reviews the content about the 5103 Notice at the link above."},"socOptIn":{"type":"boolean"}},"allOf":[{"required":["veteran","benefitType","claimantType","evidenceSubmission","socOptIn"]},{"if":{"properties":{"benefitType":{"const":"compensation"}}},"then":{"required":["form5103Acknowledged"],"properties":{"form5103Acknowledged":{"enum":[true]}}}},{"if":{"properties":{"claimantType":{"const":"other"}}},"then":{"required":["claimantTypeOtherValue"]}},{"if":{"properties":{"claimantType":{"enum":["spouse_of_veteran","child_of_veteran","parent_of_veteran","other"]}}},"then":{"required":["claimant"]}}]}},"required":["type","attributes"]},"included":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["contestableIssue"]},"attributes":{"type":"object","properties":{"issue":{"type":"string","minLength":1,"maxLength":140},"decisionDate":{"type":"string","format":"date"},"decisionIssueId":{"type":"integer"},"ratingIssueReferenceId":{"type":"string","minLength":1,"maxLength":255},"ratingDecisionReferenceId":{"type":"string","minLength":1,"maxLength":255},"socDate":{"type":"string","format":"date"}},"required":["issue","decisionDate"]}},"required":["type","attributes"]},"minItems":1,"maxItems":100,"uniqueItems":true}},"required":["data","included"]}}}' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /supplemental_claims/validate: post: summary: Validates a POST request body against the JSON schema. tags: - Supplemental Claims operationId: scValidate description: Like the POST /supplemental_claims, but only does the validations —does not submit anything. security: - apikey: [] parameters: - in: header name: X-VA-SSN required: true description: Veteran's SSN example: '706547821' schema: $ref: '#/components/schemas/X-VA-SSN' - in: header name: X-VA-ICN required: false description: Veteran's ICN example: 1013062086V794840 schema: $ref: '#/components/schemas/X-VA-ICN' - in: header name: X-VA-First-Name required: true description: Veteran's first name example: Cara schema: $ref: '#/components/schemas/X-VA-First-Name' - in: header name: X-VA-Middle-Initial required: false description: Veteran's middle initial schema: $ref: '#/components/schemas/X-VA-Middle-Initial' - in: header name: X-VA-Last-Name required: true description: Veteran's last name example: Bartlett schema: $ref: '#/components/schemas/X-VA-Last-Name' - in: header name: X-VA-Birth-Date required: true description: Veteran's birth date example: '1975-02-14' schema: $ref: '#/components/schemas/X-VA-Birth-Date' - in: header name: X-VA-File-Number required: false description: Veteran's file number schema: $ref: '#/components/schemas/X-VA-File-Number' - in: header name: X-VA-Insurance-Policy-Number required: false description: Veteran's insurance policy number schema: $ref: '#/components/schemas/X-VA-Insurance-Policy-Number' - in: header name: X-VA-NonVeteranClaimant-First-Name required: false description: Non-Veteran claimant's first name schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-First-Name' - in: header name: X-VA-NonVeteranClaimant-Last-Name required: false description: Non-Veteran claimant's last name schema: $ref: '#/components/schemas/X-VA-NonVeteranClaimant-Last-Name' - in: header name: X-Consumer-Username required: false description: Consumer User Name (passed from Kong) schema: type: string - in: header name: X-Consumer-ID required: false description: Consumer GUID schema: type: string - in: header name: X-Alternate-Signer-First-Name required: false description: Alternate signer's first name schema: $ref: '#/components/schemas/X-Alternate-Signer-First-Name' - in: header name: X-Alternate-Signer-Middle-Initial required: false description: Alternate signer's middle initial schema: $ref: '#/components/schemas/X-Alternate-Signer-Middle-Initial' - in: header name: X-Alternate-Signer-Last-Name required: false description: Alternate signer's last name schema: $ref: '#/components/schemas/X-Alternate-Signer-Last-Name' responses: '200': description: Valid maximum content: application/json: example: data: type: supplementalClaimValidation attributes: status: valid schema: type: object properties: data: type: object properties: type: type: string enum: - supplementalClaimValidation attributes: type: object properties: status: type: string enum: - valid '422': description: Violates JSON schema content: application/json: example: errors: - title: Missing required fields detail: One or more expected fields were not found code: '145' source: pointer: /data/attributes status: '422' meta: missing_fields: - veteran schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/scCreate' examples: minimum fields used: value: data: type: supplementalClaim attributes: benefitType: fiduciary claimantType: veteran veteran: address: addressLine1: 123 Main St city: New York countryCodeISO2: US zipCode5: '30012' phone: areaCode: '555' phoneNumber: '8001111' email: josie@example.com timezone: America/Chicago socOptIn: false evidenceSubmission: evidenceType: - upload included: - type: contestableIssue attributes: issue: right shoulder decisionDate: '1900-01-06' all fields used: value: data: type: supplementalClaim attributes: benefitType: compensation claimantType: other claimantTypeOtherValue: Veteran Attorney homeless: true homelessLivingSituation: - I LIVE OR SLEEP IN A PLACE THAT IS NOT MEANT FOR REGULAR SLEEPING - I LIVE IN A SHELTER - I AM STAYING WITH A FRIEND OR FAMILY MEMBER, BECAUSE I AM UNABLE TO OWN A HOME RIGHT NOW - IN THE NEXT 30 DAYS, I WILL HAVE TO LEAVE A FACILITY, LIKE A HOMELESS SHELTER - IN THE NEXT 30 DAYS, I WILL LOSE MY HOME - NONE OF THESE SITUATIONS APPLY TO ME - OTHER homelessLivingSituationOther: 'random words for other living situation ' homelessPointOfContact: Shawn Hobkens Veteran Care Network mstUpcomingEventDisclosure: NOT APPLICABLE AND/OR NOT ENROLLED IN VHA HEALTHCARE homelessPointOfContactPhone: areaCode: '777' phoneNumber: '9957023' veteran: address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeISO2: US stateCode: NY zipCode5: '30012' phone: countryCode: '03' areaCode: '555' phoneNumber: '8001111' email: bobsemail@bobbytablesemail.com timezone: America/Chicago claimant: address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Montreal countryCodeISO2: CA zipCode5: '00000' internationalPostalCode: A9999AAA phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: joe@email.com timezone: America/Detroit socOptIn: true form5103Acknowledged: true evidenceSubmission: treatmentLocations: - PRIVATE HEALTH CARE PROVIDER - VA VET CENTER - COMMUNITY CARE - VA MEDICAL CENTERS (VAMC) AND COMMUNITY-BASED OUTPATIENT CLINICS (CBOC) - DEPARTMENT OF DEFENSE (DOD) MILITARY TREATMENT FACILITY(IES) (MTF) treatmentLocationOther: hospital that is not standard other more words more words hospital that is not standard other more words more words evidenceType: - upload - retrieval retrieveFrom: - type: retrievalEvidence attributes: locationAndName: X-Ray VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' - startDate: '2020-01-02' endDate: '2020-02-01' - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2019-02-02' endDate: '2020-02-03' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: Blood Lab VA Facility evidenceDates: - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2020-02-02' endDate: '2020-02-07' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: Doctor's Notes VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: CT scan VA Medical Facility evidenceDates: - startDate: '2020-07-19' endDate: '2020-07-19' - startDate: '2018-03-06' endDate: '2019-02-12' noTreatmentDates: true - type: retrievalEvidence attributes: locationAndName: Lab work VAMC evidenceDates: - startDate: '2018-03-06' endDate: '2018-03-06' - startDate: '2018-01-15' endDate: '2018-01-15' noTreatmentDates: false included: - type: contestableIssue attributes: issue: right shoulder decisionDate: '2000-01-08' socDate: '2020-04-30' - type: contestableIssue attributes: issue: lower back decisionDate: '1900-01-06' socDate: '2021-02-24' - type: contestableIssue attributes: issue: torn rotator cuff decisionDate: '1989-03-07' socDate: '2020-04-30' - type: contestableIssue attributes: issue: hearing loss decisionDate: '1930-10-20' socDate: '2016-05-30' - type: contestableIssue attributes: issue: sciatica decisionDate: '2007-01-19' socDate: '2012-01-02' - type: contestableIssue attributes: issue: bowel obstruction decisionDate: '1999-12-29' socDate: '2019-08-13' - type: contestableIssue attributes: issue: right eye decisionDate: '1920-04-02' socDate: '2019-11-19' - type: contestableIssue attributes: issue: left index finger decisionDate: '2018-08-17' socDate: '2021-03-20' - type: contestableIssue attributes: issue: spinal compression decisionDate: '2013-09-11' socDate: '2020-08-24' /supplemental_claims/evidence_submissions: post: summary: Get a location for subsequent evidence submission document upload PUT request tags: - Supplemental Claims operationId: postSupplementalClaimEvidenceSubmission description: 'This is the first step to submitting supporting evidence for a Supplemental Claim. (See the Evidence Uploads section above for additional information.) The Supplemental Claim GUID that is returned when the SC is submitted, is supplied to this endpoint to ensure the SC is in a valid state for sending supporting evidence documents. Evidence may be uploaded up to 7 days from the ''created_at'' date of the associated Supplemental Claim via ''supplemental_claims/evidence_submissions''. ' parameters: - name: sc_uuid in: query required: true description: Associated Supplemental Claim UUID example: 7efd87fc-fac1-4851-a4dd-b9aa2533f57f schema: type: string - in: header name: X-VA-SSN required: true description: Veteran's SSN example: '706547821' schema: $ref: '#/components/schemas/X-VA-SSN' security: - apikey: [] responses: '202': description: Accepted. Location generated content: application/json: example: data: id: 55555555-6666-7777-8888-999999999999 type: evidenceSubmission attributes: status: pending code: null detail: null location: http://some.fakesite.com/path/uuid appealId: 00000000-1111-2222-3333-444444444444 finalStatus: false appealType: SupplementalClaim createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' schema: $ref: '#/components/schemas/scEvidenceSubmissionResponse' '400': description: Bad Request content: application/json: example: errors: - title: not_found detail: SupplementalClaim with uuid not found code: '404' status: '404' schema: type: object properties: errors: type: array items: properties: title: type: string example: Bad request detail: type: string example: Must supply a corresponding SC id in order to submit evidence code: type: string example: '400' status: type: string example: '400' '404': description: Associated Supplemental Claim not found content: application/json: example: errors: - title: not_found detail: SupplementalClaim with uuid not found code: '404' status: '404' schema: $ref: '#/components/schemas/errorModel' '422': description: Validation errors content: application/json: example: errors: - title: unprocessable_entity detail: Request header 'X-VA-SSN' does not match the associated appeal's SSN code: DecisionReviewMismatchedSSN status: '422' schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /sc_upload_path: put: summary: Accepts Supplemental Claim Evidence Submission document upload. tags: - Supplemental Claims operationId: putSupplementalClaimEvidenceSubmission description: 'Accepts document metadata, document binary, and attachment binaries. Full URL, including query parameters, provided from POST `/*/evidence_submissions`. Please see the `documentUploadMetadata` schema for the required payload schema. ## Example Payload The following demonstrates a (redacted) multipart payload suitable for submitting to the PUT endpoint. Most programming languages should have provisions for assembling a multipart payload like this without having to do so manually. ``` --17de1ed8f01442b2a2d7a93506314b76 Content-Disposition: form-data; name="metadata" Content-Type: application/json {"veteranFirstName": "Jane", "veteranLastName": "Doe", "fileNumber": "012345678", "zipCode": "94402", "source": "Vets.gov", "docType": "316" "businessLine": "BVA"} --17de1ed8f01442b2a2d7a93506314b76 Content-Disposition: form-data; name="content" Content-Type: application/pdf --17de1ed8f01442b2a2d7a93506314b76 Content-Disposition: form-data; name="attachment1" Content-Type: application/pdf --17de1ed8f01442b2a2d7a93506314b76-- ``` This PUT request would have an overall HTTP Content-Type header: ``` Content-Type: multipart/form-data; boundary=17de1ed8f01442b2a2d7a93506314b76 ``` Note that the Content-Disposition parameter "name" in each part must be the expected values "metadata", "content", "attachment1"..."attachmentN" ' security: - apikey: [] parameters: - name: Content-MD5 in: header description: Base64-encoded 128-bit MD5 digest of the message. Use for integrity control. schema: type: string responses: '200': description: Document upload staged '400': description: Document upload failed content: application/xml: schema: type: object description: Document upload failed xml: name: Error properties: Code: type: string description: Error code example: Bad Digest Message: type: string description: Error detail example: A client error (InvalidDigest) occurred when calling the PutObject operation - The Content-MD5 you specified was invalid. Resource: type: string description: Resource description example: /example_path_here/6d8433c1-cd55-4c24-affd-f592287a7572.upload RequestId: type: string description: Identifier for debug purposes '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' application/xml: schema: $ref: '#/components/schemas/errorModel' /supplemental_claims/evidence_submissions/{uuid}: get: summary: Returns all of the data associated with a specific Supplemental Claim Evidence Submission. tags: - Supplemental Claims operationId: getSupplementalClaimEvidenceSubmission description: Returns all of the data associated with a specific Supplemental Claim Evidence Submission. security: - apikey: [] parameters: - name: uuid in: path description: Supplemental Claim UUID Evidence Submission required: true schema: type: string responses: '200': description: Info about a single Supplemental Claim Evidence Submission. content: application/json: example: data: id: 55555555-6666-7777-8888-999999999999 type: evidenceSubmission attributes: status: pending code: null detail: null location: null appealId: 00000000-1111-2222-3333-444444444444 finalStatus: false appealType: SupplementalClaim createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' schema: $ref: '#/components/schemas/scEvidenceSubmissionResponse' '404': description: Supplemental Claim Evidence Submission not found content: application/json: example: errors: - title: Record not found detail: The record identified by invalid could not be found code: '404' status: '404' schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /forms/200995: post: summary: Creates a new Supplemental Claim tags: - Supplemental Claims operationId: createSc description: 'Submits an appeal of type Supplemental Claim. This endpoint is the same as submitting [VA form 200995](https://www.vba.va.gov/pubs/forms/VBA-20-0995-ARE.pdf) via mail or fax directly to the Board of Veterans’ Appeals.

Note about the 5103 Notice of Acknowledgement

The 5103 Notice regarding new & relevant evidence must be acknowledged when the issue(s) being contested is a Disability Compensation issue. The notice can be found here: [http://www.va.gov/disability/how-to-file-claim/evidence-needed](http://www.va.gov/disability/how-to-file-claim/evidence-needed). If the issue(s) being submitted are Disability Compensation and ''No'' is selected, the API will return an error. Please ensure the Veteran reviews the content about the 5103 Notice at the link above.

Supplemental Claims submitted via other avenues that do NOT select ''Yes'' for the 5103 Notice are subject to a 30 day suspense so the 5103 Notice can be mailed to the Veteran. ' security: - productionOauth: - veteran/SupplementalClaims.write - representative/SupplementalClaims.write - system/SupplementalClaims.write - sandboxOauth: - veteran/SupplementalClaims.write - representative/SupplementalClaims.write - system/SupplementalClaims.write - bearer_token: [] parameters: [] responses: '201': description: Supplemental Claim created content: application/json: examples: minimum fields used: value: data: id: 00000000-1111-2222-3333-444444444444 type: supplementalClaim attributes: status: pending createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' formData: data: type: supplementalClaim attributes: benefitType: fiduciary claimantType: veteran veteran: ssn: '123456789' icn: 1012667145V762142 firstName: Jäñe middleInitial: ø lastName: Doé birthDate: '1969-12-31' fileNumber: '987654321' insurancePolicyNumber: '987654321123456789' address: addressLine1: 123 Main St city: New York countryCodeIso3: USA zipCode5: '30012' phone: areaCode: '555' phoneNumber: '8001111' email: josie@example.com timezone: America/Chicago evidenceSubmission: evidenceType: - upload included: - type: appealableIssue attributes: issue: right shoulder decisionDate: '1900-01-06' all fields used: value: data: id: 00000000-1111-2222-3333-444444444444 type: supplementalClaim attributes: status: pending createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' formData: data: type: supplementalClaim attributes: benefitType: compensation claimantType: other claimantTypeOtherValue: Veteran Attorney veteran: ssn: '123456789' icn: 1012667145V762142 firstName: Jäñe middleInitial: ø lastName: Doé birthDate: '1969-12-31' fileNumber: '987654321' insurancePolicyNumber: '987654321123456789' address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeIso3: USA stateCode: NY zipCode5: '30012' phone: countryCode: '03' areaCode: '555' phoneNumber: '8001111' email: bobsemail@bobbytablesemail.com timezone: America/Chicago claimant: firstName: first middleInitial: m lastName: last address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Montreal countryCodeIso3: CAN zipCode5: '00000' internationalPostalCode: A9999AAA phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: joe@email.com timezone: America/Detroit form5103Acknowledged: true evidenceSubmission: evidenceType: - upload - retrieval retrieveFrom: - type: retrievalEvidence attributes: locationAndName: X-Ray VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' - startDate: '2020-01-02' endDate: '2020-02-01' - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2019-02-02' endDate: '2020-02-03' - type: retrievalEvidence attributes: locationAndName: Blood Lab VA Facility evidenceDates: - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2020-02-02' endDate: '2020-02-07' - type: retrievalEvidence attributes: locationAndName: Doctor's Notes VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' - type: retrievalEvidence attributes: locationAndName: CT scan VA Medical Facility evidenceDates: - startDate: '2020-07-19' endDate: '2020-07-19' - startDate: '2018-03-06' endDate: '2019-02-12' - type: retrievalEvidence attributes: locationAndName: Lab work VAMC evidenceDates: - startDate: '2018-03-06' endDate: '2018-03-06' - startDate: '2018-01-15' endDate: '2018-01-15' included: - type: appealableIssue attributes: issue: right shoulder decisionDate: '2000-01-08' socDate: '2020-04-30' - type: appealableIssue attributes: issue: lower back decisionDate: '1900-01-06' socDate: '2021-02-24' - type: appealableIssue attributes: issue: torn rotator cuff decisionDate: '1989-03-07' socDate: '2020-04-30' - type: appealableIssue attributes: issue: hearing loss decisionDate: '1930-10-20' socDate: '2016-05-30' - type: appealableIssue attributes: issue: sciatica decisionDate: '2007-01-19' socDate: '2012-01-02' - type: appealableIssue attributes: issue: bowel obstruction decisionDate: '1999-12-29' socDate: '2019-08-13' - type: appealableIssue attributes: issue: right eye decisionDate: '1920-04-02' socDate: '2019-11-19' - type: appealableIssue attributes: issue: left index finger decisionDate: '2018-08-17' socDate: '2021-03-20' - type: appealableIssue attributes: issue: spinal compression decisionDate: '2013-09-11' socDate: '2020-08-24' schema: $ref: '#/components/schemas/scCreateResponse_2' '400': description: Bad request content: application/json: examples: Body is not a JSON object: value: errors: - code: '109' detail: The request body isn't a JSON object status: '400' title: Bad Request schema: $ref: '#/components/schemas/errorModel' '403': description: Forbidden attempt using a veteran-scoped OAuth token to create a Supplemental Claim for another veteran content: application/json: example: errors: - title: Forbidden detail: Veterans may access only their own records code: '403' status: '403' schema: $ref: '#/components/schemas/errorModel' '422': description: Violates JSON schema content: application/json: example: errors: - title: Missing required fields detail: One or more expected fields were not found code: '145' source: pointer: /data/attributes status: '422' meta: missing_fields: - form5103Acknowledged schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/scCreate_2' examples: minimum fields used: value: data: type: supplementalClaim attributes: benefitType: fiduciary claimantType: veteran veteran: ssn: '123456789' icn: 1012667145V762142 firstName: Jäñe middleInitial: ø lastName: Doé birthDate: '1969-12-31' fileNumber: '987654321' insurancePolicyNumber: '987654321123456789' address: addressLine1: 123 Main St city: New York countryCodeIso3: USA zipCode5: '30012' phone: areaCode: '555' phoneNumber: '8001111' email: josie@example.com timezone: America/Chicago evidenceSubmission: evidenceType: - upload included: - type: appealableIssue attributes: issue: right shoulder decisionDate: '1900-01-06' all fields used: value: data: type: supplementalClaim attributes: benefitType: compensation claimantType: other claimantTypeOtherValue: Veteran Attorney veteran: ssn: '123456789' icn: 1012667145V762142 firstName: Jäñe middleInitial: ø lastName: Doé birthDate: '1969-12-31' fileNumber: '987654321' insurancePolicyNumber: '987654321123456789' address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeIso3: USA stateCode: NY zipCode5: '30012' phone: countryCode: '03' areaCode: '555' phoneNumber: '8001111' email: bobsemail@bobbytablesemail.com timezone: America/Chicago claimant: firstName: joe middleInitial: b lastName: smart address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Montreal countryCodeIso3: CAN zipCode5: '00000' internationalPostalCode: A9999AAA phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: joe@email.com timezone: America/Detroit form5103Acknowledged: true evidenceSubmission: evidenceType: - upload - retrieval retrieveFrom: - type: retrievalEvidence attributes: locationAndName: X-Ray VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' - startDate: '2020-01-02' endDate: '2020-02-01' - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2019-02-02' endDate: '2020-02-03' - type: retrievalEvidence attributes: locationAndName: Blood Lab VA Facility evidenceDates: - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2020-02-02' endDate: '2020-02-07' - type: retrievalEvidence attributes: locationAndName: Doctor's Notes VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' - type: retrievalEvidence attributes: locationAndName: CT scan VA Medical Facility evidenceDates: - startDate: '2020-07-19' endDate: '2020-07-19' - startDate: '2018-03-06' endDate: '2019-02-12' - type: retrievalEvidence attributes: locationAndName: Lab work VAMC evidenceDates: - startDate: '2018-03-06' endDate: '2018-03-06' - startDate: '2018-01-15' endDate: '2018-01-15' included: - type: appealableIssue attributes: issue: right shoulder decisionDate: '2000-01-08' socDate: '2020-04-30' - type: appealableIssue attributes: issue: lower back decisionDate: '1900-01-06' socDate: '2021-02-24' - type: appealableIssue attributes: issue: torn rotator cuff decisionDate: '1989-03-07' socDate: '2020-04-30' - type: appealableIssue attributes: issue: hearing loss decisionDate: '1930-10-20' socDate: '2016-05-30' - type: appealableIssue attributes: issue: sciatica decisionDate: '2007-01-19' socDate: '2012-01-02' - type: appealableIssue attributes: issue: bowel obstruction decisionDate: '1999-12-29' socDate: '2019-08-13' - type: appealableIssue attributes: issue: right eye decisionDate: '1920-04-02' socDate: '2019-11-19' - type: appealableIssue attributes: issue: left index finger decisionDate: '2018-08-17' socDate: '2021-03-20' - type: appealableIssue attributes: issue: spinal compression decisionDate: '2013-09-11' socDate: '2020-08-24' /forms/200995/{id}: get: summary: Show a specific Supplemental Claim tags: - Supplemental Claims operationId: showSc description: Returns basic data associated with a specific Supplemental Claim. security: - productionOauth: - veteran/SupplementalClaims.read - representative/SupplementalClaims.read - system/SupplementalClaims.read - sandboxOauth: - veteran/SupplementalClaims.read - representative/SupplementalClaims.read - system/SupplementalClaims.read - bearer_token: [] parameters: - name: id in: path description: Supplemental Claim UUID example: 7efd87fc-fac1-4851-a4dd-b9aa2533f57f schema: type: string format: uuid required: true responses: '200': description: Success content: application/json: example: data: id: 00000000-1111-2222-3333-444444444444 type: supplementalClaim attributes: status: pending createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' schema: $ref: '#/components/schemas/scCreateResponse_2' '403': description: Forbidden access with a veteran-scoped OAuth token to an unowned Supplemental Claim content: application/json: example: errors: - title: Forbidden detail: Veterans may access only their own records code: '403' status: '403' schema: $ref: '#/components/schemas/errorModel' '404': description: Supplemental Claim not found content: application/json: example: errors: - title: Resource not found detail: Supplemental Claim with uuid 00000000-0000-0000-0000-000000000000 not found code: '404' status: '404' schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /forms/200995/{id}/download: get: summary: Download a watermarked copy of a submitted Supplemental Claim tags: - Supplemental Claims operationId: downloadSc security: - productionOauth: - veteran/SupplementalClaims.read - representative/SupplementalClaims.read - system/SupplementalClaims.read - sandboxOauth: - veteran/SupplementalClaims.read - representative/SupplementalClaims.read - system/SupplementalClaims.read - bearer_token: [] description: "Returns a watermarked copy of a Supplemental Claim PDF as submitted to the VA. PDFs are available\nwith the following caveats:\n\n1. The PDF download will become available only after after the Supplemental Claim has progressed to\n the 'submitted' state.\n2. The PDF will stop being available one week after the Supplemental Claim has progressed to the\n 'completed' state. This is when the Veteran's personally identifying information is purged from our servers.\n\nThe 'icn' parameter is required when accessing this endpoint using an OAuth token with the 'representative/SupplementalClaims.read' or 'system/SupplementalClaims.read' scopes.\nRequests made with the 'veteran/SupplementalClaims.read' scope may omit the 'icn' parameter.\n" parameters: - name: icn description: ICN of the Veteran associated with the Supplemental Claim. Optional when using a veteran-scoped OAuth token. Required when using a representative- or system-scoped token. example: 1012832025V743496 schema: type: string pattern: ^[0-9]{10}V[0-9]{6}$ minLength: 17 maxLength: 17 in: query required: false - name: id in: path description: Supplemental Claim ID schema: type: string format: uuid example: 44444444-5555-6666-7777-888888888888 required: true responses: '200': description: Success content: application/pdf: schema: type: file '400': description: Missing 'icn' query parameter (with a system- or representative-scoped OAuth token) content: application/json: example: errors: - title: Missing parameter detail: The 'icn' parameter is required with this request code: '108' status: '400' schema: $ref: '#/components/schemas/errorModel' '403': description: Forbidden access (with a veteran-scoped OAuth token to an unowned Supplemental Claim) content: application/json: example: errors: - title: Forbidden detail: 'Invalid ''icn'' parameter: Veterans may access only their own records' code: '403' status: '403' schema: $ref: '#/components/schemas/errorModel' '404': description: Not Found content: application/json: examples: Supplemental Claim not found, or 'icn' parameter does not match the Supplemental Claim's saved data: value: errors: - title: Resource not found detail: Supplemental Claim with uuid 44444444-5555-6666-7777-888888888888 not found code: '404' status: '404' schema: $ref: '#/components/schemas/errorModel' '410': description: Personally identifying information gone content: application/json: example: errors: - code: '410' detail: PDF for SupplementalClaim with id 44444444-5555-6666-7777-888888888888 cannot be downloaded because the form data was deleted from the server after the PII retention period expired status: '410' title: PDF download expired schema: $ref: '#/components/schemas/errorModel' '422': description: PDF not ready content: application/json: example: errors: - code: '422' detail: PDF for SupplementalClaim with id 44444444-5555-6666-7777-888888888888 cannot be downloaded yet because the appeal is still being submitted status: '422' title: PDF download not ready schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /schemas/{schema_type}: get: summary: Gets the Supplemental Claims JSON Schema. tags: - Supplemental Claims operationId: scSchema description: Returns the [JSON Schema](https://json-schema.org/) for the `POST /forms/200995` endpoint. security: - productionOauth: - veteran/SupplementalClaims.read - representative/SupplementalClaims.read - system/SupplementalClaims.read - sandboxOauth: - veteran/SupplementalClaims.read - representative/SupplementalClaims.read - system/SupplementalClaims.read - bearer_token: [] parameters: - name: schema_type in: path description: 'Schema type. Can be: `200995`, `address`, `nonBlankString`, `phone`, `timezone`' required: true examples: '200995': value: '200995' address: value: address nonBlankString: value: nonBlankString phone: value: phone timezone: value: timezone schema: type: string responses: '200': description: The JSON schema for the given `schema_type` parameter content: application/json: examples: '200995': value: $schema: http://json-schema.org/draft-07/schema# description: JSON Schema for VA Form 20-0995 properties: data: type: object properties: type: type: string enum: - supplementalClaim attributes: type: object properties: benefitType: type: string description: If the contested issue is a Disability Compensation issue, acknowledgement of form 5103 is required - see form5103Acknowledged. enum: - compensation - pensionSurvivorsBenefits - fiduciary - lifeInsurance - veteransHealthAdministration - veteranReadinessAndEmployment - loanGuaranty - education - nationalCemeteryAdministration claimantType: type: string enum: - veteran - spouse_of_veteran - child_of_veteran - parent_of_veteran - other claimantTypeOtherValue: type: string minLength: 1 maxLength: 25 veteran: type: object properties: ssn: allOf: - $ref: ssn.json - description: Veteran's SSN icn: $ref: icn.json firstName: allOf: - description: Veteran's first name minLength: 1 maxLength: 30 - {} - $ref: nonBlankString.json middleInitial: allOf: - description: Veteran's middle initial minLength: 1 maxLength: 1 - $ref: nonBlankString.json lastName: allOf: - description: Veteran's last name minLength: 1 maxLength: 40 - $ref: nonBlankString.json birthDate: description: Veteran's birth date type: string format: date fileNumber: $ref: fileNumber.json serviceNumber: allOf: - description: Veteran's service number minLength: 1 maxLength: 9 - $ref: nonBlankString.json insurancePolicyNumber: allOf: - description: Veteran's insurance policy number minLength: 1 maxLength: 18 - $ref: nonBlankString.json address: $ref: address.json phone: $ref: phone.json email: type: string format: email minLength: 6 maxLength: 255 timezone: description: Veteran's timezone. Used for adding the current date to the signature according to the veteran's local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date). $ref: timezone.json required: - ssn - icn - firstName - lastName - birthDate - address - phone - email claimant: type: object description: If the claimant is a non-Veteran, claimant information is required. Without this information, we will be unable to identify the claimant. If you're a healthcare provider or an employee of a healthcare provider requesting review of a VA payment decision, you must identify the healthcare provider as the claimant and complete all relevant information in the claimant object. properties: firstName: allOf: - description: Non-Veteran Claimant's first name minLength: 1 maxLength: 30 - $ref: nonBlankString.json - {} middleInitial: allOf: - description: Non-Veteran Claimant's middle initial minLength: 1 maxLength: 1 - $ref: nonBlankString.json lastName: allOf: - description: Non-Veteran Claimant's last name minLength: 1 maxLength: 40 - $ref: nonBlankString.json address: $ref: address.json phone: $ref: phone.json email: type: string format: email minLength: 6 maxLength: 255 timezone: description: Veteran's timezone. Used for adding the current date to the signature according to the veteran's local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date). $ref: timezone.json dependencies: firstName: - lastName middleInitial: - firstName - lastName lastName: - firstName required: - firstName - lastName - address - phone - email alternateSigner: description: Alternate signer information type: object properties: firstName: allOf: - description: Alternate signer's first name minLength: 1 maxLength: 30 - $ref: nonBlankString.json - {} middleInitial: allOf: - description: Alternate signer's middle initial minLength: 1 maxLength: 1 - $ref: nonBlankString.json lastName: allOf: - description: Alternate signer's last name minLength: 1 maxLength: 40 - $ref: nonBlankString.json dependencies: firstName: - lastName middleInitial: - firstName - lastName lastName: - firstName required: - firstName - lastName evidenceSubmission: description: Evidence may be uploaded up to 7 days from the 'created_at' date of the associated Supplemental Claim via 'supplemental_claims/evidence_submissions'. type: object properties: evidenceType: type: array description: '''upload'' indicates that the Veteran has supplied additional evidence as uploaded documents. ''retrieval'' indicates that the Veteran has supplied contact information for facilities holding evidence relevant to the claim; the ''retrieveFrom'' field will contain the facility''s contact information. ''none'' indicates that the Veteran has not supplied additional evidence' items: type: string enum: - upload - retrieval - none minItems: 1 uniqueItems: true if: contains: const: none then: maxItems: 1 else: maxItems: 2 retrieveFrom: type: array items: type: object properties: type: type: string enum: - retrievalEvidence attributes: type: object properties: locationAndName: type: string minLength: 1 maxLength: 255 evidenceDates: type: array items: type: object properties: startDate: type: string format: date endDate: type: string format: date required: - startDate - endDate minItems: 1 maxItems: 4 required: - locationAndName - evidenceDates required: - type - attributes minItems: 1 uniqueItems: true required: - evidenceType if: properties: evidenceType: contains: const: retrieval then: required: - retrieveFrom form5103Acknowledged: type: boolean description: 'The 5103 Notice regarding new & relevant evidence must be acknowledged when the issue(s) being contested is a Disability Compensation issue. The notice can be found here: http://www.va.gov/disability/how-to-file-claim/evidence-needed. If the issue(s) being submitted are Disability Compensation and ''No'' is selected, the API will return an error. Please ensure the Veteran reviews the content about the 5103 Notice at the link above.' allOf: - required: - veteran - benefitType - claimantType - evidenceSubmission - if: properties: benefitType: const: compensation then: required: - form5103Acknowledged properties: form5103Acknowledged: enum: - true - if: properties: claimantType: const: other then: required: - claimantTypeOtherValue - if: properties: claimantType: enum: - spouse_of_veteran - child_of_veteran - parent_of_veteran - other then: required: - claimant required: - type - attributes included: type: array items: type: object properties: type: type: string enum: - appealableIssue attributes: type: object properties: issue: type: string minLength: 1 maxLength: 140 decisionDate: type: string format: date decisionIssueId: type: integer ratingIssueReferenceId: type: string minLength: 1 maxLength: 255 ratingDecisionReferenceId: type: string minLength: 1 maxLength: 255 socDate: type: string format: date required: - issue - decisionDate required: - type - attributes minItems: 1 maxItems: 100 uniqueItems: true required: - data - included address: value: $schema: http://json-schema.org/draft-2020-12/schema# description: 'JSON Schema for VA Decision Review Forms: ''address''' properties: address: type: object properties: addressLine1: type: string minLength: 1 maxLength: 60 addressLine2: type: string minLength: 1 maxLength: 30 addressLine3: type: string minLength: 1 maxLength: 10 city: type: string minLength: 1 maxLength: 60 stateCode: type: string enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FM - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MH - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY countryCodeIso3: description: Three letter ISO 3166-1 country code type: string pattern: ^[A-Z]{3}$ minLength: 3 maxLength: 3 example: USA zipCode5: type: string description: Five digit zipcode. Use "00000" if address is outside the United States pattern: ^[0-9]{5}$ minLength: 5 maxLength: 5 internationalPostalCode: type: string minLength: 1 maxLength: 16 required: - addressLine1 - city - countryCodeIso3 - zipCode5 nonBlankString: value: $schema: http://json-schema.org/draft-2020-12/schema# description: 'JSON Schema for VA Decision Review Forms: ''nonBlankString''' properties: nonBlankString: type: string pattern: '[^ \f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]' phone: value: $schema: http://json-schema.org/draft-2020-12/schema# description: 'JSON Schema for VA Decision Review Forms: ''phone''' properties: phone: type: object properties: countryCode: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 3 areaCode: type: string pattern: ^[0-9]{1,4}$ minLength: 1 maxLength: 4 phoneNumber: type: string pattern: ^[0-9]{1,14}$ minLength: 1 maxLength: 14 phoneNumberExt: type: string pattern: ^[a-zA-Z0-9]{1,10}$ minLength: 1 maxLength: 10 required: - phoneNumber timezone: value: $schema: http://json-schema.org/draft-2020-12/schema# description: 'JSON Schema for VA Decision Review Forms: ''timezone''' properties: timezone: type: string enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Coyhaique - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - Factory - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu '404': description: '`schema_type` not found' content: application/json: example: errors: - title: not_found detail: The 'invalid_schema_type' request parameter is invalid code: InvalidSchemaType status: '404' source: parameter: invalid_schema_type meta: available_options: - '200995' - address - fileNumber - icn - nonBlankString - phone - ssn - timezone schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' /forms/200995/validate: post: summary: Validates a POST request body against the JSON schema. tags: - Supplemental Claims operationId: scValidate description: Like the POST /supplemental_claims, but only does the validations —does not submit anything. security: - productionOauth: - veteran/SupplementalClaims.write - representative/SupplementalClaims.write - system/SupplementalClaims.write - sandboxOauth: - veteran/SupplementalClaims.write - representative/SupplementalClaims.write - system/SupplementalClaims.write - bearer_token: [] parameters: [] responses: '200': description: Valid maximum content: application/json: example: data: type: supplementalClaimValidation attributes: status: valid schema: type: object properties: data: type: object properties: type: type: string enum: - supplementalClaimValidation attributes: type: object properties: status: type: string enum: - valid '422': description: Violates JSON schema content: application/json: example: errors: - title: Missing required fields detail: One or more expected fields were not found code: '145' source: pointer: /data/attributes status: '422' meta: missing_fields: - veteran schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/scCreate_2' examples: minimum fields used: value: data: type: supplementalClaim attributes: benefitType: fiduciary claimantType: veteran veteran: ssn: '123456789' icn: 1012667145V762142 firstName: Jäñe middleInitial: ø lastName: Doé birthDate: '1969-12-31' fileNumber: '987654321' insurancePolicyNumber: '987654321123456789' address: addressLine1: 123 Main St city: New York countryCodeIso3: USA zipCode5: '30012' phone: areaCode: '555' phoneNumber: '8001111' email: josie@example.com timezone: America/Chicago evidenceSubmission: evidenceType: - upload included: - type: appealableIssue attributes: issue: right shoulder decisionDate: '1900-01-06' all fields used: value: data: type: supplementalClaim attributes: benefitType: compensation claimantType: other claimantTypeOtherValue: Veteran Attorney veteran: ssn: '123456789' icn: 1012667145V762142 firstName: Jäñe middleInitial: ø lastName: Doé birthDate: '1969-12-31' fileNumber: '987654321' insurancePolicyNumber: '987654321123456789' address: addressLine1: 123 Main St addressLine2: 'Suite #1200' addressLine3: Box 4 city: New York countryCodeIso3: USA stateCode: NY zipCode5: '30012' phone: countryCode: '03' areaCode: '555' phoneNumber: '8001111' email: bobsemail@bobbytablesemail.com timezone: America/Chicago claimant: firstName: joe middleInitial: b lastName: smart address: addressLine1: 456 First St addressLine2: Apt 5 addressLine3: Box 1 city: Montreal countryCodeIso3: CAN zipCode5: '00000' internationalPostalCode: A9999AAA phone: countryCode: '1' areaCode: '555' phoneNumber: '8111100' phoneNumberExt: '4' email: joe@email.com timezone: America/Detroit form5103Acknowledged: true evidenceSubmission: evidenceType: - upload - retrieval retrieveFrom: - type: retrievalEvidence attributes: locationAndName: X-Ray VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' - startDate: '2020-01-02' endDate: '2020-02-01' - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2019-02-02' endDate: '2020-02-03' - type: retrievalEvidence attributes: locationAndName: Blood Lab VA Facility evidenceDates: - startDate: '2020-02-20' endDate: '2020-02-22' - startDate: '2020-02-02' endDate: '2020-02-07' - type: retrievalEvidence attributes: locationAndName: Doctor's Notes VAMC evidenceDates: - startDate: '2020-04-10' endDate: '2020-04-10' - type: retrievalEvidence attributes: locationAndName: CT scan VA Medical Facility evidenceDates: - startDate: '2020-07-19' endDate: '2020-07-19' - startDate: '2018-03-06' endDate: '2019-02-12' - type: retrievalEvidence attributes: locationAndName: Lab work VAMC evidenceDates: - startDate: '2018-03-06' endDate: '2018-03-06' - startDate: '2018-01-15' endDate: '2018-01-15' included: - type: appealableIssue attributes: issue: right shoulder decisionDate: '2000-01-08' socDate: '2020-04-30' - type: appealableIssue attributes: issue: lower back decisionDate: '1900-01-06' socDate: '2021-02-24' - type: appealableIssue attributes: issue: torn rotator cuff decisionDate: '1989-03-07' socDate: '2020-04-30' - type: appealableIssue attributes: issue: hearing loss decisionDate: '1930-10-20' socDate: '2016-05-30' - type: appealableIssue attributes: issue: sciatica decisionDate: '2007-01-19' socDate: '2012-01-02' - type: appealableIssue attributes: issue: bowel obstruction decisionDate: '1999-12-29' socDate: '2019-08-13' - type: appealableIssue attributes: issue: right eye decisionDate: '1920-04-02' socDate: '2019-11-19' - type: appealableIssue attributes: issue: left index finger decisionDate: '2018-08-17' socDate: '2021-03-20' - type: appealableIssue attributes: issue: spinal compression decisionDate: '2013-09-11' socDate: '2020-08-24' /evidence-submissions: post: summary: Get a location for subsequent evidence submission document upload PUT request tags: - Supplemental Claims operationId: postSupplementalClaimEvidenceSubmission description: 'This is the first step to submitting supporting evidence for a Supplemental Claim. (See the Evidence Uploads section above for additional information.) The Supplemental Claim GUID that is returned when the SC is submitted, is supplied to this endpoint to ensure the SC is in a valid state for sending supporting evidence documents. Evidence may be uploaded up to 7 days from the ''created_at'' date of the associated Supplemental Claim via ''supplemental_claims/evidence_submissions''. ' security: - productionOauth: - veteran/SupplementalClaims.write - representative/SupplementalClaims.write - system/SupplementalClaims.write - sandboxOauth: - veteran/SupplementalClaims.write - representative/SupplementalClaims.write - system/SupplementalClaims.write - bearer_token: [] parameters: [] responses: '201': description: Location created content: application/json: example: data: id: 55555555-6666-7777-8888-999999999999 type: evidenceSubmission attributes: status: pending code: null detail: null location: http://path.to.upload/location/uuid appealId: 00000000-1111-2222-3333-444444444444 finalStatus: false appealType: SupplementalClaim createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' schema: $ref: '#/components/schemas/scEvidenceSubmissionResponse_2' '400': description: Bad Request content: application/json: example: errors: - title: Invalid data type detail: Expected string data code: '140' source: pointer: /scId status: '422' schema: $ref: '#/components/schemas/errorModel' '404': description: Associated Supplemental Claim not found content: application/json: example: errors: - title: Resource not found detail: Supplemental Claim with uuid 00000000-0000-0000-0000-000000000000 not found code: '404' status: '404' schema: $ref: '#/components/schemas/errorModel' '422': description: Validation errors content: application/json: example: errors: - title: unprocessable_entity detail: The provided 'ssn' value does not match the associated appeal's SSN code: DecisionReviewMismatchedSSN status: '422' schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' requestBody: content: application/json: schema: $ref: '#/components/schemas/scEvidenceSubmissionCreate' /sc-upload-path: put: summary: Accepts Supplemental Claim Evidence Submission document upload. tags: - Supplemental Claims operationId: putSupplementalClaimEvidenceSubmission description: 'Accepts document metadata, document binary, and attachment binaries. Full URL, including query parameters, provided from POST `/*/evidence-submissions`. Please see the `documentUploadMetadata` schema for the required payload schema. ## Example Payload The following demonstrates a (redacted) multipart payload suitable for submitting to the PUT endpoint. Most programming languages should have provisions for assembling a multipart payload like this without having to do so manually. ``` --17de1ed8f01442b2a2d7a93506314b76 Content-Disposition: form-data; name="metadata" Content-Type: application/json {"veteranFirstName": "Jane", "veteranLastName": "Doe", "fileNumber": "012345678", "zipCode": "94402", "source": "Vets.gov", "docType": "316" "businessLine": "BVA"} --17de1ed8f01442b2a2d7a93506314b76 Content-Disposition: form-data; name="content" Content-Type: application/pdf --17de1ed8f01442b2a2d7a93506314b76 Content-Disposition: form-data; name="attachment1" Content-Type: application/pdf --17de1ed8f01442b2a2d7a93506314b76-- ``` This PUT request would have an overall HTTP Content-Type header: ``` Content-Type: multipart/form-data; boundary=17de1ed8f01442b2a2d7a93506314b76 ``` Note that the Content-Disposition parameter "name" in each part must be the expected values "metadata", "content", "attachment1"..."attachmentN" ' security: - productionOauth: - veteran/SupplementalClaims.write - representative/SupplementalClaims.write - system/SupplementalClaims.write - sandboxOauth: - veteran/SupplementalClaims.write - representative/SupplementalClaims.write - system/SupplementalClaims.write - bearer_token: [] parameters: - name: Content-MD5 in: header description: Base64-encoded 128-bit MD5 digest of the message. Use for integrity control. schema: type: string responses: '200': description: Document upload staged '400': description: Document upload failed content: application/xml: schema: type: object description: Document upload failed xml: name: Error properties: Code: type: string description: Error code example: Bad Digest Message: type: string description: Error detail example: A client error (InvalidDigest) occurred when calling the PutObject operation - The Content-MD5 you specified was invalid. Resource: type: string description: Resource description example: /example_path_here/6d8433c1-cd55-4c24-affd-f592287a7572.upload RequestId: type: string description: Identifier for debug purposes '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' application/xml: schema: $ref: '#/components/schemas/errorModel' /evidence-submissions/{id}: get: summary: Returns all of the data associated with a specific Supplemental Claim Evidence Submission. tags: - Supplemental Claims operationId: getSupplementalClaimEvidenceSubmission description: Returns all of the data associated with a specific Supplemental Claim Evidence Submission. security: - productionOauth: - veteran/SupplementalClaims.read - representative/SupplementalClaims.read - system/SupplementalClaims.read - sandboxOauth: - veteran/SupplementalClaims.read - representative/SupplementalClaims.read - system/SupplementalClaims.read - bearer_token: [] parameters: - name: id in: path description: Supplemental Claim UUID Evidence Submission schema: type: string format: uuid required: true responses: '200': description: Info about a single Supplemental Claim Evidence Submission. content: application/json: example: data: id: 55555555-6666-7777-8888-999999999999 type: evidenceSubmission attributes: status: pending code: null detail: null location: null appealId: 00000000-1111-2222-3333-444444444444 finalStatus: false appealType: SupplementalClaim createDate: '2020-01-02T03:04:05.067Z' updateDate: '2020-01-02T03:04:05.067Z' schema: $ref: '#/components/schemas/scEvidenceSubmissionResponse_2' '403': description: Forbidden attempt using a veteran-scoped OAuth token to view an Evidence Submission belonging to another Veteran content: application/json: example: errors: - title: Forbidden detail: Veterans may access only their own records code: '403' status: '403' schema: $ref: '#/components/schemas/errorModel' '404': description: Supplemental Claim Evidence Submission not found content: application/json: example: errors: - title: Resource not found detail: Evidence Submission with uuid 00000000-0000-0000-0000-000000000000 not found code: '404' status: '404' schema: $ref: '#/components/schemas/errorModel' '500': description: Internal Server Error content: application/json: example: errors: - title: Internal server error detail: Internal server error code: '500' status: '500' schema: $ref: '#/components/schemas/errorModel' components: schemas: X-VA-Last-Name: allOf: - description: last name - $ref: '#/components/schemas/nonBlankString' scCreateResponse: description: Successful response of a 200995 form submission type: object properties: data: properties: id: type: string description: Unique ID of created SC example: 97751cb6-d06d-4179-87f6-75e3fc9d875c type: type: string description: Name of record class example: supplementalClaim attributes: type: object properties: status: type: string description: Status of SC example: pending enum: - pending - submitting - submitted - processing - success - complete - error createdAt: type: string description: Created timestamp of the SC example: '2020-12-16T19:52:23.909Z' updatedAt: type: string description: Updated timestamp of the SC example: '2020-12-16T19:52:23.909Z' formData: $ref: '#/components/schemas/scCreate' included: type: array items: $ref: '#/components/schemas/contestableIssue' timezone_2: type: string enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Coyhaique - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - Factory - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu icn: type: string description: Veteran's Master Person Index (MPI) Integration Control Number (ICN) pattern: ^[0-9]{10}V[0-9]{6}$ minLength: 17 maxLength: 17 example: 1012832025V743496 X-VA-NonVeteranClaimant-Middle-Initial: allOf: - description: middle initial - $ref: '#/components/schemas/nonBlankString' X-VA-ICN: description: Veteran's Integration Control Number, a unique identifier established via the Master Person Index (MPI) type: string minLength: 17 maxLength: 17 pattern: ^[0-9]{10}V[0-9]{6}$ errorModel: required: - errors properties: errors: type: array items: additionalProperties: false required: - title properties: title: type: string description: HTTP error title detail: type: string description: HTTP error detail code: type: string description: HTTP error code source: type: object additionalProperties: false description: Source of error properties: pointer: type: string description: Pointer to source of error parameter: type: string description: Invalid request parameter header: type: string description: Invalid header status: type: string description: HTTP error code meta: type: object description: Meta infomation properties: missing_fields: type: array items: type: string description: List of missing fields contestableIssue: type: object description: A contestable issue (to contest this, you include it as a RequestIssue when creating a HigherLevelReview, SupplementalClaim, or Appeal) properties: type: type: string enum: - contestableIssue id: type: string nullable: true attributes: type: object properties: ratingIssueReferenceId: type: string nullable: true description: RatingIssue ID example: '2385' ratingIssueProfileDate: type: string nullable: true format: date description: (yyyy-mm-dd) RatingIssue profile date example: '2006-05-31' ratingIssueDiagnosticCode: type: string nullable: true description: RatingIssue diagnostic code example: '5005' ratingDecisionReferenceId: type: string nullable: true description: The BGS ID for the contested rating decision. This may be populated while ratingIssueReferenceId is nil example: null decisionIssueId: type: integer nullable: true description: DecisionIssue ID example: null approxDecisionDate: type: string nullable: true format: date description: (yyyy-mm-dd) Approximate decision date example: '2006-11-27' description: type: string nullable: true description: Description example: Service connection for hypertension is granted with an evaluation of 10 percent effective July 24, 2005. rampClaimId: type: string nullable: true description: RampClaim ID example: null titleOfActiveReview: type: string nullable: true description: Title of DecisionReview that this issue is still active on example: null sourceReviewType: type: string nullable: true description: The type of DecisionReview (HigherLevelReview, SupplementalClaim, Appeal) the issue was last decided on (if any) example: null timely: type: boolean description: An issue is timely if the receipt date is within 372 dates of the decision date. example: false activeReview: type: boolean description: Indicates whether this issue is already part of an active Decision Review that is being processed by VA. Submitting a Decision Review that includes a listed issue with an activeReview of true may result in VA rejecting the submission. example: false latestIssuesInChain: type: array description: Shows the chain of decision and rating issues that preceded this issue. Only the most recent issue can be contested (the object itself that contains the latestIssuesInChain attribute). items: type: object properties: id: oneOf: - type: string nullable: true - type: integer example: null approxDecisionDate: type: string nullable: true format: date example: '2006-11-27' ratingIssueSubjectText: type: string nullable: true description: Short description of RatingIssue example: Hypertension ratingIssuePercentNumber: type: string nullable: true description: Numerical rating for RatingIssue example: '10' isRating: type: boolean description: Whether or not this is a RatingIssue example: true scCreate_2: type: object description: JSON Schema for VA Form 20-0995 properties: data: type: object properties: type: type: string enum: - supplementalClaim attributes: type: object properties: benefitType: type: string description: If the contested issue is a Disability Compensation issue, acknowledgement of form 5103 is required - see form5103Acknowledged. enum: - compensation - pensionSurvivorsBenefits - fiduciary - lifeInsurance - veteransHealthAdministration - veteranReadinessAndEmployment - loanGuaranty - education - nationalCemeteryAdministration claimantType: type: string enum: - veteran - spouse_of_veteran - child_of_veteran - parent_of_veteran - other claimantTypeOtherValue: type: string minLength: 1 maxLength: 25 veteran: type: object properties: ssn: allOf: - $ref: '#/components/schemas/ssn' - description: Veteran's SSN icn: $ref: '#/components/schemas/icn' firstName: allOf: - description: Veteran's first name minLength: 1 maxLength: 30 - $comment: can be whitespace, to accommodate those with 1 legal name - $ref: '#/components/schemas/nonBlankString' middleInitial: allOf: - description: Veteran's middle initial minLength: 1 maxLength: 1 - $ref: '#/components/schemas/nonBlankString' lastName: allOf: - description: Veteran's last name minLength: 1 maxLength: 40 - $ref: '#/components/schemas/nonBlankString' birthDate: description: Veteran's birth date type: string format: date fileNumber: $ref: '#/components/schemas/fileNumber' serviceNumber: allOf: - description: Veteran's service number minLength: 1 maxLength: 9 - $ref: '#/components/schemas/nonBlankString' insurancePolicyNumber: allOf: - description: Veteran's insurance policy number minLength: 1 maxLength: 18 - $ref: '#/components/schemas/nonBlankString' address: $ref: '#/components/schemas/address_2' phone: $ref: '#/components/schemas/phone' $comment: the phone fields must not exceed 20 chars, when concatenated email: type: string format: email minLength: 6 maxLength: 255 timezone: description: Veteran's timezone. Used for adding the current date to the signature according to the veteran's local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date). $ref: '#/components/schemas/timezone_2' required: - ssn - icn - firstName - lastName - birthDate - address - phone - email claimant: type: object description: If the claimant is a non-Veteran, claimant information is required. Without this information, we will be unable to identify the claimant. If you're a healthcare provider or an employee of a healthcare provider requesting review of a VA payment decision, you must identify the healthcare provider as the claimant and complete all relevant information in the claimant object. properties: firstName: allOf: - description: Non-Veteran Claimant's first name minLength: 1 maxLength: 30 - $ref: '#/components/schemas/nonBlankString' - $comment: Can be whitespace to accommodate those with 1 legal name middleInitial: allOf: - description: Non-Veteran Claimant's middle initial minLength: 1 maxLength: 1 - $ref: '#/components/schemas/nonBlankString' lastName: allOf: - description: Non-Veteran Claimant's last name minLength: 1 maxLength: 40 - $ref: '#/components/schemas/nonBlankString' address: $ref: '#/components/schemas/address_2' phone: $ref: '#/components/schemas/phone' $comment: the phone fields must not exceed 20 chars, when concatenated email: type: string format: email minLength: 6 maxLength: 255 timezone: description: Veteran's timezone. Used for adding the current date to the signature according to the veteran's local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date). $ref: '#/components/schemas/timezone_2' dependencies: firstName: - lastName middleInitial: - firstName - lastName lastName: - firstName required: - firstName - lastName - address - phone - email alternateSigner: description: Alternate signer information type: object properties: firstName: allOf: - description: Alternate signer's first name minLength: 1 maxLength: 30 - $ref: '#/components/schemas/nonBlankString' - $comment: Can be whitespace to accommodate those with 1 legal name middleInitial: allOf: - description: Alternate signer's middle initial minLength: 1 maxLength: 1 - $ref: '#/components/schemas/nonBlankString' lastName: allOf: - description: Alternate signer's last name minLength: 1 maxLength: 40 - $ref: '#/components/schemas/nonBlankString' dependencies: firstName: - lastName middleInitial: - firstName - lastName lastName: - firstName required: - firstName - lastName evidenceSubmission: description: Evidence may be uploaded up to 7 days from the 'created_at' date of the associated Supplemental Claim via 'supplemental_claims/evidence_submissions'. type: object properties: evidenceType: type: array description: '''upload'' indicates that the Veteran has supplied additional evidence as uploaded documents. ''retrieval'' indicates that the Veteran has supplied contact information for facilities holding evidence relevant to the claim; the ''retrieveFrom'' field will contain the facility''s contact information. ''none'' indicates that the Veteran has not supplied additional evidence' items: type: string enum: - upload - retrieval - none minItems: 1 uniqueItems: true if: contains: const: none then: maxItems: 1 else: maxItems: 2 retrieveFrom: type: array items: type: object properties: type: type: string enum: - retrievalEvidence attributes: type: object properties: locationAndName: type: string minLength: 1 maxLength: 255 evidenceDates: type: array items: type: object properties: startDate: type: string format: date endDate: type: string format: date required: - startDate - endDate minItems: 1 maxItems: 4 required: - locationAndName - evidenceDates required: - type - attributes minItems: 1 uniqueItems: true required: - evidenceType if: properties: evidenceType: contains: const: retrieval then: required: - retrieveFrom form5103Acknowledged: type: boolean description: 'The 5103 Notice regarding new & relevant evidence must be acknowledged when the issue(s) being contested is a Disability Compensation issue. The notice can be found here: http://www.va.gov/disability/how-to-file-claim/evidence-needed. If the issue(s) being submitted are Disability Compensation and ''No'' is selected, the API will return an error. Please ensure the Veteran reviews the content about the 5103 Notice at the link above.' allOf: - required: - veteran - benefitType - claimantType - evidenceSubmission - if: properties: benefitType: const: compensation then: required: - form5103Acknowledged properties: form5103Acknowledged: enum: - true - if: properties: claimantType: const: other then: required: - claimantTypeOtherValue - if: properties: claimantType: enum: - spouse_of_veteran - child_of_veteran - parent_of_veteran - other then: required: - claimant required: - type - attributes included: type: array items: type: object properties: type: type: string enum: - appealableIssue attributes: type: object properties: issue: type: string minLength: 1 maxLength: 140 decisionDate: type: string format: date decisionIssueId: type: integer ratingIssueReferenceId: type: string minLength: 1 maxLength: 255 ratingDecisionReferenceId: type: string minLength: 1 maxLength: 255 socDate: type: string format: date required: - issue - decisionDate required: - type - attributes minItems: 1 maxItems: 100 uniqueItems: true required: - data - included X-VA-NonVeteranClaimant-Last-Name: allOf: - description: last name - $ref: '#/components/schemas/nonBlankString' appealableIssue: type: object description: An appealable issue (to appeal this, you include it as a RequestIssue when creating a HigherLevelReview, SupplementalClaim, or Appeal) properties: type: type: string enum: - appealableIssue id: type: string nullable: true attributes: type: object properties: ratingIssueReferenceId: type: string nullable: true description: RatingIssue ID example: '2385' ratingIssueProfileDate: type: string nullable: true format: date description: (yyyy-mm-dd) RatingIssue profile date example: '2006-05-31' ratingIssueDiagnosticCode: type: string nullable: true description: RatingIssue diagnostic code example: '5005' ratingDecisionReferenceId: type: string nullable: true description: The BGS ID for the appealable rating decision. This may be populated while ratingIssueReferenceId is nil example: null decisionIssueId: type: integer nullable: true description: DecisionIssue ID example: null approxDecisionDate: type: string nullable: true format: date description: (yyyy-mm-dd) Approximate decision date example: '2006-11-27' description: type: string nullable: true description: Description example: Service connection for hypertension is granted with an evaluation of 10 percent effective July 24, 2005. rampClaimId: type: string nullable: true description: RampClaim ID example: null titleOfActiveReview: type: string nullable: true description: Title of DecisionReview that this issue is still active on example: null sourceReviewType: type: string nullable: true description: The type of DecisionReview (HigherLevelReview, SupplementalClaim, Appeal) the issue was last decided on (if any) example: null timely: type: boolean description: An issue is timely if the receipt date is within 372 dates of the decision date. example: false latestIssuesInChain: type: array description: Shows the chain of decision and rating issues that preceded this issue. Only the most recent issue can be appealed (the object itself that contains the latestIssuesInChain attribute). items: type: object properties: id: oneOf: - type: string nullable: true - type: integer example: null approxDecisionDate: type: string nullable: true format: date example: '2006-11-27' ratingIssueSubjectText: type: string nullable: true description: Short description of RatingIssue example: Hypertension ratingIssuePercentNumber: type: string nullable: true description: Numerical rating for RatingIssue example: '10' isRating: type: boolean description: Whether or not this is a RatingIssue example: true X-VA-File-Number: allOf: - description: VA file number (c-file / css) - maxLength: 9 - $ref: '#/components/schemas/nonBlankString' X-Alternate-Signer-Middle-Initial: description: Alternate signer's middle initial minLength: 1 maxLength: 1 $ref: '#/components/schemas/nonBlankString' scCreate: type: object properties: data: type: object properties: type: type: string enum: - supplementalClaim attributes: type: object properties: benefitType: type: string description: If the contested issue is a Disability Compensation issue, acknowledgement of form 5103 is required - see form5103Acknowledged. enum: - compensation - pensionSurvivorsBenefits - fiduciary - lifeInsurance - veteransHealthAdministration - veteranReadinessAndEmployment - loanGuaranty - education - nationalCemeteryAdministration homeless: type: boolean description: Indicates if the claimant is currently homeless or at risk of becoming homeless. homelessLivingSituation: description: 'Claimant''s current living situation; provide all that apply. For Other: ''A living situation not described by the previous options.''' type: array items: type: string enum: - I LIVE OR SLEEP IN A PLACE THAT IS NOT MEANT FOR REGULAR SLEEPING - I LIVE IN A SHELTER - I AM STAYING WITH A FRIEND OR FAMILY MEMBER, BECAUSE I AM UNABLE TO OWN A HOME RIGHT NOW - IN THE NEXT 30 DAYS, I WILL HAVE TO LEAVE A FACILITY, LIKE A HOMELESS SHELTER - IN THE NEXT 30 DAYS, I WILL LOSE MY HOME - NONE OF THESE SITUATIONS APPLY TO ME - OTHER homelessLivingSituationOther: description: Details for homeless living situation other type: string maxLength: 100 homelessPointOfContact: description: The name of a contact that can be used by VA in order to get in touch with a homeless claimant. type: string maxLength: 150 homelessPointOfContactPhone: description: Phone number for the Claimant's point of contact in order to get in touch with a homeless claimant. allOf: - $ref: '#/components/schemas/phone' - $comment: the phone fields must not exceed 20 chars, when concatenated mstUpcomingEventDisclosure: description: Allows the Claimant to indicate their consent for VBA to communicate with VHA regarding upcoming events related to the appeals process. type: string enum: - I CONSENT - I DO NOT CONSENT - I REVOKE PRIOR CONSENT - NOT APPLICABLE AND/OR NOT ENROLLED IN VHA HEALTHCARE claimantType: type: string enum: - veteran - spouse_of_veteran - child_of_veteran - parent_of_veteran - other claimantTypeOtherValue: type: string minLength: 1 maxLength: 25 veteran: type: object properties: address: $ref: '#/components/schemas/address' phone: allOf: - $ref: '#/components/schemas/phone' - $comment: the phone fields must not exceed 20 chars, when concatenated email: type: string format: email minLength: 6 maxLength: 255 timezone: allOf: - description: Veteran's timezone. Used for adding the current date to the signature according to the veteran's local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date). - $ref: '#/components/schemas/timezone' required: - address - phone - email claimant: type: object description: If the claimant is a non-Veteran, claimant information is required. Without this information, we will be unable to identify the claimant. If you're a healthcare provider or an employee of a healthcare provider requesting review of a VA payment decision, you must identify the healthcare provider as the claimant and complete all relevant information in the claimant object. properties: address: $ref: '#/components/schemas/address' phone: allOf: - $ref: '#/components/schemas/phone' - $comment: the phone fields must not exceed 20 chars, when concatenated email: type: string format: email minLength: 6 maxLength: 255 timezone: allOf: - description: Claimant's timezone. Used for adding the current date to the signature according to the claimant's local time. If not specified, the current UTC date will be used for the signature (which may be ahead or behind the local date). - $ref: '#/components/schemas/timezone' required: - address - phone - email evidenceSubmission: description: Evidence may be uploaded up to 7 days from the 'created_at' date of the associated Supplemental Claim via 'supplemental_claims/evidence_submissions'. type: object properties: treatmentLocations: type: array description: 'Claimant’s treatment locations; provide all that apply. For Other: ''A treatment location not described by the previous options.''' items: type: string enum: - PRIVATE HEALTH CARE PROVIDER - VA VET CENTER - COMMUNITY CARE - VA MEDICAL CENTERS (VAMC) AND COMMUNITY-BASED OUTPATIENT CLINICS (CBOC) - DEPARTMENT OF DEFENSE (DOD) MILITARY TREATMENT FACILITY(IES) (MTF) - OTHER treatmentLocationOther: description: Details for treatment location other type: string maxLength: 115 evidenceType: type: array description: '''upload'' indicates that the Veteran has supplied additional evidence as uploaded documents. ''retrieval'' indicates that the Veteran has supplied contact information for facilities holding evidence relevant to the claim; the ''retrieveFrom'' field will contain the facility''s contact information. ''none'' indicates that the Veteran has not supplied additional evidence.' items: type: string enum: - upload - retrieval - none minItems: 1 uniqueItems: true if: contains: const: none then: maxItems: 1 else: maxItems: 2 retrieveFrom: type: array items: type: object properties: type: type: string enum: - retrievalEvidence attributes: type: object properties: locationAndName: type: string minLength: 1 maxLength: 255 evidenceDates: type: array items: type: object properties: startDate: type: string format: date endDate: type: string format: date minItems: 1 maxItems: 4 noTreatmentDates: type: boolean description: Don't have treatment date required: - locationAndName required: - type - attributes minItems: 1 uniqueItems: true required: - evidenceType if: properties: evidenceType: contains: const: retrieval then: required: - retrieveFrom form5103Acknowledged: type: boolean description: 'The 5103 Notice regarding new & relevant evidence must be acknowledged when the issue(s) being contested is a Disability Compensation issue. The notice can be found here: http://www.va.gov/disability/how-to-file-claim/evidence-needed. If the issue(s) being submitted are Disability Compensation and ''No'' is selected, the API will return an error. Please ensure the Veteran reviews the content about the 5103 Notice at the link above.' socOptIn: type: boolean allOf: - required: - veteran - benefitType - claimantType - evidenceSubmission - socOptIn - if: properties: benefitType: const: compensation then: required: - form5103Acknowledged properties: form5103Acknowledged: enum: - true - if: properties: claimantType: const: other then: required: - claimantTypeOtherValue - if: properties: claimantType: enum: - spouse_of_veteran - child_of_veteran - parent_of_veteran - other then: required: - claimant required: - type - attributes included: type: array items: type: object properties: type: type: string enum: - contestableIssue - appealableIssue attributes: type: object properties: issue: type: string minLength: 1 maxLength: 140 decisionDate: type: string format: date decisionIssueId: type: integer ratingIssueReferenceId: type: string minLength: 1 maxLength: 255 ratingDecisionReferenceId: type: string minLength: 1 maxLength: 255 socDate: type: string format: date required: - issue - decisionDate required: - type - attributes minItems: 1 maxItems: 100 uniqueItems: true required: - data - included X-VA-SSN: description: social security number type: string minLength: 9 maxLength: 9 pattern: ^[0-9]{9}$ phone: type: object properties: countryCode: type: string pattern: ^[0-9]+$ minLength: 1 maxLength: 3 areaCode: type: string pattern: ^[0-9]{1,4}$ minLength: 1 maxLength: 4 phoneNumber: type: string pattern: ^[0-9]{1,14}$ minLength: 1 maxLength: 14 phoneNumberExt: type: string pattern: ^[a-zA-Z0-9]{1,10}$ minLength: 1 maxLength: 10 required: - phoneNumber ssn: type: string description: Social Security Number pattern: ^[0-9]{9} minLength: 9 maxLength: 9 nonBlankString: type: string pattern: '[^ \f\n\r\t\v\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]' scEvidenceSubmissionResponse_2: type: object properties: data: properties: id: description: The document upload identifier type: string format: uuid example: 6d8433c1-cd55-4c24-affd-f592287a7572 type: description: JSON API type specification type: string example: evidenceSubmission attributes: properties: status: type: string example: received enum: - received - processing - success - pending - uploaded - vbms - error - expired code: type: string nullable: true detail: type: string nullable: true description: Human readable error detail. Only present if status = "error" appealType: description: Type of associated appeal type: string example: SupplementalClaim appealId: description: GUID of associated appeal type: string format: uuid example: 2926ad2a-9372-48cf-8ec1-69e08e4799ef location: type: string nullable: true description: Location to which to PUT document Payload format: uri example: https://sandbox-api.va.gov/example_path_here/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee updateDate: description: The last time the submission was updated type: string format: date-time example: '2018-07-30T17:31:15.958Z' createDate: description: The time the submission was created type: string format: date-time example: '2018-07-30T17:31:15.958Z' finalStatus: description: Indicates whether the status of the submission is final. Submissions with a finalStatus of true will no longer update to a new status. type: boolean example: false required: - id - type - attributes required: - data scCreateResponse_2: description: Successful response of a 200995 form submission type: object properties: data: properties: id: type: string description: Unique ID of created supplemental claim example: 97751cb6-d06d-4179-87f6-75e3fc9d875c type: type: string description: Type of record example: supplementalClaim attributes: type: object properties: status: type: string description: Status of created supplemental claim example: pending enum: - pending - submitting - submitted - processing - success - complete - error createDate: type: string description: Created timestamp of the supplemental claim example: '2020-12-16T19:52:23.909Z' updateDate: type: string description: Updated timestamp of the supplemental claim example: '2020-12-16T19:52:23.909Z' formData: $ref: '#/components/schemas/scCreate_2' included: type: array items: $ref: '#/components/schemas/appealableIssue' X-VA-Birth-Date: description: Veteran's birth date type: string format: date fileNumber: description: Veteran's VA file number (c-file / css) type: string minLength: 7 maxLength: 9 example: '987654321' X-VA-Middle-Initial: allOf: - description: middle initial - $ref: '#/components/schemas/nonBlankString' timezone: type: string enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Asmera - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Timbuktu - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/ComodRivadavia - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Atka - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Buenos_Aires - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Catamarca - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Coral_Harbour - America/Cordoba - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Ensenada - America/Fort_Nelson - America/Fort_Wayne - America/Fortaleza - America/Glace_Bay - America/Godthab - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Indianapolis - America/Inuvik - America/Iqaluit - America/Jamaica - America/Jujuy - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Knox_IN - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Louisville - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Mendoza - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montreal - America/Montserrat - America/Nassau - America/New_York - America/Nipigon - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Pangnirtung - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Acre - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rainy_River - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Rosario - America/Santa_Isabel - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Shiprock - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Thunder_Bay - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Virgin - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/South_Pole - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Ashkhabad - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Calcutta - Asia/Chita - Asia/Choibalsan - Asia/Chongqing - Asia/Chungking - Asia/Colombo - Asia/Dacca - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Harbin - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Istanbul - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kashgar - Asia/Kathmandu - Asia/Katmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macao - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Rangoon - Asia/Riyadh - Asia/Saigon - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tel_Aviv - Asia/Thimbu - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ujung_Pandang - Asia/Ulaanbaatar - Asia/Ulan_Bator - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faeroe - Atlantic/Faroe - Atlantic/Jan_Mayen - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/ACT - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Canberra - Australia/Currie - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/LHI - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/NSW - Australia/North - Australia/Perth - Australia/Queensland - Australia/South - Australia/Sydney - Australia/Tasmania - Australia/Victoria - Australia/West - Australia/Yancowinna - Brazil/Acre - Brazil/DeNoronha - Brazil/East - Brazil/West - CET - CST6CDT - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Canada/Saskatchewan - Canada/Yukon - Chile/Continental - Chile/EasterIsland - Cuba - EET - EST - EST5EDT - Egypt - Eire - Etc/GMT - Etc/GMT+0 - Etc/GMT+1 - Etc/GMT+10 - Etc/GMT+11 - Etc/GMT+12 - Etc/GMT+2 - Etc/GMT+3 - Etc/GMT+4 - Etc/GMT+5 - Etc/GMT+6 - Etc/GMT+7 - Etc/GMT+8 - Etc/GMT+9 - Etc/GMT-0 - Etc/GMT-1 - Etc/GMT-10 - Etc/GMT-11 - Etc/GMT-12 - Etc/GMT-13 - Etc/GMT-14 - Etc/GMT-2 - Etc/GMT-3 - Etc/GMT-4 - Etc/GMT-5 - Etc/GMT-6 - Etc/GMT-7 - Etc/GMT-8 - Etc/GMT-9 - Etc/GMT0 - Etc/Greenwich - Etc/UCT - Etc/UTC - Etc/Universal - Etc/Zulu - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belfast - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kiev - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Nicosia - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Tiraspol - Europe/Ulyanovsk - Europe/Uzhgorod - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zaporozhye - Europe/Zurich - Factory - GB - GB-Eire - GMT - GMT+0 - GMT-0 - GMT0 - Greenwich - HST - Hongkong - Iceland - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Iran - Israel - Jamaica - Japan - Kwajalein - Libya - MET - MST - MST7MDT - Mexico/BajaNorte - Mexico/BajaSur - Mexico/General - NZ - NZ-CHAT - Navajo - PRC - PST8PDT - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Enderbury - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Johnston - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Ponape - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Samoa - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Truk - Pacific/Wake - Pacific/Wallis - Pacific/Yap - Poland - Portugal - ROC - ROK - Singapore - Turkey - UCT - US/Alaska - US/Aleutian - US/Arizona - US/Central - US/East-Indiana - US/Eastern - US/Hawaii - US/Indiana-Starke - US/Michigan - US/Mountain - US/Pacific - US/Samoa - UTC - Universal - W-SU - WET - Zulu scEvidenceSubmissionResponse: type: object properties: data: properties: id: description: The document upload identifier type: string format: uuid example: 6d8433c1-cd55-4c24-affd-f592287a7572 type: description: JSON API type specification type: string example: evidenceSubmission attributes: properties: status: type: string example: received enum: - received - processing - success - pending - uploaded - vbms - error - expired code: type: string nullable: true detail: type: string nullable: true description: Human readable error detail. Only present if status = "error" appealType: description: Type of associated appeal type: string example: SupplementalClaim appealId: description: GUID of associated appeal type: string format: uuid example: 2926ad2a-9372-48cf-8ec1-69e08e4799ef location: type: string nullable: true description: Location to which to PUT document Payload format: uri example: https://sandbox-api.va.gov/example_path_here/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee updatedAt: description: The last time the submission was updated type: string format: date-time example: '2018-07-30T17:31:15.958Z' createdAt: description: The time the submission was created type: string format: date-time example: '2018-07-30T17:31:15.958Z' finalStatus: description: Indicates whether the status of the submission is final. Submissions with a finalStatus of true will no longer update to a new status. type: boolean example: false required: - id - type - attributes required: - data address: type: object properties: addressLine1: type: string minLength: 1 maxLength: 60 addressLine2: type: string minLength: 1 maxLength: 30 addressLine3: type: string minLength: 1 maxLength: 10 city: type: string minLength: 1 maxLength: 60 stateCode: type: string enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FM - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MH - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY countryCodeISO2: type: string pattern: ^[A-Z]{2}$ minLength: 2 maxLength: 2 zipCode5: type: string description: 5-digit zipcode. Use "00000" if address is outside the United States pattern: ^[0-9]{5}$ minLength: 5 maxLength: 5 internationalPostalCode: type: string minLength: 1 maxLength: 16 required: - addressLine1 - city - countryCodeISO2 - zipCode5 X-Alternate-Signer-First-Name: description: Alternate signer's first name type: string minLength: 1 maxLength: 30 scEvidenceSubmissionCreate: $schema: http://json-schema.org/draft-07/schema# description: JSON Schema for evidence submissions for VA Form 20-0995 type: object properties: scId: type: string format: uuid description: Associated Supplemental Claim UUID example: 7efd87fc-fac1-4851-a4dd-b9aa2533f57f ssn: allOf: - $ref: '#/components/schemas/ssn' - description: Veteran's SSN required: - scId - ssn address_2: type: object properties: addressLine1: type: string minLength: 1 maxLength: 60 addressLine2: type: string minLength: 1 maxLength: 30 addressLine3: type: string minLength: 1 maxLength: 10 city: type: string minLength: 1 maxLength: 60 stateCode: type: string enum: - AL - AK - AS - AZ - AR - AA - AE - AP - CA - CO - CT - DE - DC - FM - FL - GA - GU - HI - ID - IL - IN - IA - KS - KY - LA - ME - MH - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - MP - OH - OK - OR - PW - PA - PR - RI - SC - SD - TN - TX - UT - VT - VI - VA - WA - WV - WI - WY countryCodeIso3: description: Three letter ISO 3166-1 country code type: string pattern: ^[A-Z]{3}$ minLength: 3 maxLength: 3 example: USA zipCode5: type: string description: Five digit zipcode. Use "00000" if address is outside the United States pattern: ^[0-9]{5}$ minLength: 5 maxLength: 5 internationalPostalCode: type: string minLength: 1 maxLength: 16 required: - addressLine1 - city - countryCodeIso3 - zipCode5 X-VA-NonVeteranClaimant-First-Name: allOf: - description: first name - $ref: '#/components/schemas/nonBlankString' X-VA-Insurance-Policy-Number: allOf: - description: Veteran's insurance policy number maxLength: 18 - $ref: '#/components/schemas/nonBlankString' X-VA-First-Name: allOf: - description: first name - type: string X-Alternate-Signer-Last-Name: description: Alternate signer's last name minLength: 1 maxLength: 40 $ref: '#/components/schemas/nonBlankString' securitySchemes: bearer_token: type: http scheme: bearer bearerFormat: JWT productionOauth: type: oauth2 description: 'The authentication model for the Appealable Issues API uses OAuth 2.0/OpenID Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code) and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials).' flows: authorizationCode: authorizationUrl: https://api.va.gov/oauth2/appeals/v1/authorization tokenUrl: https://api.va.gov/oauth2/appeals/v1/token scopes: veteran/AppealableIssues.read: Appealable issues info veteran/appeals.read: Appeals info representative/AppealableIssues.read: Appealable issues info representative/appeals.read: Appeals info clientCredentials: tokenUrl: 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). scopes: system/AppealableIssues.read: Appealable issues info system/appeals.read: Appeals info sandboxOauth: type: oauth2 description: 'The authentication model for the Appealable Issues API uses OAuth 2.0/OpenID Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code) and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials).' flows: authorizationCode: authorizationUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/authorization tokenUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/token scopes: veteran/AppealableIssues.read: Appealable issues info veteran/appeals.read: Appeals info representative/AppealableIssues.read: Appealable issues info representative/appeals.read: Appeals info clientCredentials: tokenUrl: https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token scopes: system/AppealableIssues.read: Appealable issues info system/appeals.read: Appeals info