{"openapi":"3.0.1","info":{"title":"Benefits Claims","version":"v2","description":"## Background\n\nThe Benefits Claims API Version 2 lets internal consumers:\n\n- Retrieve existing claim information, including status, by claim ID.\n- Automatically establish an intent to file at VA.\n- Automatically establish a disability compensation claim (VA Form 21-526EZ) at VA.\n- Digitally submit supporting documentation for disability compensation claims.\n- Retrieve a claimant’s currently appointed accredited representative.\n- Request the appointment of an accredited representative, on behalf of a claimant.\n- Accept or decline the request to appoint an accredited representative, on behalf of the representative.\n- Automatically establish an organization as a claimant’s accredited representative (VA Form 21-22).\n- Automatically establish an individual as a claimant’s accredited representative (VA Form 21-22a).\n\nYou should use\nthe [Benefits Claims API Version 1](https://developer.va.gov/explore/benefits/docs/claims?version=current) if you are a\nconsumer outside of VA and do not have the necessary VA agreements to use this API.\n\n## Appointing an accredited representative for dependents\n\nDependents of Veterans, such as spouses, children (biological and step), and parents (biological and foster) may be\neligible for VA benefits and can request representation by an accredited representative.\n\nTo file claims through an accredited representative, dependents must appoint their own. Once appointed, the\nrepresentative will have power of attorney (POA) to assist with the dependentʼs VA claims.\n\nBefore appointing a representative, the dependentʼs relationship to the Veteran must be established. If a new\nrepresentative is being appointed, the dependentʼs relationship to the Veteran will be validated first. The\nrepresentative will be appointed to the dependent, not the Veteran.\n\n## Technical Overview\n\nThis API accepts a payload of requests and responses with the payload identifying the claim and claimant. Responses\nprovide the submission’s processing status. Responses also provide a unique ID which can be used with the appropriate\nGET endpoint to return detailed, end-to-end claims status tracking.\n\nEnd-to-end claims tracking provides the status of claims as they move through the submission process, but does not\nreturn whether the claim was approved or denied.\n\n### Claim statuses\n\nAfter you submit a disability compensation claim with the `POST /veterans/{veteranId}/526/synchronous` endpoint, it is\nthen established in Veterans Benefits Management System (VBMS). A `202` response means that the claim was successfully\nsubmitted by the API. However, it does not mean VA has received the required 526EZ PDF.\n\nTo confirm the status of your submission, use the `GET /veterans/{veteranId}/claims/{id}` endpoint and the ID returned\nwith your submission response. Statuses are:\n\n* **Pending**: The claim is successfully submitted for processing\n* **Errored**: The submission encountered upstream errors\n* **Canceled**: The claim was identified as a duplicate, or another issue caused the claim to be canceled.\n    * For duplicate claims, the claim's progress is tracked under a different Claim ID than the one returned in your\n      submission response.\n* **Claim received**: The claim was received, but hasn't been assigned to a reviewer yet.\n* **Initial review**: The claim has been assigned to a reviewer, who will determine if more information is needed.\n* **Evidence gathering, review, and decision**: VA is gathering evidence to make a decision from health care providers,\n  government agencies, and other sources.\n* **Preparation for notification**: VA has made a decision on the claim, and is getting a decision letter ready to mail.\n* **Complete**: VA has sent a decision letter by U.S. mail.\n\n### Finding a claimant's unique VA ID\n\nThis API uses Integration Control Number (ICN) as a unique identifier to identify the subject of each API request. This\nidentifier should be used as the `{veteranId}` parameter in request URLs.\n\n**Note**: though ICNs are typically static, they may change over time. If a specific ICN suddenly responds with a\n`404 not found` error, it may have changed. It’s a good idea to periodically check the ICN for each claimant.\n\n### Authentication and authorization\n\nThe authentication model for the Benefits Claims Version 2 is based on OAuth 2.0 / OpenID Connect and supports\nthe [client credentials grant](https://developer.va.gov/explore/authorization/docs/client-credentials?api=claims).\n\n**Important:**\n\n- To get production access to this API using client credentials grant, you must either work for VA or have specific VA\n  agreements in place.\n- Some endpoints have additional access restrictions. To get sandbox or production access to individual endpoints\n  labeled (restricted access), you must be an approved Federal consumer of the data they provide.\n- If you have questions about these API access restrictions, [contact us](https://developer.va.gov/support/contact-us).\n\n### Test data for sandbox environment use\n\nWe use\nmock [test data in the sandbox environment](https://developer.va.gov/explore/api/benefits-claims/test-users/2671/f1097c9772b447bb755b26dcd3e652aecad632389a28f0e19a7ebb082808db39).\nSandbox test data and test users for the Benefits Claims API are valid for all versions of the API.\n"},"tags":[{"name":"Claims","description":"Allows authenticated and authorized users to access claims data for a given VA claimant. No data is returned if the user is not authenticated and authorized.\n"},{"name":"5103 Waiver","description":"Allows authenticated and authorized users to file a 5103 Notice Response on a claim."},{"name":"Intent to File","description":"Allows authenticated and authorized users to automatically establish an Intent to File (21-0966) in VBMS.\n"},{"name":"Disability Compensation Claims","description":"Allows authenticated and authorized users to automatically establish a Disability Compensation Claim (21-526EZ) in VBMS\n"},{"name":"Power of Attorney","description":"Allows authenticated and authorized users to automatically establish power of attorney appointments to an organization or an individual. Organizations and individuals must be VA accredited representatives.\n"}],"components":{"securitySchemes":{"bearer_token":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"productionOauth":{"type":"oauth2","description":"This API uses OAuth 2 with the client credential grant flow. [More info](https://developer.va.gov/explore/api/benefits-claims/client-credentials)","flows":{"authorizationCode":{"authorizationUrl":"https://api.va.gov/oauth2/authorization","tokenUrl":"https://api.va.gov/oauth2/token","scopes":{"system/claim.read":"Retrieve claim data","system/claim.write":"Submit claim data"}}}},"sandboxOauth":{"type":"oauth2","description":"This API uses OAuth 2 with the client credential grant flow. [More info](https://developer.va.gov/explore/api/benefits-claims/client-credentials)","flows":{"authorizationCode":{"authorizationUrl":"https://sandbox-api.va.gov/oauth2/authorization","tokenUrl":"https://sandbox-api.va.gov/oauth2/token","scopes":{"system/claim.read":"Retrieve claim data","system/claim.write":"Submit claim data"}}}}}},"paths":{"/veterans/{veteranId}/claims/{id}/5103":{"post":{"summary":"Submit Evidence Waiver 5103","tags":["5103 Waiver"],"operationId":"POST:/veterans/{veteranId}/claims/{id}/5103","security":[{"productionOauth":["system/claim.write"]},{"sandboxOauth":["system/claim.write"]},{"bearer_token":[]}],"description":"Submit Evidence Waiver 5103 for a VA claimant.","parameters":[{"name":"id","in":"path","example":"600400703","description":"The ID of the claim being requested","required":true,"schema":{"type":"string"}},{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful response","content":{"application/json":{"example":{"success":true},"schema":{"type":"object","additionalProperties":true,"properties":{"success":{"type":"boolean","example":"true"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"NotFound","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Claim not found"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Claims API 5103 Schema","type":"object","additionalProperties":false,"properties":{"trackedItemIds":{"description":"Array of tracked items ids.","type":"array","nullable":true,"uniqueItems":true,"items":{"type":"integer","additionalProperties":false}}}}}}},"example":{"data":{"type":"form/5103","attributes":{"trackedItemIds":[1234]}}}}}}}}},"/veterans/{veteranId}/526/synchronous":{"post":{"summary":"Submits disability compensation claim synchronously (restricted access)","tags":["Disability Compensation Claims"],"operationId":"POST:/veterans/{veteranId}/526/synchronous","security":[{"productionOauth":["system/526.override"]},{"sandboxOauth":["system/526.override"]}],"description":"Automatically establishes a disability compensation claim (21-526EZ) in Veterans Benefits Management System (VBMS). This endpoint synchronously generates a filled and electronically signed 526EZ form and establishes the disability claim in VBMS. The 526EZ form is uploaded asynchronously.\n\nA 202 response indicates the API submission was accepted and the claim was established in VBMS. Check claim status using the GET veterans/{veteranId}/claims/{id} endpoint. The claim status details response will return the associated 526EZ PDF in the supportingDocuments list.\n\n**A substantially complete 526EZ claim must include:**\n* Veteran's name\n* Sufficient service information for VA to verify the claimed service\n* At least one claimed disability or medical condition and how it relates to service\n* Veteran and/or Representative signature\n\n**Standard and fully developed claims (FDCs)**\n\n[Fully developed claims (FDCs)](https://www.va.gov/disability/how-to-file-claim/evidence-needed/fully-developed-claims/)\nare claims certified by the submitter to include all information needed for processing. These claims process faster \nthan claims submitted through the standard claim process. If a claim is certified for the FDC, but is missing needed information, \nit will be processed as a standard claim.\n\nTo certify a claim for the FDC process, set the claimProcessType to FDC_PROGRAM.\n","parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"202":{"description":"Successful response","content":{"application/json":{"examples":{"202 without a transactionId":{"value":{"data":{"id":"00000000-0000-0000-0000-000000000001","type":"forms/526","attributes":{"claimId":"600442191","claimProcessType":"STANDARD_CLAIM_PROCESS","claimNotes":"Some things that are important to know, and are not included in any other place.","veteranIdentification":{"serviceNumber":"123456789","veteranNumber":{"telephone":"5555555555","internationalTelephone":"+44 20 1234 5678"},"mailingAddress":{"addressLine1":"1234 Couch Street","addressLine2":"Unit 4","addressLine3":"Room 1","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"1234"},"emailAddress":{"email":"valid@somedomain.com","agreeToEmailRelatedToClaim":true},"currentVaEmployee":false},"changeOfAddress":{"typeOfAddressChange":"TEMPORARY","addressLine1":"10 Peach St","addressLine2":"Unit 4","addressLine3":"Room 1","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"9897","dates":{"beginDate":"2025-12-31","endDate":"2025-12-31"}},"homeless":{"isCurrentlyHomeless":true,"currentlyHomeless":{"homelessSituationOptions":"FLEEING_CURRENT_RESIDENCE","otherDescription":"ABCDEFGHIJKLM"},"isAtRiskOfBecomingHomeless":false,"pointOfContact":"john stewart","pointOfContactNumber":{"telephone":"5555555555","internationalTelephone":"+44 20 1234 5678"}},"toxicExposure":{"gulfWarHazardService":{"servedInGulfWarHazardLocations":"YES","serviceDates":{"beginDate":"2018-07","endDate":"2018-08"}},"herbicideHazardService":{"servedInHerbicideHazardLocations":"YES","otherLocationsServed":"ABCDEFGHIJKLM","serviceDates":{"beginDate":"2018-07","endDate":"2018-08"}},"additionalHazardExposures":{"additionalExposures":["ASBESTOS","SHIPBOARD_HAZARD_AND_DEFENSE"],"specifyOtherExposures":"Other exposure details","exposureDates":{"beginDate":"2018-07","endDate":"2018-08"}},"multipleExposures":[{"hazardExposedTo":"RADIATION","exposureLocation":"Guam","exposureDates":{"beginDate":"2012-12","endDate":"2013-07"}}]},"disabilities":[{"name":"Traumatic Brain Injury","exposureOrEventOrInjury":"EXPOSURE","serviceRelevance":"ABCDEFG","approximateDate":"2018-03-11","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":9020,"isRelatedToToxicExposure":true,"secondaryDisabilities":[{"name":"Post Traumatic Stress Disorder (PTSD) Combat - Mental Disorders","exposureOrEventOrInjury":"EXPOSURE","serviceRelevance":"ABCDEFGHIJKLMNOPQ","disabilityActionType":"SECONDARY","approximateDate":"2018-03-12","classificationCode":"9014"}]},{"name":"Cancer - Musculoskeletal - Elbow","exposureOrEventOrInjury":"EXPOSURE","approximateDate":"2018-03-02","serviceRelevance":"ABCDEFG","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":249470,"isRelatedToToxicExposure":true},{"name":"Cancer - Musculoskeletal - Knee","exposureOrEventOrInjury":"EXPOSURE","approximateDate":"2015","serviceRelevance":"ABCDEFG","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":249470,"isRelatedToToxicExposure":true}],"treatments":[{"beginDate":"2009-03","treatedDisabilityNames":["Traumatic Brain Injury","Post Traumatic Stress Disorder (PTSD) Combat - Mental Disorders","Cancer - Musculoskeletal - Elbow"],"center":{"name":"Center One","city":"Decatur","state":"GA"}}],"serviceInformation":{"alternateNames":["john jacob","johnny smith"],"servicePeriods":[{"serviceBranch":"Public Health Service","serviceComponent":"Active","activeDutyBeginDate":"2008-11-14","activeDutyEndDate":"2023-10-30","separationLocationCode":"98282"}],"servedInActiveCombatSince911":"NO","reservesNationalGuardService":{"component":"National Guard","obligationTermsOfService":{"beginDate":"2019-06-04","endDate":"2020-06-04"},"unitName":"National Guard Unit Name","unitAddress":"1243 pine court","unitPhone":{"areaCode":"555","phoneNumber":"5555555"},"receivingInactiveDutyTrainingPay":"YES"},"federalActivation":{"activationDate":"2023-10-01","anticipatedSeparationDate":"2025-12-31"},"confinements":[{"approximateBeginDate":"2018-06-04","approximateEndDate":"2018-07-04"},{"approximateBeginDate":"2020-06","approximateEndDate":"2020-07"}]},"servicePay":{"receivingMilitaryRetiredPay":"NO","futureMilitaryRetiredPay":"YES","futureMilitaryRetiredPayExplanation":"ABCDEFGHIJKLMNOPQRSTUVW","militaryRetiredPay":{"branchOfService":"Army","monthlyAmount":840},"retiredStatus":"PERMANENT_DISABILITY_RETIRED_LIST","favorMilitaryRetiredPay":false,"receivedSeparationOrSeverancePay":"NO","separationSeverancePay":{"datePaymentReceived":"2022-03-12","branchOfService":"Naval Academy","preTaxAmountReceived":379},"favorTrainingPay":true},"directDeposit":{"noAccount":false,"accountNumber":"ABCDEF","accountType":"CHECKING","financialInstitutionName":"Chase","routingNumber":"123123123"},"claimantCertification":true}}}},"202 with a transactionId":{"value":{"data":{"id":"00000000-0000-0000-0000-000000000002","type":"forms/526","attributes":{"claimId":"600442191","claimProcessType":"STANDARD_CLAIM_PROCESS","claimNotes":"Some things that are important to know, and are not included in any other place.","veteranIdentification":{"serviceNumber":"123456789","veteranNumber":{"telephone":"5555555555","internationalTelephone":"+44 20 1234 5678"},"mailingAddress":{"addressLine1":"1234 Couch Street","addressLine2":"Unit 4","addressLine3":"Room 1","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"1234"},"emailAddress":{"email":"valid@somedomain.com","agreeToEmailRelatedToClaim":true},"currentVaEmployee":false},"changeOfAddress":{"typeOfAddressChange":"TEMPORARY","addressLine1":"10 Peach St","addressLine2":"Unit 4","addressLine3":"Room 1","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"9897","dates":{"beginDate":"2025-12-31","endDate":"2025-12-31"}},"homeless":{"isCurrentlyHomeless":true,"currentlyHomeless":{"homelessSituationOptions":"FLEEING_CURRENT_RESIDENCE","otherDescription":"ABCDEFGHIJKLM"},"isAtRiskOfBecomingHomeless":false,"pointOfContact":"john stewart","pointOfContactNumber":{"telephone":"5555555555","internationalTelephone":"+44 20 1234 5678"}},"toxicExposure":{"gulfWarHazardService":{"servedInGulfWarHazardLocations":"YES","serviceDates":{"beginDate":"2018-07","endDate":"2018-08"}},"herbicideHazardService":{"servedInHerbicideHazardLocations":"YES","otherLocationsServed":"ABCDEFGHIJKLM","serviceDates":{"beginDate":"2018-07","endDate":"2018-08"}},"additionalHazardExposures":{"additionalExposures":["ASBESTOS","SHIPBOARD_HAZARD_AND_DEFENSE"],"specifyOtherExposures":"Other exposure details","exposureDates":{"beginDate":"2018-07","endDate":"2018-08"}},"multipleExposures":[{"hazardExposedTo":"RADIATION","exposureLocation":"Guam","exposureDates":{"beginDate":"2012-12","endDate":"2013-07"}}]},"disabilities":[{"name":"Traumatic Brain Injury","exposureOrEventOrInjury":"EXPOSURE","serviceRelevance":"ABCDEFG","approximateDate":"2018-03-11","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":9020,"isRelatedToToxicExposure":true,"secondaryDisabilities":[{"name":"Post Traumatic Stress Disorder (PTSD) Combat - Mental Disorders","exposureOrEventOrInjury":"EXPOSURE","serviceRelevance":"ABCDEFGHIJKLMNOPQ","disabilityActionType":"SECONDARY","approximateDate":"2018-03-12","classificationCode":"9014"}]},{"name":"Cancer - Musculoskeletal - Elbow","exposureOrEventOrInjury":"EXPOSURE","approximateDate":"2018-03-02","serviceRelevance":"ABCDEFG","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":249470,"isRelatedToToxicExposure":true},{"name":"Cancer - Musculoskeletal - Knee","exposureOrEventOrInjury":"EXPOSURE","approximateDate":"2015","serviceRelevance":"ABCDEFG","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":249470,"isRelatedToToxicExposure":true}],"treatments":[{"beginDate":"2009-03","treatedDisabilityNames":["Traumatic Brain Injury","Post Traumatic Stress Disorder (PTSD) Combat - Mental Disorders","Cancer - Musculoskeletal - Elbow"],"center":{"name":"Center One","city":"Decatur","state":"GA"}}],"serviceInformation":{"alternateNames":["john jacob","johnny smith"],"servicePeriods":[{"serviceBranch":"Public Health Service","serviceComponent":"Active","activeDutyBeginDate":"2008-11-14","activeDutyEndDate":"2025-12-31","separationLocationCode":"98282"}],"servedInActiveCombatSince911":"NO","reservesNationalGuardService":{"component":"National Guard","obligationTermsOfService":{"beginDate":"2019-06-04","endDate":"2020-06-04"},"unitName":"National Guard Unit Name","unitAddress":"1243 pine court","unitPhone":{"areaCode":"555","phoneNumber":"5555555"},"receivingInactiveDutyTrainingPay":"YES"},"federalActivation":{"activationDate":"2023-10-01","anticipatedSeparationDate":"2025-12-31"},"confinements":[{"approximateBeginDate":"2018-06-04","approximateEndDate":"2018-07-04"},{"approximateBeginDate":"2020-06","approximateEndDate":"2020-07"}]},"servicePay":{"receivingMilitaryRetiredPay":"NO","futureMilitaryRetiredPay":"YES","futureMilitaryRetiredPayExplanation":"ABCDEFGHIJKLMNOPQRSTUVW","militaryRetiredPay":{"branchOfService":"Army","monthlyAmount":840},"retiredStatus":"PERMANENT_DISABILITY_RETIRED_LIST","favorMilitaryRetiredPay":false,"receivedSeparationOrSeverancePay":"NO","separationSeverancePay":{"datePaymentReceived":"2022-03-12","branchOfService":"Naval Academy","preTaxAmountReceived":379},"favorTrainingPay":true},"directDeposit":{"noAccount":false,"accountNumber":"ABCDEF","accountType":"CHECKING","financialInstitutionName":"Chase","routingNumber":"123123123"},"claimantCertification":true}},"meta":{"transactionId":"00000000-0000-0000-0000-000000000003"}}}},"schema":{"name":"data","required":["data"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000004"},"type":{"type":"string","example":"form/8675309"},"attributes":{"description":"Claims API 526 Schema","type":"object","additionalProperties":false,"required":["claimProcessType","disabilities","serviceInformation","veteranIdentification"],"properties":{"claimProcessType":{"type":"string","description":"Select type of claim program/process that applies to the Veteran.","enum":["STANDARD_CLAIM_PROCESS","FDC_PROGRAM","BDD_PROGRAM"]},"veteranIdentification":{"type":"object","additionalProperties":false,"required":["mailingAddress","currentVaEmployee"],"properties":{"serviceNumber":{"type":"string","description":"Service identification number","maxLength":1000,"nullable":true},"veteranNumber":{"description":"If there isn't a ten digit phone number in VBMS for the Veteran, the exams will not be ordered. Including the phone number is recommended to avoid claim processing delays.","type":"object","nullable":true,"properties":{"telephone":{"description":"Veteran's phone number.","type":"string","pattern":"^\\d{10}?$","example":"5555555555","nullable":true},"internationalTelephone":{"type":"string","description":"Veteran's international phone number.","example":"+44 20 1234 5678","maxLength":1000,"nullable":true}}},"mailingAddress":{"type":"object","additionalProperties":false,"required":["addressLine1","city","country"],"properties":{"addressLine1":{"description":"Address line 1 for the Veteran's current mailing address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"1234 Couch Street"},"addressLine2":{"description":"Address line 2 for the Veteran's current mailing address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Unit 4","nullable":true},"addressLine3":{"description":"Address line 3 for the Veteran's current mailing address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Room 1","nullable":true},"city":{"description":"City for the Veteran's current mailing address.","type":"string","pattern":"^$|([a-zA-Z0-9\\'-'.# ]([a-zA-Z0-9\\'-'.# ])?)+$","minLength":1,"maxLength":20,"example":"Schenectady"},"state":{"description":"State for the Veteran's current mailing address. Required if 'country' is 'USA'.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"NY","nullable":true},"country":{"description":"Country for the Veteran's current mailing address.  Must match the values returned by the /countries endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","maxLength":1000,"example":"USA"},"zipFirstFive":{"description":"Zip code (First 5 digits) for the Veteran's current mailing address. Required if 'country' is 'USA'.","type":"string","pattern":"^\\d{5}?$","example":"12345","nullable":true},"zipLastFour":{"description":"Zip code (Last 4 digits) for the Veteran's current mailing address.","type":"string","pattern":"^\\d{4}?$","example":"6789","nullable":true},"internationalPostalCode":{"description":"International postal code for the Veteran's current mailing address. Do not include if 'country' is 'USA'.","type":"string","maxLength":16,"nullable":true,"pattern":"^[a-zA-Z0-9]*$"}}},"emailAddress":{"description":"Information associated with the Veteran's email address.","type":"object","nullable":true,"properties":{"email":{"type":"string","pattern":"^[^\\s@]+@([^\\s@.,]+\\.)+[^\\s@.,]{2,}$","description":"The most current email address of the Veteran.","maxLength":80,"nullable":true},"agreeToEmailRelatedToClaim":{"type":"boolean","description":"Agreement to email information relating to this claim.","example":true,"default":false,"nullable":true}}},"currentVaEmployee":{"type":"boolean","description":"Set to true if Veteran is a VA employee.","nullable":false}}},"changeOfAddress":{"description":"If 'changeOfAddress' is included, the following attributes are required: 'typeOfAddressChange', 'addressLine1', 'city', 'country'.","type":"object","nullable":true,"additionalProperties":false,"properties":{"typeOfAddressChange":{"description":"Temporary or Permanent change of address. If 'TEMPORARY', 'beginDate' and 'endDate' are required.","type":"string","enum":["TEMPORARY","PERMANENT"],"example":"PERMANENT"},"addressLine1":{"description":"Address line 1 for the Veteran's new address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"1234 Couch Street"},"addressLine2":{"description":"Address line 2 for the Veteran's new address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Unit 4","nullable":true},"addressLine3":{"description":"Address line 3 for the Veteran's new address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Room 1","nullable":true},"city":{"description":"City for the Veteran's new address.","type":"string","pattern":"^$|([a-zA-Z0-9\\'-'.# ]([a-zA-Z0-9\\'-'.# ])?)+$","minLength":0,"maxLength":20,"example":"Schenectady"},"state":{"description":"State for the Veteran's new address. Required if 'country' is 'USA'.","type":"string","pattern":"^$|^[a-z,A-Z]{2}$","example":"NY","nullable":true},"country":{"description":"Country for the Veteran's new address. Value must match the values returned by the /countries endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","maxLength":1000,"example":"USA"},"zipFirstFive":{"description":"Zip code (First 5 digits) for the Veteran's new address. Required if 'country' is 'USA'.","type":"string","pattern":"^$|^\\d{5}?$","example":"12345","nullable":true},"zipLastFour":{"description":"Zip code (Last 4 digits) for the Veteran's new address.","type":"string","nullable":true,"pattern":"^$|^\\d{4}?$","example":"6789"},"internationalPostalCode":{"description":"International postal code for the Veteran's new address. Do not include if 'country' is 'USA'.","type":"string","maxLength":16,"nullable":true,"pattern":"^[a-zA-Z0-9]*$"},"dates":{"type":"object","properties":{"beginDate":{"description":"Begin date for the Veteran's new address.","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","type":"string","nullable":true,"example":"2018-06-04"},"endDate":{"description":"Date in YYYY-MM-DD the changed address expires, if change is temporary.","type":"string","nullable":true,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-04"}}}}},"homeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"isCurrentlyHomeless":{"type":"boolean","nullable":true,"description":"Is the Veteran currently homeless?"},"currentlyHomeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"homelessSituationOptions":{"description":"Veteran's living situation.","type":"string","nullable":true,"default":"other","enum":["LIVING_IN_A_HOMELESS_SHELTER","NOT_CURRENTLY_IN_A_SHELTERED_ENVIRONMENT","STAYING_WITH_ANOTHER_PERSON","FLEEING_CURRENT_RESIDENCE","OTHER"],"example":"FLEEING_CURRENT_RESIDENCE"},"otherDescription":{"description":"Explanation of living situation. Required if 'homelessSituationOptions' is 'OTHER'.","type":"string","nullable":true,"maxLength":500,"example":"other living situation"}}},"isAtRiskOfBecomingHomeless":{"type":"boolean","nullable":true,"description":"Is the Veteran currently at risk of becoming homeless?"},"riskOfBecomingHomeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"livingSituationOptions":{"type":"string","nullable":true,"default":"HOUSING_WILL_BE_LOST_IN_30_DAYS","enum":["HOUSING_WILL_BE_LOST_IN_30_DAYS","LEAVING_PUBLICLY_FUNDED_SYSTEM_OF_CARE","OTHER"]},"otherDescription":{"description":"Explanation of living situation. Required if 'livingSituationOptions' is 'OTHER'.","type":"string","nullable":true,"maxLength":500,"example":"other living situation"}}},"pointOfContact":{"description":"Individual in direct contact with Veteran.","type":"string","nullable":true,"minLength":1,"maxLength":100,"pattern":"^([-a-zA-Z0-9/']+( ?))*$","example":"Jane Doe"},"pointOfContactNumber":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"telephone":{"description":"Ten digit primary phone of point of contact.","type":"string","pattern":"^\\d{10}?$","example":"5555555","nullable":true},"internationalTelephone":{"description":"International phone of point of contact.","type":"string","example":"+44 20 1234 5678","maxLength":1000,"nullable":true}}}}},"toxicExposure":{"type":"object","nullable":true,"properties":{"gulfWarHazardService":{"type":"object","nullable":true,"description":"Toxic exposure related to the Gulf war.","properties":{"servedInGulfWarHazardLocations":{"type":"string","description":"Set to true if the Veteran served in any of the following Gulf War hazard locations: Iraq; Kuwait; Saudi Arabia; the neutral zone between Iraq and Saudi Arabia; Bahrain; Qatar; the United Arab Emirates; Oman; Yemen; Lebanon; Somalia; Afghanistan; Israel; Egypt; Turkey; Syria; Jordan; Djibouti; Uzbekistan; the Gulf of Aden; the Gulf of Oman; the Persian Gulf; the Arabian Sea; and the Red Sea.","example":"YES","enum":["NO","YES"],"nullable":true},"serviceDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for serving in Gulf War hazard location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for serving in Gulf War hazard location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}},"herbicideHazardService":{"description":"Toxic exposure related to herbicide (Agent Orange) hazards.","type":"object","nullable":true,"properties":{"servedInHerbicideHazardLocations":{"type":"string","description":"Set to true if the Veteran served in any of the following herbicide/Agent Orange locations: Republic of Vietnam to include the 12 nautical mile territorial waters; Thailand at any United States or Royal Thai base; Laos; Cambodia at Mimot or Krek; Kampong Cham Province; Guam or American Samoa; or in the territorial waters thereof; Johnston Atoll or a ship that called at Johnston Atoll; Korean demilitarized zone; aboard (to include repeated operations and maintenance with) a C-123 aircraft known to have been used to spray an herbicide agent (during service in the Air Force and Air Force Reserves).","example":"YES","enum":["NO","YES"],"nullable":true},"otherLocationsServed":{"type":"string","nullable":true,"pattern":"^$|([a-zA-Z0-9\"\\/&\\(\\)\\-'.,#\\[\\] ]([a-zA-Z0-9(\\)\\-'.,#\\[\\] ])?)+$","maxLength":5000,"description":"Other location(s) where Veteran served."},"serviceDates":{"description":"Date range for exposure in herbicide hazard location.","type":"object","nullable":true,"properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for serving in herbicide location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for serving in herbicide location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}},"additionalHazardExposures":{"type":"object","nullable":true,"description":"Additional hazardous exposures.","properties":{"additionalExposures":{"description":"Additional exposure incidents.","type":"array","nullable":true,"uniqueItems":true,"items":{"type":"string","additionalProperties":false,"enum":["ASBESTOS","MUSTARD_GAS","RADIATION","SHIPBOARD_HAZARD_AND_DEFENSE","MILITARY_OCCUPATIONAL_SPECIALTY_RELATED_TOXIN","CONTAMINATED_WATER_AT_CAMP_LEJEUNE","OTHER"]}},"specifyOtherExposures":{"type":"string","nullable":true,"pattern":"^$|([a-zA-Z0-9\"\\/&\\(\\)\\-'.,#\\[\\] ]([a-zA-Z0-9(\\)\\-'.,#\\[\\] ])?)+$","maxLength":5000,"description":"Exposure to asbestos."},"exposureDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}},"multipleExposures":{"type":"array","nullable":true,"minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"hazardExposedTo":{"type":"string","nullable":true,"pattern":"^([-a-zA-Z0-9'.,&# ])+$","maxLength":1000,"description":"Hazard the Veteran was exposed to."},"exposureLocation":{"type":"string","nullable":true,"pattern":"^$|([a-zA-Z0-9\"\\/&\\(\\)\\-'.,#\\[\\] ]([a-zA-Z0-9(\\)\\-'.,#\\[\\] ])?)+$","maxLength":1000,"description":"Location where the exposure happened."},"exposureDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}}}}},"disabilities":{"description":"Any current disabilities or symptoms the Veteran is claiming are related to their military service and/or are service-connected.","type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["disabilityActionType","name"],"properties":{"name":{"description":"Name of the disability. The /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible disability names.\nWhen disabilityActionType is NEW or INCREASE, name must match pattern:\n^[a-zA-Z0-9'\\\",.#&;:%<>/()\\[\\]\\\\ -]+$","type":"string","example":"PTSD (post traumatic stress disorder)","maxLength":255},"exposureOrEventOrInjury":{"type":"string","description":"What caused the disability?","nullable":true,"maxLength":1000,"examples":["Agent Orange","radiation","burn pits"]},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury. If the disabilityActionType is 'NEW', the serviceRelevance is required.","type":"string","nullable":true,"maxLength":1000,"example":"Heavy equipment operator in service."},"approximateDate":{"description":"Approximate date disability began. Date must be in the past. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(?:[0-9]{4}(?:-(?!00)(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","example":"2018-03-02 or 2018-03 or 2018","nullable":true},"disabilityActionType":{"description":"Action type requested for the disability. If 'INCREASE' or 'NONE', then 'ratedDisabilityId' and 'diagnosticCode' should be included. 'NONE' should be used when including a secondary disability.","type":"string","enum":["NONE","NEW","INCREASE"],"example":"NEW"},"classificationCode":{"type":"string","description":"Classification code for the associated body system. Must match an active code returned by the /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","example":"249470","nullable":true},"ratedDisabilityId":{"description":"When submitting a contention with action type 'INCREASE', the previously rated disability id may be included.","type":"string","example":"1100583","nullable":true},"diagnosticCode":{"description":"If the disabilityActionType is 'NONE' or 'INCREASE', the diagnosticCode should correspond to an existing rated disability.","type":"integer","example":9999,"nullable":true},"isRelatedToToxicExposure":{"type":"boolean","description":"Is the disability related to toxic exposures? If true, related 'toxicExposure' must be included.","example":true,"default":false,"nullable":true},"specialIssues":{"type":"array","nullable":true,"uniqueItems":true,"items":{"maxItems":2,"additionalProperties":false,"type":"string","enum":["POW","EMP"]}},"secondaryDisabilities":{"description":"If secondaryDisability is included, the following attributes are required: 'secondaryDisability.name', 'secondaryDisability.disabilityActionType' and 'secondaryDisability.serviceRelevance'","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the disability. The /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible disability names.","type":"string","pattern":"^[a-zA-Z0-9'\",.#&;:%<>/()\\[\\]\\\\ -]+$","example":"PTSD (post traumatic stress disorder)","maxLength":255},"exposureOrEventOrInjury":{"type":"string","description":"What caused the disability?","nullable":true,"maxLength":1000,"examples":["Agent Orange","radiation","burn pits"]},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","nullable":true,"maxLength":1000,"example":"Heavy equipment operator in service."},"disabilityActionType":{"description":"The status of the secondary disability.","type":"string","example":"SECONDARY","enum":["SECONDARY"]},"approximateDate":{"description":"Approximate date disability began. Date must be in the past. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(?:[0-9]{4}(?:-(?!00)(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","example":"2018-03-02 or 2018-03 or 2018","nullable":true},"classificationCode":{"type":"string","description":"Classification code for the associated body system. Must match an active code returned by the /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","example":"249470","nullable":true}}}}}}},"treatments":{"description":"Identifies the Service Treatment information of the Veteran. The combination of treatedDisabilityName, center name, center city, and center state must be less than 10,000 characters to successfully generate a PDF.","type":"array","nullable":true,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"beginDate":{"description":"Begin date for treatment.","type":"string","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018","nullable":true},"treatedDisabilityNames":{"description":"Name(s) of disabilities treated in this time frame.","type":"array","nullable":true,"maxItems":150,"items":{"type":"string","additionalProperties":false,"example":["PTSD (post traumatic stress disorder)","Trauma"]}},"center":{"description":"VA Medical Center(s) and Department of Defense Military Treatment Facilities where the Veteran received treatment after discharge for any claimed disabilities.","type":"object","nullable":true,"additionalProperties":false,"properties":{"name":{"description":"Name of facility Veteran was treated in. The /treatment-centers endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible treatment center names.","type":"string","nullable":true,"pattern":"([a-zA-Z0-9\"/&()\\'-'.,# ]([a-zA-Z0-9()\\'-'.,# ])?)+$","example":"Private Facility 2","minLength":1,"maxLength":100},"city":{"description":"City of treatment facility.","type":"string","pattern":"([a-zA-Z0-9\\-'.# ]([a-zA-Z0-9\\-'.# ])?)+$","example":"Portland","nullable":true,"minLength":0,"maxLength":30},"state":{"description":"State of treatment facility.","type":"string","pattern":"^$|^[a-z,A-Z]{2}$","example":"OR","nullable":true}}}}}},"serviceInformation":{"type":"object","additionalProperties":false,"required":["servicePeriods"],"properties":{"alternateNames":{"description":"List any other names under which the Veteran served, if applicable.","type":"array","nullable":true,"maxItems":100,"items":{"type":"string","additionalProperties":false,"examples":["jane","janey lee","jane lee MacDonald"]}},"servicePeriods":{"description":"Identifies the Service dates and Branch the Veteran served in.","type":"array","minItems":1,"items":{"type":"object","required":["serviceBranch","serviceComponent","activeDutyBeginDate","activeDutyEndDate"],"properties":{"serviceBranch":{"description":"Branch of service during period. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","maxLength":1000,"example":"Air Force"},"serviceComponent":{"type":"string","description":"","enum":["Active","Reserves","National Guard"]},"activeDutyBeginDate":{"description":"Date started active duty. This date must be in the past.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"},"activeDutyEndDate":{"description":"Date Completed Active Duty. Cannot be more than 180 days in the future, unless past service is also included.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"},"separationLocationCode":{"description":"Location code for the facility the Veteran plans to separate from. Code must match the values returned by the /intake-sites endpoint on the [Benefits reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","nullable":true,"example":"98283"}}}},"servedInActiveCombatSince911":{"type":"string","enum":["YES","NO"],"description":"Did Veteran serve in a combat zone since 9-11-2001?","example":"YES","nullable":true},"reservesNationalGuardService":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"component":{"type":"string","nullable":true,"description":"","enum":["Reserves","National Guard"]},"obligationTermsOfService":{"type":"object","nullable":true,"description":"If 'obligationTermsOfService' is included, the following attributes are required: 'beginDate ' and 'endDate'.","additionalProperties":false,"properties":{"beginDate":{"type":"string","nullable":true,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"},"endDate":{"type":"string","nullable":true,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"}}},"unitName":{"type":"string","nullable":true,"maxLength":1000,"pattern":"^$|([a-zA-Z0-9\\-'.,# ][a-zA-Z0-9\\-'.,# ]?)*$"},"unitAddress":{"type":"string","maxLength":1000,"pattern":"^$|^([-a-zA-Z0-9'.,&# ])+$","nullable":true},"unitPhone":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"areaCode":{"type":"string","nullable":true,"maxLength":3,"pattern":"^$|^\\d{3}$","example":"555"},"phoneNumber":{"type":"string","nullable":true,"maxLength":20,"example":"5555555"}}},"receivingInactiveDutyTrainingPay":{"type":"string","enum":["YES","NO"],"nullable":true,"example":"YES"}}},"federalActivation":{"description":"If federalActivation is present then reservesNationalGuardService.obligationTermsOfService.beginDate, reservesNationalGuardService.obligationTermsOfService.endDate and reservesNationalGuardService.unitName are required","type":"object","nullable":true,"additionalProperties":false,"properties":{"activationDate":{"description":"Date cannot be in the future and must be after the earliest servicePeriod.activeDutyBeginDate.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06","nullable":true},"anticipatedSeparationDate":{"description":"Anticipated date of separation. Date must be in the future.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06","nullable":true}}},"confinements":{"type":"array","nullable":true,"uniqueItems":true,"items":{"additionalProperties":false,"type":"object","properties":{"approximateBeginDate":{"description":"The approximateBeginDate must be after the earliest servicePeriod activeDutyBeginDate.","type":"string","nullable":false,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$|(?:[0-9]{4})-(?:0[1-9]|1[0-2])$","example":"2018-06-06 or 2018-06"},"approximateEndDate":{"type":"string","nullable":false,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$|(?:[0-9]{4})-(?:0[1-9]|1[0-2])$","example":"2018-06-06 or 2018-06"}}}}},"if":{"required":["federalActivation"]},"then":{"required":["reservesNationalGuardService"],"properties":{"reservesNationalGuardService":{"required":["obligationTermsOfService"],"properties":{"obligationTermsOfService":{"required":["beginDate","endDate"]}}}}}},"servicePay":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"receivingMilitaryRetiredPay":{"description":"Is the Veteran receiving military retired pay?","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"futureMilitaryRetiredPay":{"description":"Will the Veteran receive military retired pay pay in future? \n If true, then 'futurePayExplanation' is required.","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"futureMilitaryRetiredPayExplanation":{"description":"Explains why future pay will be received.","type":"string","maxLength":1000,"example":"Will be retiring soon.","nullable":true},"militaryRetiredPay":{"type":"object","nullable":true,"description":"","properties":{"branchOfService":{"description":"Branch of service. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","maxLength":1000,"nullable":true,"example":"Air Force"},"monthlyAmount":{"description":"Amount being received.","type":"integer","nullable":true,"example":100}}},"retiredStatus":{"type":"string","nullable":true,"description":"","enum":["RETIRED","TEMPORARY_DISABILITY_RETIRED_LIST","PERMANENT_DISABILITY_RETIRED_LIST"]},"favorMilitaryRetiredPay":{"description":"Is the Veteran waiving VA benefits to retain military retired pay? See item 26 on form 21-526EZ for more details.","type":"boolean","nullable":true,"example":true,"default":false},"receivedSeparationOrSeverancePay":{"description":"Has the Veteran ever received separation pay, disability severance pay, or any other lump sum payment from their branch of service?","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"separationSeverancePay":{"type":"object","nullable":true,"description":"","properties":{"datePaymentReceived":{"description":"Approximate date separation pay was received. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02 or 2018-03 or 2018"},"branchOfService":{"description":"Branch of service. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","nullable":true,"maxLength":1000,"example":"Air Force"},"preTaxAmountReceived":{"description":"Amount being received.","type":"integer","nullable":true,"example":100}}},"favorTrainingPay":{"description":"Is the Veteran waiving VA benefits to retain training pay? See item 28 on form 21-526EZ for more details. ","type":"boolean","nullable":true,"example":true,"default":false}}},"directDeposit":{"type":"object","nullable":true,"additionalProperties":false,"description":"Direct deposit information.","properties":{"noAccount":{"type":"boolean","nullable":true,"description":"Claimant certifies that they do not have an account with a financial institution or certified payment agent.","default":false},"accountNumber":{"description":"Account number for the direct deposit.","pattern":"^(?:[a-zA-Z0-9-]{4,1000})?$","type":"string","maxLength":1000,"nullable":true,"example":"123123123123"},"accountType":{"description":"Account type for the direct deposit.","type":"string","nullable":true,"example":"CHECKING","enum":["CHECKING","SAVINGS"]},"financialInstitutionName":{"description":"Provide the name of the financial institution where the Veteran wants the direct deposit.","maxLength":1000,"type":"string","nullable":true,"example":"Some Bank"},"routingNumber":{"description":"Routing number for the direct deposit.","type":"string","maxLength":1000,"nullable":true,"pattern":"^$|^\\d{0,1000}$","example":"123123123"}}},"claimantCertification":{"type":"boolean","description":"Claimant certifies and authorizes release of information.","default":false},"claimNotes":{"type":"string","description":"An optional notes section.","maxLength":4000},"claimDate":{"description":"Date when claim is being submitted to the VA. Date cannot be in the future.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-04"},"claimId":{"type":"string","example":"600517517"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Unable to locate Veteran's ID/ICN in Master Person Index (MPI). Please submit an issue at ask.va.gov or call 1-800-MyVA411 (800-698-2411) for assistance."}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"examples":{"Violates JSON Schema":{"value":{"errors":[{"title":"Unprocessable entity","detail":"The property / did not contain the required key claimProcessType","status":"422","source":{"pointer":"data/attributes/"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key disabilities","status":"422","source":{"pointer":"data/attributes/"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key serviceInformation","status":"422","source":{"pointer":"data/attributes/"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key veteranIdentification","status":"422","source":{"pointer":"data/attributes/"}}]}},"Not a JSON Object":{"value":{"errors":[{"title":"Unprocessable entity","status":"422","detail":"The request body is not a valid JSON object: This is not valid JSON","source":{"pointer":null}}]}},"when federalActivation is present but obligationTermsOfService is missing":{"value":{"errors":[{"detail":"beginDate is missing or blank","source":"serviceInformation/reservesNationalGuardService/obligationTermsOfService/","title":"Unprocessable Entity","status":"422"},{"detail":"endDate is missing or blank","source":"serviceInformation/reservesNationalGuardService/obligationTermsOfService/","title":"Unprocessable Entity","status":"422"},{"title":"Unprocessable entity","detail":"The property /serviceInformation/reservesNationalGuardService/obligationTermsOfService did not contain the required key beginDate","status":"422","source":{"pointer":"data/attributes/serviceInformation/reservesNationalGuardService/obligationTermsOfService"}},{"title":"Unprocessable entity","detail":"The property /serviceInformation/reservesNationalGuardService/obligationTermsOfService did not contain the required key endDate","status":"422","source":{"pointer":"data/attributes/serviceInformation/reservesNationalGuardService/obligationTermsOfService"}}]}}},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","status","detail"],"properties":{"status":{"type":"string","description":"HTTP error code"},"detail":{"type":"string","description":"HTTP error detail"},"source":{"type":"object","pointer":{"type":"string"}},"title":{"type":"string"}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes",null],"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Claims API 526 Schema","type":"object","additionalProperties":false,"required":["claimProcessType","disabilities","serviceInformation","veteranIdentification"],"properties":{"claimProcessType":{"type":"string","description":"Select type of claim program/process that applies to the Veteran.","enum":["STANDARD_CLAIM_PROCESS","FDC_PROGRAM","BDD_PROGRAM"]},"veteranIdentification":{"type":"object","additionalProperties":false,"required":["mailingAddress","currentVaEmployee"],"properties":{"serviceNumber":{"type":"string","description":"Service identification number","maxLength":1000,"nullable":true},"veteranNumber":{"description":"If there isn't a ten digit phone number in VBMS for the Veteran, the exams will not be ordered. Including the phone number is recommended to avoid claim processing delays.","type":"object","nullable":true,"properties":{"telephone":{"description":"Veteran's phone number.","type":"string","pattern":"^\\d{10}?$","example":"5555555555","nullable":true},"internationalTelephone":{"type":"string","description":"Veteran's international phone number.","example":"+44 20 1234 5678","maxLength":1000,"nullable":true}}},"mailingAddress":{"type":"object","additionalProperties":false,"required":["addressLine1","city","country"],"properties":{"addressLine1":{"description":"Address line 1 for the Veteran's current mailing address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"1234 Couch Street"},"addressLine2":{"description":"Address line 2 for the Veteran's current mailing address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Unit 4","nullable":true},"addressLine3":{"description":"Address line 3 for the Veteran's current mailing address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Room 1","nullable":true},"city":{"description":"City for the Veteran's current mailing address.","type":"string","pattern":"^$|([a-zA-Z0-9\\'-'.# ]([a-zA-Z0-9\\'-'.# ])?)+$","minLength":1,"maxLength":20,"example":"Schenectady"},"state":{"description":"State for the Veteran's current mailing address. Required if 'country' is 'USA'.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"NY","nullable":true},"country":{"description":"Country for the Veteran's current mailing address.  Must match the values returned by the /countries endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","maxLength":1000,"example":"USA"},"zipFirstFive":{"description":"Zip code (First 5 digits) for the Veteran's current mailing address. Required if 'country' is 'USA'.","type":"string","pattern":"^\\d{5}?$","example":"12345","nullable":true},"zipLastFour":{"description":"Zip code (Last 4 digits) for the Veteran's current mailing address.","type":"string","pattern":"^\\d{4}?$","example":"6789","nullable":true},"internationalPostalCode":{"description":"International postal code for the Veteran's current mailing address. Do not include if 'country' is 'USA'.","type":"string","maxLength":16,"nullable":true,"pattern":"^[a-zA-Z0-9]*$"}}},"emailAddress":{"description":"Information associated with the Veteran's email address.","type":"object","nullable":true,"properties":{"email":{"type":"string","pattern":"^[^\\s@]+@([^\\s@.,]+\\.)+[^\\s@.,]{2,}$","description":"The most current email address of the Veteran.","maxLength":80,"nullable":true},"agreeToEmailRelatedToClaim":{"type":"boolean","description":"Agreement to email information relating to this claim.","example":true,"default":false,"nullable":true}}},"currentVaEmployee":{"type":"boolean","description":"Set to true if Veteran is a VA employee.","nullable":false}}},"changeOfAddress":{"description":"If 'changeOfAddress' is included, the following attributes are required: 'typeOfAddressChange', 'addressLine1', 'city', 'country'.","type":"object","nullable":true,"additionalProperties":false,"properties":{"typeOfAddressChange":{"description":"Temporary or Permanent change of address. If 'TEMPORARY', 'beginDate' and 'endDate' are required.","type":"string","enum":["TEMPORARY","PERMANENT"],"example":"PERMANENT"},"addressLine1":{"description":"Address line 1 for the Veteran's new address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"1234 Couch Street"},"addressLine2":{"description":"Address line 2 for the Veteran's new address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Unit 4","nullable":true},"addressLine3":{"description":"Address line 3 for the Veteran's new address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Room 1","nullable":true},"city":{"description":"City for the Veteran's new address.","type":"string","pattern":"^$|([a-zA-Z0-9\\'-'.# ]([a-zA-Z0-9\\'-'.# ])?)+$","minLength":0,"maxLength":20,"example":"Schenectady"},"state":{"description":"State for the Veteran's new address. Required if 'country' is 'USA'.","type":"string","pattern":"^$|^[a-z,A-Z]{2}$","example":"NY","nullable":true},"country":{"description":"Country for the Veteran's new address. Value must match the values returned by the /countries endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","maxLength":1000,"example":"USA"},"zipFirstFive":{"description":"Zip code (First 5 digits) for the Veteran's new address. Required if 'country' is 'USA'.","type":"string","pattern":"^$|^\\d{5}?$","example":"12345","nullable":true},"zipLastFour":{"description":"Zip code (Last 4 digits) for the Veteran's new address.","type":"string","nullable":true,"pattern":"^$|^\\d{4}?$","example":"6789"},"internationalPostalCode":{"description":"International postal code for the Veteran's new address. Do not include if 'country' is 'USA'.","type":"string","maxLength":16,"nullable":true,"pattern":"^[a-zA-Z0-9]*$"},"dates":{"type":"object","properties":{"beginDate":{"description":"Begin date for the Veteran's new address.","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","type":"string","nullable":true,"example":"2018-06-04"},"endDate":{"description":"Date in YYYY-MM-DD the changed address expires, if change is temporary.","type":"string","nullable":true,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-04"}}}}},"homeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"isCurrentlyHomeless":{"type":"boolean","nullable":true,"description":"Is the Veteran currently homeless?"},"currentlyHomeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"homelessSituationOptions":{"description":"Veteran's living situation.","type":"string","nullable":true,"default":"other","enum":["LIVING_IN_A_HOMELESS_SHELTER","NOT_CURRENTLY_IN_A_SHELTERED_ENVIRONMENT","STAYING_WITH_ANOTHER_PERSON","FLEEING_CURRENT_RESIDENCE","OTHER"],"example":"FLEEING_CURRENT_RESIDENCE"},"otherDescription":{"description":"Explanation of living situation. Required if 'homelessSituationOptions' is 'OTHER'.","type":"string","nullable":true,"maxLength":500,"example":"other living situation"}}},"isAtRiskOfBecomingHomeless":{"type":"boolean","nullable":true,"description":"Is the Veteran currently at risk of becoming homeless?"},"riskOfBecomingHomeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"livingSituationOptions":{"type":"string","nullable":true,"default":"HOUSING_WILL_BE_LOST_IN_30_DAYS","enum":["HOUSING_WILL_BE_LOST_IN_30_DAYS","LEAVING_PUBLICLY_FUNDED_SYSTEM_OF_CARE","OTHER"]},"otherDescription":{"description":"Explanation of living situation. Required if 'livingSituationOptions' is 'OTHER'.","type":"string","nullable":true,"maxLength":500,"example":"other living situation"}}},"pointOfContact":{"description":"Individual in direct contact with Veteran.","type":"string","nullable":true,"minLength":1,"maxLength":100,"pattern":"^([-a-zA-Z0-9/']+( ?))*$","example":"Jane Doe"},"pointOfContactNumber":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"telephone":{"description":"Ten digit primary phone of point of contact.","type":"string","pattern":"^\\d{10}?$","example":"5555555","nullable":true},"internationalTelephone":{"description":"International phone of point of contact.","type":"string","example":"+44 20 1234 5678","maxLength":1000,"nullable":true}}}}},"toxicExposure":{"type":"object","nullable":true,"properties":{"gulfWarHazardService":{"type":"object","nullable":true,"description":"Toxic exposure related to the Gulf war.","properties":{"servedInGulfWarHazardLocations":{"type":"string","description":"Set to true if the Veteran served in any of the following Gulf War hazard locations: Iraq; Kuwait; Saudi Arabia; the neutral zone between Iraq and Saudi Arabia; Bahrain; Qatar; the United Arab Emirates; Oman; Yemen; Lebanon; Somalia; Afghanistan; Israel; Egypt; Turkey; Syria; Jordan; Djibouti; Uzbekistan; the Gulf of Aden; the Gulf of Oman; the Persian Gulf; the Arabian Sea; and the Red Sea.","example":"YES","enum":["NO","YES"],"nullable":true},"serviceDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for serving in Gulf War hazard location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for serving in Gulf War hazard location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}},"herbicideHazardService":{"description":"Toxic exposure related to herbicide (Agent Orange) hazards.","type":"object","nullable":true,"properties":{"servedInHerbicideHazardLocations":{"type":"string","description":"Set to true if the Veteran served in any of the following herbicide/Agent Orange locations: Republic of Vietnam to include the 12 nautical mile territorial waters; Thailand at any United States or Royal Thai base; Laos; Cambodia at Mimot or Krek; Kampong Cham Province; Guam or American Samoa; or in the territorial waters thereof; Johnston Atoll or a ship that called at Johnston Atoll; Korean demilitarized zone; aboard (to include repeated operations and maintenance with) a C-123 aircraft known to have been used to spray an herbicide agent (during service in the Air Force and Air Force Reserves).","example":"YES","enum":["NO","YES"],"nullable":true},"otherLocationsServed":{"type":"string","nullable":true,"pattern":"^$|([a-zA-Z0-9\"\\/&\\(\\)\\-'.,#\\[\\] ]([a-zA-Z0-9(\\)\\-'.,#\\[\\] ])?)+$","maxLength":5000,"description":"Other location(s) where Veteran served."},"serviceDates":{"description":"Date range for exposure in herbicide hazard location.","type":"object","nullable":true,"properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for serving in herbicide location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for serving in herbicide location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}},"additionalHazardExposures":{"type":"object","nullable":true,"description":"Additional hazardous exposures.","properties":{"additionalExposures":{"description":"Additional exposure incidents.","type":"array","nullable":true,"uniqueItems":true,"items":{"type":"string","additionalProperties":false,"enum":["ASBESTOS","MUSTARD_GAS","RADIATION","SHIPBOARD_HAZARD_AND_DEFENSE","MILITARY_OCCUPATIONAL_SPECIALTY_RELATED_TOXIN","CONTAMINATED_WATER_AT_CAMP_LEJEUNE","OTHER"]}},"specifyOtherExposures":{"type":"string","nullable":true,"pattern":"^$|([a-zA-Z0-9\"\\/&\\(\\)\\-'.,#\\[\\] ]([a-zA-Z0-9(\\)\\-'.,#\\[\\] ])?)+$","maxLength":5000,"description":"Exposure to asbestos."},"exposureDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}},"multipleExposures":{"type":"array","nullable":true,"minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"hazardExposedTo":{"type":"string","nullable":true,"pattern":"^([-a-zA-Z0-9'.,&# ])+$","maxLength":1000,"description":"Hazard the Veteran was exposed to."},"exposureLocation":{"type":"string","nullable":true,"pattern":"^$|([a-zA-Z0-9\"\\/&\\(\\)\\-'.,#\\[\\] ]([a-zA-Z0-9(\\)\\-'.,#\\[\\] ])?)+$","maxLength":1000,"description":"Location where the exposure happened."},"exposureDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}}}}},"disabilities":{"description":"Any current disabilities or symptoms the Veteran is claiming are related to their military service and/or are service-connected.","type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["disabilityActionType","name"],"properties":{"name":{"description":"Name of the disability. The /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible disability names.\nWhen disabilityActionType is NEW or INCREASE, name must match pattern:\n^[a-zA-Z0-9'\\\",.#&;:%<>/()\\[\\]\\\\ -]+$","type":"string","example":"PTSD (post traumatic stress disorder)","maxLength":255},"exposureOrEventOrInjury":{"type":"string","description":"What caused the disability?","nullable":true,"maxLength":1000,"examples":["Agent Orange","radiation","burn pits"]},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury. If the disabilityActionType is 'NEW', the serviceRelevance is required.","type":"string","nullable":true,"maxLength":1000,"example":"Heavy equipment operator in service."},"approximateDate":{"description":"Approximate date disability began. Date must be in the past. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(?:[0-9]{4}(?:-(?!00)(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","example":"2018-03-02 or 2018-03 or 2018","nullable":true},"disabilityActionType":{"description":"Action type requested for the disability. If 'INCREASE' or 'NONE', then 'ratedDisabilityId' and 'diagnosticCode' should be included. 'NONE' should be used when including a secondary disability.","type":"string","enum":["NONE","NEW","INCREASE"],"example":"NEW"},"classificationCode":{"type":"string","description":"Classification code for the associated body system. Must match an active code returned by the /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","example":"249470","nullable":true},"ratedDisabilityId":{"description":"When submitting a contention with action type 'INCREASE', the previously rated disability id may be included.","type":"string","example":"1100583","nullable":true},"diagnosticCode":{"description":"If the disabilityActionType is 'NONE' or 'INCREASE', the diagnosticCode should correspond to an existing rated disability.","type":"integer","example":9999,"nullable":true},"isRelatedToToxicExposure":{"type":"boolean","description":"Is the disability related to toxic exposures? If true, related 'toxicExposure' must be included.","example":true,"default":false,"nullable":true},"specialIssues":{"type":"array","nullable":true,"uniqueItems":true,"items":{"maxItems":2,"additionalProperties":false,"type":"string","enum":["POW","EMP"]}},"secondaryDisabilities":{"description":"If secondaryDisability is included, the following attributes are required: 'secondaryDisability.name', 'secondaryDisability.disabilityActionType' and 'secondaryDisability.serviceRelevance'","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the disability. The /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible disability names.","type":"string","pattern":"^[a-zA-Z0-9'\",.#&;:%<>/()\\[\\]\\\\ -]+$","example":"PTSD (post traumatic stress disorder)","maxLength":255},"exposureOrEventOrInjury":{"type":"string","description":"What caused the disability?","nullable":true,"maxLength":1000,"examples":["Agent Orange","radiation","burn pits"]},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","nullable":true,"maxLength":1000,"example":"Heavy equipment operator in service."},"disabilityActionType":{"description":"The status of the secondary disability.","type":"string","example":"SECONDARY","enum":["SECONDARY"]},"approximateDate":{"description":"Approximate date disability began. Date must be in the past. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(?:[0-9]{4}(?:-(?!00)(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","example":"2018-03-02 or 2018-03 or 2018","nullable":true},"classificationCode":{"type":"string","description":"Classification code for the associated body system. Must match an active code returned by the /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","example":"249470","nullable":true}}}}}}},"treatments":{"description":"Identifies the Service Treatment information of the Veteran. The combination of treatedDisabilityName, center name, center city, and center state must be less than 10,000 characters to successfully generate a PDF.","type":"array","nullable":true,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"beginDate":{"description":"Begin date for treatment.","type":"string","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018","nullable":true},"treatedDisabilityNames":{"description":"Name(s) of disabilities treated in this time frame.","type":"array","nullable":true,"maxItems":150,"items":{"type":"string","additionalProperties":false,"example":["PTSD (post traumatic stress disorder)","Trauma"]}},"center":{"description":"VA Medical Center(s) and Department of Defense Military Treatment Facilities where the Veteran received treatment after discharge for any claimed disabilities.","type":"object","nullable":true,"additionalProperties":false,"properties":{"name":{"description":"Name of facility Veteran was treated in. The /treatment-centers endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible treatment center names.","type":"string","nullable":true,"pattern":"([a-zA-Z0-9\"/&()\\'-'.,# ]([a-zA-Z0-9()\\'-'.,# ])?)+$","example":"Private Facility 2","minLength":1,"maxLength":100},"city":{"description":"City of treatment facility.","type":"string","pattern":"([a-zA-Z0-9\\-'.# ]([a-zA-Z0-9\\-'.# ])?)+$","example":"Portland","nullable":true,"minLength":0,"maxLength":30},"state":{"description":"State of treatment facility.","type":"string","pattern":"^$|^[a-z,A-Z]{2}$","example":"OR","nullable":true}}}}}},"serviceInformation":{"type":"object","additionalProperties":false,"required":["servicePeriods"],"properties":{"alternateNames":{"description":"List any other names under which the Veteran served, if applicable.","type":"array","nullable":true,"maxItems":100,"items":{"type":"string","additionalProperties":false,"examples":["jane","janey lee","jane lee MacDonald"]}},"servicePeriods":{"description":"Identifies the Service dates and Branch the Veteran served in.","type":"array","minItems":1,"items":{"type":"object","required":["serviceBranch","serviceComponent","activeDutyBeginDate","activeDutyEndDate"],"properties":{"serviceBranch":{"description":"Branch of service during period. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","maxLength":1000,"example":"Air Force"},"serviceComponent":{"type":"string","description":"","enum":["Active","Reserves","National Guard"]},"activeDutyBeginDate":{"description":"Date started active duty. This date must be in the past.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"},"activeDutyEndDate":{"description":"Date Completed Active Duty. Cannot be more than 180 days in the future, unless past service is also included.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"},"separationLocationCode":{"description":"Location code for the facility the Veteran plans to separate from. Code must match the values returned by the /intake-sites endpoint on the [Benefits reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","nullable":true,"example":"98283"}}}},"servedInActiveCombatSince911":{"type":"string","enum":["YES","NO"],"description":"Did Veteran serve in a combat zone since 9-11-2001?","example":"YES","nullable":true},"reservesNationalGuardService":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"component":{"type":"string","nullable":true,"description":"","enum":["Reserves","National Guard"]},"obligationTermsOfService":{"type":"object","nullable":true,"description":"If 'obligationTermsOfService' is included, the following attributes are required: 'beginDate ' and 'endDate'.","additionalProperties":false,"properties":{"beginDate":{"type":"string","nullable":true,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"},"endDate":{"type":"string","nullable":true,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"}}},"unitName":{"type":"string","nullable":true,"maxLength":1000,"pattern":"^$|([a-zA-Z0-9\\-'.,# ][a-zA-Z0-9\\-'.,# ]?)*$"},"unitAddress":{"type":"string","maxLength":1000,"pattern":"^$|^([-a-zA-Z0-9'.,&# ])+$","nullable":true},"unitPhone":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"areaCode":{"type":"string","nullable":true,"maxLength":3,"pattern":"^$|^\\d{3}$","example":"555"},"phoneNumber":{"type":"string","nullable":true,"maxLength":20,"example":"5555555"}}},"receivingInactiveDutyTrainingPay":{"type":"string","enum":["YES","NO"],"nullable":true,"example":"YES"}}},"federalActivation":{"description":"If federalActivation is present then reservesNationalGuardService.obligationTermsOfService.beginDate, reservesNationalGuardService.obligationTermsOfService.endDate and reservesNationalGuardService.unitName are required","type":"object","nullable":true,"additionalProperties":false,"properties":{"activationDate":{"description":"Date cannot be in the future and must be after the earliest servicePeriod.activeDutyBeginDate.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06","nullable":true},"anticipatedSeparationDate":{"description":"Anticipated date of separation. Date must be in the future.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06","nullable":true}}},"confinements":{"type":"array","nullable":true,"uniqueItems":true,"items":{"additionalProperties":false,"type":"object","properties":{"approximateBeginDate":{"description":"The approximateBeginDate must be after the earliest servicePeriod activeDutyBeginDate.","type":"string","nullable":false,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$|(?:[0-9]{4})-(?:0[1-9]|1[0-2])$","example":"2018-06-06 or 2018-06"},"approximateEndDate":{"type":"string","nullable":false,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$|(?:[0-9]{4})-(?:0[1-9]|1[0-2])$","example":"2018-06-06 or 2018-06"}}}}},"if":{"required":["federalActivation"]},"then":{"required":["reservesNationalGuardService"],"properties":{"reservesNationalGuardService":{"required":["obligationTermsOfService"],"properties":{"obligationTermsOfService":{"required":["beginDate","endDate"]}}}}}},"servicePay":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"receivingMilitaryRetiredPay":{"description":"Is the Veteran receiving military retired pay?","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"futureMilitaryRetiredPay":{"description":"Will the Veteran receive military retired pay pay in future? \n If true, then 'futurePayExplanation' is required.","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"futureMilitaryRetiredPayExplanation":{"description":"Explains why future pay will be received.","type":"string","maxLength":1000,"example":"Will be retiring soon.","nullable":true},"militaryRetiredPay":{"type":"object","nullable":true,"description":"","properties":{"branchOfService":{"description":"Branch of service. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","maxLength":1000,"nullable":true,"example":"Air Force"},"monthlyAmount":{"description":"Amount being received.","type":"integer","nullable":true,"example":100}}},"retiredStatus":{"type":"string","nullable":true,"description":"","enum":["RETIRED","TEMPORARY_DISABILITY_RETIRED_LIST","PERMANENT_DISABILITY_RETIRED_LIST"]},"favorMilitaryRetiredPay":{"description":"Is the Veteran waiving VA benefits to retain military retired pay? See item 26 on form 21-526EZ for more details.","type":"boolean","nullable":true,"example":true,"default":false},"receivedSeparationOrSeverancePay":{"description":"Has the Veteran ever received separation pay, disability severance pay, or any other lump sum payment from their branch of service?","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"separationSeverancePay":{"type":"object","nullable":true,"description":"","properties":{"datePaymentReceived":{"description":"Approximate date separation pay was received. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02 or 2018-03 or 2018"},"branchOfService":{"description":"Branch of service. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","nullable":true,"maxLength":1000,"example":"Air Force"},"preTaxAmountReceived":{"description":"Amount being received.","type":"integer","nullable":true,"example":100}}},"favorTrainingPay":{"description":"Is the Veteran waiving VA benefits to retain training pay? See item 28 on form 21-526EZ for more details. ","type":"boolean","nullable":true,"example":true,"default":false}}},"directDeposit":{"type":"object","nullable":true,"additionalProperties":false,"description":"Direct deposit information.","properties":{"noAccount":{"type":"boolean","nullable":true,"description":"Claimant certifies that they do not have an account with a financial institution or certified payment agent.","default":false},"accountNumber":{"description":"Account number for the direct deposit.","pattern":"^(?:[a-zA-Z0-9-]{4,1000})?$","type":"string","maxLength":1000,"nullable":true,"example":"123123123123"},"accountType":{"description":"Account type for the direct deposit.","type":"string","nullable":true,"example":"CHECKING","enum":["CHECKING","SAVINGS"]},"financialInstitutionName":{"description":"Provide the name of the financial institution where the Veteran wants the direct deposit.","maxLength":1000,"type":"string","nullable":true,"example":"Some Bank"},"routingNumber":{"description":"Routing number for the direct deposit.","type":"string","maxLength":1000,"nullable":true,"pattern":"^$|^\\d{0,1000}$","example":"123123123"}}},"claimantCertification":{"type":"boolean","description":"Claimant certifies and authorizes release of information.","default":false},"claimNotes":{"type":"string","description":"An optional notes section.","maxLength":4000},"claimDate":{"description":"Date when claim is being submitted to the VA. Date cannot be in the future.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-04"}}}}}},"example":{"data":{"type":"form/526","attributes":{"claimProcessType":"STANDARD_CLAIM_PROCESS","claimNotes":"Some things that are important to know, and are not included in any other place.","veteranIdentification":{"serviceNumber":"123456789","veteranNumber":{"telephone":"5555555555"},"mailingAddress":{"addressLine1":"123 Main Street","addressLine2":"Unit 1","addressLine3":"Room 2","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"1234"},"emailAddress":{"email":"valid@somedomain.com","agreeToEmailRelatedToClaim":true},"currentVaEmployee":false},"changeOfAddress":{"typeOfAddressChange":"TEMPORARY","addressLine1":"456 Main Street","addressLine2":"Unit 3","addressLine3":"Room 4","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"9897","dates":{"beginDate":"2025-06-04","endDate":"2025-12-31"}},"homeless":{"currentlyHomeless":{"homelessSituationOptions":"OTHER","otherDescription":"Other living situation"},"pointOfContact":"John Doe","pointOfContactNumber":{"telephone":"5555555555"}},"toxicExposure":{"gulfWarHazardService":{"servedInGulfWarHazardLocations":"NO"},"herbicideHazardService":{"servedInHerbicideHazardLocations":"YES","otherLocationsServed":"Other locations served","serviceDates":{"beginDate":"1972-05","endDate":"1980-10"}},"additionalHazardExposures":{"additionalExposures":["OTHER"],"specifyOtherExposures":"Agent Orange","exposureDates":{"beginDate":"1972-05","endDate":"1980-10"}},"multipleExposures":[{"hazardExposedTo":"Agent Orange","exposureLocation":"Vietnam","exposureDates":{"beginDate":"1972-05","endDate":"1973-01"}},{"hazardExposedTo":"Agent Orange","exposureLocation":"Vietnam","exposureDates":{"beginDate":"1979-04","endDate":"1980-10"}}]},"disabilities":[{"name":"Diabetes","exposureOrEventOrInjury":"Agent Orange","serviceRelevance":"Service in Vietnam War","approximateDate":"1975-05","disabilityActionType":"NEW","isRelatedToToxicExposure":true},{"name":"Hearing Loss","exposureOrEventOrInjury":"Noise","serviceRelevance":"Heavy equipment operator in service","approximateDate":"1968-07","disabilityActionType":"INCREASE","classificationCode":"8987","ratedDisabilityId":"1234567","diagnosticCode":5678,"isRelatedToToxicExposure":false}],"treatments":[{"beginDate":"2021-04","treatedDisabilityNames":["Diabetes"],"center":{"name":"ATLANTA VA MEDICAL CENTER","state":"GA","city":"ATLANTA"}},{"beginDate":"1996-03","treatedDisabilityNames":["Hearing Loss"],"center":{"name":"ATLANTA VA MEDICAL CENTER","state":"GA","city":"ATLANTA"}}],"serviceInformation":{"alternateNames":["Jon Doe","Jane Doe"],"servicePeriods":[{"serviceBranch":"Air Force","serviceComponent":"Active","activeDutyBeginDate":"1964-11-14","activeDutyEndDate":"1980-10-30","separationLocationCode":"98289"}],"servedInActiveCombatSince911":"NO","reservesNationalGuardService":{"component":"National Guard","obligationTermsOfService":{"beginDate":"1990-11-24","endDate":"1995-11-17"},"unitName":"National Guard Unit Name","unitAddress":"1243 Main Street","unitPhone":{"areaCode":"555","phoneNumber":"5555555"},"receivingInactiveDutyTrainingPay":"YES"},"confinements":[{"approximateBeginDate":"1970-06-11","approximateEndDate":"1970-09-11"}]},"servicePay":{"receivingMilitaryRetiredPay":"NO","futureMilitaryRetiredPay":"YES","futureMilitaryRetiredPayExplanation":"Explanation of future military retired pay","militaryRetiredPay":{"branchOfService":"Air Force","monthlyAmount":240},"retiredStatus":"PERMANENT_DISABILITY_RETIRED_LIST","favorMilitaryRetiredPay":false,"receivedSeparationOrSeverancePay":"YES","separationSeverancePay":{"datePaymentReceived":"2018-07-31","branchOfService":"Air Force","preTaxAmountReceived":179},"favorTrainingPay":false},"directDeposit":{"accountNumber":"123123123123","accountType":"CHECKING","financialInstitutionName":"Chase","routingNumber":"123456789"},"claimantCertification":true}}}},"examples":{"Minimum Required Attributes":{"value":{"data":{"type":"form/526","attributes":{"claimProcessType":"STANDARD_CLAIM_PROCESS","veteranIdentification":{"mailingAddress":{"addressLine1":"1234 Couch Street","city":"Portland","state":"OR","country":"USA","zipFirstFive":"12345"},"currentVaEmployee":false},"disabilities":[{"name":"hearing loss","serviceRelevance":"Heavy equipment operator in service","approximateDate":"2017-07","disabilityActionType":"NEW"}],"serviceInformation":{"servicePeriods":[{"serviceBranch":"Air Force","serviceComponent":"Active","activeDutyBeginDate":"2015-11-14","activeDutyEndDate":"2018-11-30"}]},"claimantCertification":true}}}},"Maximum Attributes":{"value":{"data":{"type":"form/526","attributes":{"claimProcessType":"STANDARD_CLAIM_PROCESS","claimNotes":"Some things that are important to know, and are not included in any other place.","veteranIdentification":{"serviceNumber":"123456789","veteranNumber":{"telephone":"5555555555","internationalTelephone":"+44 20 1234 5678"},"mailingAddress":{"addressLine1":"1234 Couch Street","addressLine2":"Unit 4","addressLine3":"Room 1","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"1234"},"emailAddress":{"email":"valid@somedomain.com","agreeToEmailRelatedToClaim":true},"currentVaEmployee":false},"changeOfAddress":{"typeOfAddressChange":"TEMPORARY","addressLine1":"10 Peach St","addressLine2":"Unit 4","addressLine3":"Room 1","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"9897","dates":{"beginDate":"2025-12-31","endDate":"2025-12-31"}},"homeless":{"isCurrentlyHomeless":true,"currentlyHomeless":{"homelessSituationOptions":"FLEEING_CURRENT_RESIDENCE","otherDescription":"ABCDEFGHIJKLM"},"isAtRiskOfBecomingHomeless":false,"pointOfContact":"john stewart","pointOfContactNumber":{"telephone":"5555555555","internationalTelephone":"+44 20 1234 5678"}},"toxicExposure":{"gulfWarHazardService":{"servedInGulfWarHazardLocations":"YES","serviceDates":{"beginDate":"2018-07","endDate":"2018-08"}},"herbicideHazardService":{"servedInHerbicideHazardLocations":"YES","otherLocationsServed":"ABCDEFGHIJKLM","serviceDates":{"beginDate":"2018-07","endDate":"2018-08"}},"additionalHazardExposures":{"additionalExposures":["ASBESTOS","SHIPBOARD_HAZARD_AND_DEFENSE"],"specifyOtherExposures":"Other exposure details","exposureDates":{"beginDate":"2018-07","endDate":"2018-08"}},"multipleExposures":[{"hazardExposedTo":"RADIATION","exposureLocation":"Guam","exposureDates":{"beginDate":"2012-12","endDate":"2013-07"}}]},"disabilities":[{"name":"Traumatic Brain Injury","exposureOrEventOrInjury":"EXPOSURE","serviceRelevance":"ABCDEFG","approximateDate":"2018-03-11","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":9020,"isRelatedToToxicExposure":true,"secondaryDisabilities":[{"name":"Post Traumatic Stress Disorder (PTSD) Combat - Mental Disorders","exposureOrEventOrInjury":"EXPOSURE","serviceRelevance":"ABCDEFGHIJKLMNOPQ","disabilityActionType":"SECONDARY","approximateDate":"2018-03-12","classificationCode":"9014"}]},{"name":"Cancer - Musculoskeletal - Elbow","exposureOrEventOrInjury":"EXPOSURE","approximateDate":"2018-03-02","serviceRelevance":"ABCDEFG","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":249470,"isRelatedToToxicExposure":true},{"name":"Cancer - Musculoskeletal - Knee","exposureOrEventOrInjury":"EXPOSURE","approximateDate":"2015","serviceRelevance":"ABCDEFG","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":249470,"isRelatedToToxicExposure":true}],"treatments":[{"beginDate":"2009-03","treatedDisabilityNames":["Traumatic Brain Injury","Post Traumatic Stress Disorder (PTSD) Combat - Mental Disorders","Cancer - Musculoskeletal - Elbow"],"center":{"name":"Center One","city":"Decatur","state":"GA"}}],"serviceInformation":{"alternateNames":["john jacob","johnny smith"],"servicePeriods":[{"serviceBranch":"Public Health Service","serviceComponent":"Active","activeDutyBeginDate":"2008-11-14","activeDutyEndDate":"2023-10-30"}],"servedInActiveCombatSince911":"NO","reservesNationalGuardService":{"component":"National Guard","obligationTermsOfService":{"beginDate":"2019-06-04","endDate":"2020-06-04"},"unitName":"National Guard Unit Name","unitAddress":"1243 pine court","unitPhone":{"areaCode":"555","phoneNumber":"5555555"},"receivingInactiveDutyTrainingPay":"YES"},"confinements":[{"approximateBeginDate":"2018-06-04","approximateEndDate":"2018-07-04"},{"approximateBeginDate":"2020-06","approximateEndDate":"2020-07"}]},"servicePay":{"receivingMilitaryRetiredPay":"NO","futureMilitaryRetiredPay":"YES","futureMilitaryRetiredPayExplanation":"ABCDEFGHIJKLMNOPQRSTUVW","militaryRetiredPay":{"branchOfService":"Army","monthlyAmount":840},"retiredStatus":"PERMANENT_DISABILITY_RETIRED_LIST","favorMilitaryRetiredPay":false,"receivedSeparationOrSeverancePay":"NO","separationSeverancePay":{"datePaymentReceived":"2022-03-12","branchOfService":"Naval Academy","preTaxAmountReceived":379},"favorTrainingPay":true},"directDeposit":{"noAccount":false,"accountNumber":"ABCDEF","accountType":"CHECKING","financialInstitutionName":"Chase","routingNumber":"123123123"},"claimantCertification":true}}}},"Transaction ID":{"value":{"meta":{"transactionId":"00000000-0000-0000-0000-000000000005"},"data":{"type":"form/526","attributes":{"claimProcessType":"STANDARD_CLAIM_PROCESS","claimNotes":"Some things that are important to know, and are not included in any other place.","veteranIdentification":{"serviceNumber":"123456789","veteranNumber":{"telephone":"5555555555","internationalTelephone":"+44 20 1234 5678"},"mailingAddress":{"addressLine1":"1234 Couch Street","addressLine2":"Unit 4","addressLine3":"Room 1","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"1234"},"emailAddress":{"email":"valid@somedomain.com","agreeToEmailRelatedToClaim":true},"currentVaEmployee":false},"changeOfAddress":{"typeOfAddressChange":"TEMPORARY","addressLine1":"10 Peach St","addressLine2":"Unit 4","addressLine3":"Room 1","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"9897","dates":{"beginDate":"2025-12-31","endDate":"2025-12-31"}},"homeless":{"isCurrentlyHomeless":true,"currentlyHomeless":{"homelessSituationOptions":"FLEEING_CURRENT_RESIDENCE","otherDescription":"ABCDEFGHIJKLM"},"isAtRiskOfBecomingHomeless":false,"pointOfContact":"john stewart","pointOfContactNumber":{"telephone":"5555555555","internationalTelephone":"+44 20 1234 5678"}},"toxicExposure":{"gulfWarHazardService":{"servedInGulfWarHazardLocations":"YES","serviceDates":{"beginDate":"2018-07","endDate":"2018-08"}},"herbicideHazardService":{"servedInHerbicideHazardLocations":"YES","otherLocationsServed":"ABCDEFGHIJKLM","serviceDates":{"beginDate":"2018-07","endDate":"2018-08"}},"additionalHazardExposures":{"additionalExposures":["ASBESTOS","SHIPBOARD_HAZARD_AND_DEFENSE"],"specifyOtherExposures":"Other exposure details","exposureDates":{"beginDate":"2018-07","endDate":"2018-08"}},"multipleExposures":[{"hazardExposedTo":"RADIATION","exposureLocation":"Guam","exposureDates":{"beginDate":"2012-12","endDate":"2013-07"}}]},"disabilities":[{"name":"Traumatic Brain Injury","exposureOrEventOrInjury":"EXPOSURE","serviceRelevance":"ABCDEFG","approximateDate":"2018-03-11","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":9020,"isRelatedToToxicExposure":true,"secondaryDisabilities":[{"name":"Post Traumatic Stress Disorder (PTSD) Combat - Mental Disorders","exposureOrEventOrInjury":"EXPOSURE","serviceRelevance":"ABCDEFGHIJKLMNOPQ","disabilityActionType":"SECONDARY","approximateDate":"2018-03-12","classificationCode":"9014"}]},{"name":"Cancer - Musculoskeletal - Elbow","exposureOrEventOrInjury":"EXPOSURE","approximateDate":"2018-03-02","serviceRelevance":"ABCDEFG","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":249470,"isRelatedToToxicExposure":true},{"name":"Cancer - Musculoskeletal - Knee","exposureOrEventOrInjury":"EXPOSURE","approximateDate":"2015","serviceRelevance":"ABCDEFG","disabilityActionType":"NEW","classificationCode":"9014","ratedDisabilityId":"ABCDEFGHIJKLMNOPQRSTUVWX","diagnosticCode":249470,"isRelatedToToxicExposure":true}],"treatments":[{"beginDate":"2009-03","treatedDisabilityNames":["Traumatic Brain Injury","Post Traumatic Stress Disorder (PTSD) Combat - Mental Disorders","Cancer - Musculoskeletal - Elbow"],"center":{"name":"Center One","city":"Decatur","state":"GA"}}],"serviceInformation":{"alternateNames":["john jacob","johnny smith"],"servicePeriods":[{"serviceBranch":"Public Health Service","serviceComponent":"Active","activeDutyBeginDate":"2008-11-14","activeDutyEndDate":"2025-12-31","separationLocationCode":"98282"}],"servedInActiveCombatSince911":"NO","reservesNationalGuardService":{"component":"National Guard","obligationTermsOfService":{"beginDate":"2019-06-04","endDate":"2020-06-04"},"unitName":"National Guard Unit Name","unitAddress":"1243 pine court","unitPhone":{"areaCode":"555","phoneNumber":"5555555"},"receivingInactiveDutyTrainingPay":"YES"},"federalActivation":{"activationDate":"2023-10-01","anticipatedSeparationDate":"2025-12-31"},"confinements":[{"approximateBeginDate":"2018-06-04","approximateEndDate":"2018-07-04"},{"approximateBeginDate":"2020-06","approximateEndDate":"2020-07"}]},"servicePay":{"receivingMilitaryRetiredPay":"NO","futureMilitaryRetiredPay":"YES","futureMilitaryRetiredPayExplanation":"ABCDEFGHIJKLMNOPQRSTUVW","militaryRetiredPay":{"branchOfService":"Army","monthlyAmount":840},"retiredStatus":"PERMANENT_DISABILITY_RETIRED_LIST","favorMilitaryRetiredPay":false,"receivedSeparationOrSeverancePay":"NO","separationSeverancePay":{"datePaymentReceived":"2022-03-12","branchOfService":"Naval Academy","preTaxAmountReceived":379},"favorTrainingPay":true},"directDeposit":{"noAccount":false,"accountNumber":"ABCDEF","accountType":"CHECKING","financialInstitutionName":"Chase","routingNumber":"123123123"},"claimantCertification":true}}}}}}}}}},"/veterans/{veteranId}/526/validate":{"post":{"summary":"Validates a 526 claim form submission.","tags":["Disability Compensation Claims"],"operationId":"POST:/veterans/{veteranId}/526/validate","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"description":"Validates a request for a disability compensation claim submission (21-526EZ).\nThis endpoint can be used to test the request parameters for your /526 submission.\n","parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response with disability","content":{"application/json":{"example":{"data":{"type":"claims_api_auto_established_claim_validation","attributes":{"status":"valid"}}},"schema":{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["valid"],"description":"Return whether or not whether or not the payload is valid"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Unable to locate Veteran's ID/ICN in Master Person Index (MPI). Please submit an issue at ask.va.gov or call 1-800-MyVA411 (800-698-2411) for assistance."}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"errors":[{"title":"Unprocessable entity","detail":"The property / did not contain the required key claimProcessType","status":"422","source":{"pointer":"data/attributes/"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key disabilities","status":"422","source":{"pointer":"data/attributes/"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key serviceInformation","status":"422","source":{"pointer":"data/attributes/"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key veteranIdentification","status":"422","source":{"pointer":"data/attributes/"}}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","status","detail"],"properties":{"status":{"type":"string","description":"HTTP error code"},"detail":{"type":"string","description":"HTTP error detail"},"source":{"type":"object","pointer":{"type":"string"}},"title":{"type":"string"}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes",null],"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Claims API 526 Schema","type":"object","additionalProperties":false,"required":["claimProcessType","disabilities","serviceInformation","veteranIdentification"],"properties":{"claimProcessType":{"type":"string","description":"Select type of claim program/process that applies to the Veteran.","enum":["STANDARD_CLAIM_PROCESS","FDC_PROGRAM","BDD_PROGRAM"]},"veteranIdentification":{"type":"object","additionalProperties":false,"required":["mailingAddress","currentVaEmployee"],"properties":{"serviceNumber":{"type":"string","description":"Service identification number","maxLength":1000,"nullable":true},"veteranNumber":{"description":"If there isn't a ten digit phone number in VBMS for the Veteran, the exams will not be ordered. Including the phone number is recommended to avoid claim processing delays.","type":"object","nullable":true,"properties":{"telephone":{"description":"Veteran's phone number.","type":"string","pattern":"^\\d{10}?$","example":"5555555555","nullable":true},"internationalTelephone":{"type":"string","description":"Veteran's international phone number.","example":"+44 20 1234 5678","maxLength":1000,"nullable":true}}},"mailingAddress":{"type":"object","additionalProperties":false,"required":["addressLine1","city","country"],"properties":{"addressLine1":{"description":"Address line 1 for the Veteran's current mailing address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"1234 Couch Street"},"addressLine2":{"description":"Address line 2 for the Veteran's current mailing address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Unit 4","nullable":true},"addressLine3":{"description":"Address line 3 for the Veteran's current mailing address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Room 1","nullable":true},"city":{"description":"City for the Veteran's current mailing address.","type":"string","pattern":"^$|([a-zA-Z0-9\\'-'.# ]([a-zA-Z0-9\\'-'.# ])?)+$","minLength":1,"maxLength":20,"example":"Schenectady"},"state":{"description":"State for the Veteran's current mailing address. Required if 'country' is 'USA'.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"NY","nullable":true},"country":{"description":"Country for the Veteran's current mailing address.  Must match the values returned by the /countries endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","maxLength":1000,"example":"USA"},"zipFirstFive":{"description":"Zip code (First 5 digits) for the Veteran's current mailing address. Required if 'country' is 'USA'.","type":"string","pattern":"^\\d{5}?$","example":"12345","nullable":true},"zipLastFour":{"description":"Zip code (Last 4 digits) for the Veteran's current mailing address.","type":"string","pattern":"^\\d{4}?$","example":"6789","nullable":true},"internationalPostalCode":{"description":"International postal code for the Veteran's current mailing address. Do not include if 'country' is 'USA'.","type":"string","maxLength":16,"nullable":true,"pattern":"^[a-zA-Z0-9]*$"}}},"emailAddress":{"description":"Information associated with the Veteran's email address.","type":"object","nullable":true,"properties":{"email":{"type":"string","pattern":"^[^\\s@]+@([^\\s@.,]+\\.)+[^\\s@.,]{2,}$","description":"The most current email address of the Veteran.","maxLength":80,"nullable":true},"agreeToEmailRelatedToClaim":{"type":"boolean","description":"Agreement to email information relating to this claim.","example":true,"default":false,"nullable":true}}},"currentVaEmployee":{"type":"boolean","description":"Set to true if Veteran is a VA employee.","nullable":false}}},"changeOfAddress":{"description":"If 'changeOfAddress' is included, the following attributes are required: 'typeOfAddressChange', 'addressLine1', 'city', 'country'.","type":"object","nullable":true,"additionalProperties":false,"properties":{"typeOfAddressChange":{"description":"Temporary or Permanent change of address. If 'TEMPORARY', 'beginDate' and 'endDate' are required.","type":"string","enum":["TEMPORARY","PERMANENT"],"example":"PERMANENT"},"addressLine1":{"description":"Address line 1 for the Veteran's new address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"1234 Couch Street"},"addressLine2":{"description":"Address line 2 for the Veteran's new address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Unit 4","nullable":true},"addressLine3":{"description":"Address line 3 for the Veteran's new address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":20,"example":"Room 1","nullable":true},"city":{"description":"City for the Veteran's new address.","type":"string","pattern":"^$|([a-zA-Z0-9\\'-'.# ]([a-zA-Z0-9\\'-'.# ])?)+$","minLength":0,"maxLength":20,"example":"Schenectady"},"state":{"description":"State for the Veteran's new address. Required if 'country' is 'USA'.","type":"string","pattern":"^$|^[a-z,A-Z]{2}$","example":"NY","nullable":true},"country":{"description":"Country for the Veteran's new address. Value must match the values returned by the /countries endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","maxLength":1000,"example":"USA"},"zipFirstFive":{"description":"Zip code (First 5 digits) for the Veteran's new address. Required if 'country' is 'USA'.","type":"string","pattern":"^$|^\\d{5}?$","example":"12345","nullable":true},"zipLastFour":{"description":"Zip code (Last 4 digits) for the Veteran's new address.","type":"string","nullable":true,"pattern":"^$|^\\d{4}?$","example":"6789"},"internationalPostalCode":{"description":"International postal code for the Veteran's new address. Do not include if 'country' is 'USA'.","type":"string","maxLength":16,"nullable":true,"pattern":"^[a-zA-Z0-9]*$"},"dates":{"type":"object","properties":{"beginDate":{"description":"Begin date for the Veteran's new address.","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","type":"string","nullable":true,"example":"2018-06-04"},"endDate":{"description":"Date in YYYY-MM-DD the changed address expires, if change is temporary.","type":"string","nullable":true,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-04"}}}}},"homeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"isCurrentlyHomeless":{"type":"boolean","nullable":true,"description":"Is the Veteran currently homeless?"},"currentlyHomeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"homelessSituationOptions":{"description":"Veteran's living situation.","type":"string","nullable":true,"default":"other","enum":["LIVING_IN_A_HOMELESS_SHELTER","NOT_CURRENTLY_IN_A_SHELTERED_ENVIRONMENT","STAYING_WITH_ANOTHER_PERSON","FLEEING_CURRENT_RESIDENCE","OTHER"],"example":"FLEEING_CURRENT_RESIDENCE"},"otherDescription":{"description":"Explanation of living situation. Required if 'homelessSituationOptions' is 'OTHER'.","type":"string","nullable":true,"maxLength":500,"example":"other living situation"}}},"isAtRiskOfBecomingHomeless":{"type":"boolean","nullable":true,"description":"Is the Veteran currently at risk of becoming homeless?"},"riskOfBecomingHomeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"livingSituationOptions":{"type":"string","nullable":true,"default":"HOUSING_WILL_BE_LOST_IN_30_DAYS","enum":["HOUSING_WILL_BE_LOST_IN_30_DAYS","LEAVING_PUBLICLY_FUNDED_SYSTEM_OF_CARE","OTHER"]},"otherDescription":{"description":"Explanation of living situation. Required if 'livingSituationOptions' is 'OTHER'.","type":"string","nullable":true,"maxLength":500,"example":"other living situation"}}},"pointOfContact":{"description":"Individual in direct contact with Veteran.","type":"string","nullable":true,"minLength":1,"maxLength":100,"pattern":"^([-a-zA-Z0-9/']+( ?))*$","example":"Jane Doe"},"pointOfContactNumber":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"telephone":{"description":"Ten digit primary phone of point of contact.","type":"string","pattern":"^\\d{10}?$","example":"5555555","nullable":true},"internationalTelephone":{"description":"International phone of point of contact.","type":"string","example":"+44 20 1234 5678","maxLength":1000,"nullable":true}}}}},"toxicExposure":{"type":"object","nullable":true,"properties":{"gulfWarHazardService":{"type":"object","nullable":true,"description":"Toxic exposure related to the Gulf war.","properties":{"servedInGulfWarHazardLocations":{"type":"string","description":"Set to true if the Veteran served in any of the following Gulf War hazard locations: Iraq; Kuwait; Saudi Arabia; the neutral zone between Iraq and Saudi Arabia; Bahrain; Qatar; the United Arab Emirates; Oman; Yemen; Lebanon; Somalia; Afghanistan; Israel; Egypt; Turkey; Syria; Jordan; Djibouti; Uzbekistan; the Gulf of Aden; the Gulf of Oman; the Persian Gulf; the Arabian Sea; and the Red Sea.","example":"YES","enum":["NO","YES"],"nullable":true},"serviceDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for serving in Gulf War hazard location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for serving in Gulf War hazard location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}},"herbicideHazardService":{"description":"Toxic exposure related to herbicide (Agent Orange) hazards.","type":"object","nullable":true,"properties":{"servedInHerbicideHazardLocations":{"type":"string","description":"Set to true if the Veteran served in any of the following herbicide/Agent Orange locations: Republic of Vietnam to include the 12 nautical mile territorial waters; Thailand at any United States or Royal Thai base; Laos; Cambodia at Mimot or Krek; Kampong Cham Province; Guam or American Samoa; or in the territorial waters thereof; Johnston Atoll or a ship that called at Johnston Atoll; Korean demilitarized zone; aboard (to include repeated operations and maintenance with) a C-123 aircraft known to have been used to spray an herbicide agent (during service in the Air Force and Air Force Reserves).","example":"YES","enum":["NO","YES"],"nullable":true},"otherLocationsServed":{"type":"string","nullable":true,"pattern":"^$|([a-zA-Z0-9\"\\/&\\(\\)\\-'.,#\\[\\] ]([a-zA-Z0-9(\\)\\-'.,#\\[\\] ])?)+$","maxLength":5000,"description":"Other location(s) where Veteran served."},"serviceDates":{"description":"Date range for exposure in herbicide hazard location.","type":"object","nullable":true,"properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for serving in herbicide location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for serving in herbicide location.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}},"additionalHazardExposures":{"type":"object","nullable":true,"description":"Additional hazardous exposures.","properties":{"additionalExposures":{"description":"Additional exposure incidents.","type":"array","nullable":true,"uniqueItems":true,"items":{"type":"string","additionalProperties":false,"enum":["ASBESTOS","MUSTARD_GAS","RADIATION","SHIPBOARD_HAZARD_AND_DEFENSE","MILITARY_OCCUPATIONAL_SPECIALTY_RELATED_TOXIN","CONTAMINATED_WATER_AT_CAMP_LEJEUNE","OTHER"]}},"specifyOtherExposures":{"type":"string","nullable":true,"pattern":"^$|([a-zA-Z0-9\"\\/&\\(\\)\\-'.,#\\[\\] ]([a-zA-Z0-9(\\)\\-'.,#\\[\\] ])?)+$","maxLength":5000,"description":"Exposure to asbestos."},"exposureDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}},"multipleExposures":{"type":"array","nullable":true,"minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"hazardExposedTo":{"type":"string","nullable":true,"pattern":"^([-a-zA-Z0-9'.,&# ])+$","maxLength":1000,"description":"Hazard the Veteran was exposed to."},"exposureLocation":{"type":"string","nullable":true,"pattern":"^$|([a-zA-Z0-9\"\\/&\\(\\)\\-'.,#\\[\\] ]([a-zA-Z0-9(\\)\\-'.,#\\[\\] ])?)+$","maxLength":1000,"description":"Location where the exposure happened."},"exposureDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for exposure.","pattern":"^(?:19|20)[0-9][0-9]$|^(?:19|20)[0-9][0-9]-(0[1-9]|1[0-2])$","example":"2018-06 or 2018"}}}}}}}},"disabilities":{"description":"Any current disabilities or symptoms the Veteran is claiming are related to their military service and/or are service-connected.","type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["disabilityActionType","name"],"properties":{"name":{"description":"Name of the disability. The /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible disability names.\nWhen disabilityActionType is NEW or INCREASE, name must match pattern:\n^[a-zA-Z0-9'\\\",.#&;:%<>/()\\[\\]\\\\ -]+$","type":"string","example":"PTSD (post traumatic stress disorder)","maxLength":255},"exposureOrEventOrInjury":{"type":"string","description":"What caused the disability?","nullable":true,"maxLength":1000,"examples":["Agent Orange","radiation","burn pits"]},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury. If the disabilityActionType is 'NEW', the serviceRelevance is required.","type":"string","nullable":true,"maxLength":1000,"example":"Heavy equipment operator in service."},"approximateDate":{"description":"Approximate date disability began. Date must be in the past. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(?:[0-9]{4}(?:-(?!00)(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","example":"2018-03-02 or 2018-03 or 2018","nullable":true},"disabilityActionType":{"description":"Action type requested for the disability. If 'INCREASE' or 'NONE', then 'ratedDisabilityId' and 'diagnosticCode' should be included. 'NONE' should be used when including a secondary disability.","type":"string","enum":["NONE","NEW","INCREASE"],"example":"NEW"},"classificationCode":{"type":"string","description":"Classification code for the associated body system. Must match an active code returned by the /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","example":"249470","nullable":true},"ratedDisabilityId":{"description":"When submitting a contention with action type 'INCREASE', the previously rated disability id may be included.","type":"string","example":"1100583","nullable":true},"diagnosticCode":{"description":"If the disabilityActionType is 'NONE' or 'INCREASE', the diagnosticCode should correspond to an existing rated disability.","type":"integer","example":9999,"nullable":true},"isRelatedToToxicExposure":{"type":"boolean","description":"Is the disability related to toxic exposures? If true, related 'toxicExposure' must be included.","example":true,"default":false,"nullable":true},"specialIssues":{"type":"array","nullable":true,"uniqueItems":true,"items":{"maxItems":2,"additionalProperties":false,"type":"string","enum":["POW","EMP"]}},"secondaryDisabilities":{"description":"If secondaryDisability is included, the following attributes are required: 'secondaryDisability.name', 'secondaryDisability.disabilityActionType' and 'secondaryDisability.serviceRelevance'","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the disability. The /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible disability names.","type":"string","pattern":"^[a-zA-Z0-9'\",.#&;:%<>/()\\[\\]\\\\ -]+$","example":"PTSD (post traumatic stress disorder)","maxLength":255},"exposureOrEventOrInjury":{"type":"string","description":"What caused the disability?","nullable":true,"maxLength":1000,"examples":["Agent Orange","radiation","burn pits"]},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","nullable":true,"maxLength":1000,"example":"Heavy equipment operator in service."},"disabilityActionType":{"description":"The status of the secondary disability.","type":"string","example":"SECONDARY","enum":["SECONDARY"]},"approximateDate":{"description":"Approximate date disability began. Date must be in the past. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(?:[0-9]{4}(?:-(?!00)(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[1-2][0-9]|3[0-1]))?)?)$","example":"2018-03-02 or 2018-03 or 2018","nullable":true},"classificationCode":{"type":"string","description":"Classification code for the associated body system. Must match an active code returned by the /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","example":"249470","nullable":true}}}}}}},"treatments":{"description":"Identifies the Service Treatment information of the Veteran. The combination of treatedDisabilityName, center name, center city, and center state must be less than 10,000 characters to successfully generate a PDF.","type":"array","nullable":true,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"beginDate":{"description":"Begin date for treatment.","type":"string","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018","nullable":true},"treatedDisabilityNames":{"description":"Name(s) of disabilities treated in this time frame.","type":"array","nullable":true,"maxItems":150,"items":{"type":"string","additionalProperties":false,"example":["PTSD (post traumatic stress disorder)","Trauma"]}},"center":{"description":"VA Medical Center(s) and Department of Defense Military Treatment Facilities where the Veteran received treatment after discharge for any claimed disabilities.","type":"object","nullable":true,"additionalProperties":false,"properties":{"name":{"description":"Name of facility Veteran was treated in. The /treatment-centers endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible treatment center names.","type":"string","nullable":true,"pattern":"([a-zA-Z0-9\"/&()\\'-'.,# ]([a-zA-Z0-9()\\'-'.,# ])?)+$","example":"Private Facility 2","minLength":1,"maxLength":100},"city":{"description":"City of treatment facility.","type":"string","pattern":"([a-zA-Z0-9\\-'.# ]([a-zA-Z0-9\\-'.# ])?)+$","example":"Portland","nullable":true,"minLength":0,"maxLength":30},"state":{"description":"State of treatment facility.","type":"string","pattern":"^$|^[a-z,A-Z]{2}$","example":"OR","nullable":true}}}}}},"serviceInformation":{"type":"object","additionalProperties":false,"required":["servicePeriods"],"properties":{"alternateNames":{"description":"List any other names under which the Veteran served, if applicable.","type":"array","nullable":true,"maxItems":100,"items":{"type":"string","additionalProperties":false,"examples":["jane","janey lee","jane lee MacDonald"]}},"servicePeriods":{"description":"Identifies the Service dates and Branch the Veteran served in.","type":"array","minItems":1,"items":{"type":"object","required":["serviceBranch","serviceComponent","activeDutyBeginDate","activeDutyEndDate"],"properties":{"serviceBranch":{"description":"Branch of service during period. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","maxLength":1000,"example":"Air Force"},"serviceComponent":{"type":"string","description":"","enum":["Active","Reserves","National Guard"]},"activeDutyBeginDate":{"description":"Date started active duty. This date must be in the past.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"},"activeDutyEndDate":{"description":"Date Completed Active Duty. Cannot be more than 180 days in the future, unless past service is also included.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"},"separationLocationCode":{"description":"Location code for the facility the Veteran plans to separate from. Code must match the values returned by the /intake-sites endpoint on the [Benefits reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","nullable":true,"example":"98283"}}}},"servedInActiveCombatSince911":{"type":"string","enum":["YES","NO"],"description":"Did Veteran serve in a combat zone since 9-11-2001?","example":"YES","nullable":true},"reservesNationalGuardService":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"component":{"type":"string","nullable":true,"description":"","enum":["Reserves","National Guard"]},"obligationTermsOfService":{"type":"object","nullable":true,"description":"If 'obligationTermsOfService' is included, the following attributes are required: 'beginDate ' and 'endDate'.","additionalProperties":false,"properties":{"beginDate":{"type":"string","nullable":true,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"},"endDate":{"type":"string","nullable":true,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06"}}},"unitName":{"type":"string","nullable":true,"maxLength":1000,"pattern":"^$|([a-zA-Z0-9\\-'.,# ][a-zA-Z0-9\\-'.,# ]?)*$"},"unitAddress":{"type":"string","maxLength":1000,"pattern":"^$|^([-a-zA-Z0-9'.,&# ])+$","nullable":true},"unitPhone":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"areaCode":{"type":"string","nullable":true,"maxLength":3,"pattern":"^$|^\\d{3}$","example":"555"},"phoneNumber":{"type":"string","nullable":true,"maxLength":20,"example":"5555555"}}},"receivingInactiveDutyTrainingPay":{"type":"string","enum":["YES","NO"],"nullable":true,"example":"YES"}}},"federalActivation":{"description":"If federalActivation is present then reservesNationalGuardService.obligationTermsOfService.beginDate, reservesNationalGuardService.obligationTermsOfService.endDate and reservesNationalGuardService.unitName are required","type":"object","nullable":true,"additionalProperties":false,"properties":{"activationDate":{"description":"Date cannot be in the future and must be after the earliest servicePeriod.activeDutyBeginDate.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06","nullable":true},"anticipatedSeparationDate":{"description":"Anticipated date of separation. Date must be in the future.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-06","nullable":true}}},"confinements":{"type":"array","nullable":true,"uniqueItems":true,"items":{"additionalProperties":false,"type":"object","properties":{"approximateBeginDate":{"description":"The approximateBeginDate must be after the earliest servicePeriod activeDutyBeginDate.","type":"string","nullable":false,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$|(?:[0-9]{4})-(?:0[1-9]|1[0-2])$","example":"2018-06-06 or 2018-06"},"approximateEndDate":{"type":"string","nullable":false,"pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$|(?:[0-9]{4})-(?:0[1-9]|1[0-2])$","example":"2018-06-06 or 2018-06"}}}}},"if":{"required":["federalActivation"]},"then":{"required":["reservesNationalGuardService"],"properties":{"reservesNationalGuardService":{"required":["obligationTermsOfService"],"properties":{"obligationTermsOfService":{"required":["beginDate","endDate"]}}}}}},"servicePay":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"receivingMilitaryRetiredPay":{"description":"Is the Veteran receiving military retired pay?","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"futureMilitaryRetiredPay":{"description":"Will the Veteran receive military retired pay pay in future? \n If true, then 'futurePayExplanation' is required.","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"futureMilitaryRetiredPayExplanation":{"description":"Explains why future pay will be received.","type":"string","maxLength":1000,"example":"Will be retiring soon.","nullable":true},"militaryRetiredPay":{"type":"object","nullable":true,"description":"","properties":{"branchOfService":{"description":"Branch of service. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","maxLength":1000,"nullable":true,"example":"Air Force"},"monthlyAmount":{"description":"Amount being received.","type":"integer","nullable":true,"example":100}}},"retiredStatus":{"type":"string","nullable":true,"description":"","enum":["RETIRED","TEMPORARY_DISABILITY_RETIRED_LIST","PERMANENT_DISABILITY_RETIRED_LIST"]},"favorMilitaryRetiredPay":{"description":"Is the Veteran waiving VA benefits to retain military retired pay? See item 26 on form 21-526EZ for more details.","type":"boolean","nullable":true,"example":true,"default":false},"receivedSeparationOrSeverancePay":{"description":"Has the Veteran ever received separation pay, disability severance pay, or any other lump sum payment from their branch of service?","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"separationSeverancePay":{"type":"object","nullable":true,"description":"","properties":{"datePaymentReceived":{"description":"Approximate date separation pay was received. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02 or 2018-03 or 2018"},"branchOfService":{"description":"Branch of service. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","nullable":true,"maxLength":1000,"example":"Air Force"},"preTaxAmountReceived":{"description":"Amount being received.","type":"integer","nullable":true,"example":100}}},"favorTrainingPay":{"description":"Is the Veteran waiving VA benefits to retain training pay? See item 28 on form 21-526EZ for more details. ","type":"boolean","nullable":true,"example":true,"default":false}}},"directDeposit":{"type":"object","nullable":true,"additionalProperties":false,"description":"Direct deposit information.","properties":{"noAccount":{"type":"boolean","nullable":true,"description":"Claimant certifies that they do not have an account with a financial institution or certified payment agent.","default":false},"accountNumber":{"description":"Account number for the direct deposit.","pattern":"^(?:[a-zA-Z0-9-]{4,1000})?$","type":"string","maxLength":1000,"nullable":true,"example":"123123123123"},"accountType":{"description":"Account type for the direct deposit.","type":"string","nullable":true,"example":"CHECKING","enum":["CHECKING","SAVINGS"]},"financialInstitutionName":{"description":"Provide the name of the financial institution where the Veteran wants the direct deposit.","maxLength":1000,"type":"string","nullable":true,"example":"Some Bank"},"routingNumber":{"description":"Routing number for the direct deposit.","type":"string","maxLength":1000,"nullable":true,"pattern":"^$|^\\d{0,1000}$","example":"123123123"}}},"claimantCertification":{"type":"boolean","description":"Claimant certifies and authorizes release of information.","default":false},"claimNotes":{"type":"string","description":"An optional notes section.","maxLength":4000},"claimDate":{"description":"Date when claim is being submitted to the VA. Date cannot be in the future.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-04"}}}}}},"example":{"data":{"type":"form/526","attributes":{"claimProcessType":"STANDARD_CLAIM_PROCESS","claimNotes":"Some things that are important to know, and are not included in any other place.","veteranIdentification":{"serviceNumber":"123456789","veteranNumber":{"telephone":"5555555555"},"mailingAddress":{"addressLine1":"123 Main Street","addressLine2":"Unit 1","addressLine3":"Room 2","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"1234"},"emailAddress":{"email":"valid@somedomain.com","agreeToEmailRelatedToClaim":true},"currentVaEmployee":false},"changeOfAddress":{"typeOfAddressChange":"TEMPORARY","addressLine1":"456 Main Street","addressLine2":"Unit 3","addressLine3":"Room 4","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"9897","dates":{"beginDate":"2025-06-04","endDate":"2025-12-31"}},"homeless":{"currentlyHomeless":{"homelessSituationOptions":"OTHER","otherDescription":"Other living situation"},"pointOfContact":"John Doe","pointOfContactNumber":{"telephone":"5555555555"}},"toxicExposure":{"gulfWarHazardService":{"servedInGulfWarHazardLocations":"NO"},"herbicideHazardService":{"servedInHerbicideHazardLocations":"YES","otherLocationsServed":"Other locations served","serviceDates":{"beginDate":"1972-05","endDate":"1980-10"}},"additionalHazardExposures":{"additionalExposures":["OTHER"],"specifyOtherExposures":"Agent Orange","exposureDates":{"beginDate":"1972-05","endDate":"1980-10"}},"multipleExposures":[{"hazardExposedTo":"Agent Orange","exposureLocation":"Vietnam","exposureDates":{"beginDate":"1972-05","endDate":"1973-01"}},{"hazardExposedTo":"Agent Orange","exposureLocation":"Vietnam","exposureDates":{"beginDate":"1979-04","endDate":"1980-10"}}]},"disabilities":[{"name":"Diabetes","exposureOrEventOrInjury":"Agent Orange","serviceRelevance":"Service in Vietnam War","approximateDate":"1975-05","disabilityActionType":"NEW","isRelatedToToxicExposure":true},{"name":"Hearing Loss","exposureOrEventOrInjury":"Noise","serviceRelevance":"Heavy equipment operator in service","approximateDate":"1968-07","disabilityActionType":"INCREASE","classificationCode":"8987","ratedDisabilityId":"1234567","diagnosticCode":5678,"isRelatedToToxicExposure":false}],"treatments":[{"beginDate":"2021-04","treatedDisabilityNames":["Diabetes"],"center":{"name":"ATLANTA VA MEDICAL CENTER","state":"GA","city":"ATLANTA"}},{"beginDate":"1996-03","treatedDisabilityNames":["Hearing Loss"],"center":{"name":"ATLANTA VA MEDICAL CENTER","state":"GA","city":"ATLANTA"}}],"serviceInformation":{"alternateNames":["Jon Doe","Jane Doe"],"servicePeriods":[{"serviceBranch":"Air Force","serviceComponent":"Active","activeDutyBeginDate":"1964-11-14","activeDutyEndDate":"1980-10-30","separationLocationCode":"98289"}],"servedInActiveCombatSince911":"NO","reservesNationalGuardService":{"component":"National Guard","obligationTermsOfService":{"beginDate":"1990-11-24","endDate":"1995-11-17"},"unitName":"National Guard Unit Name","unitAddress":"1243 Main Street","unitPhone":{"areaCode":"555","phoneNumber":"5555555"},"receivingInactiveDutyTrainingPay":"YES"},"confinements":[{"approximateBeginDate":"1970-06-11","approximateEndDate":"1970-09-11"}]},"servicePay":{"receivingMilitaryRetiredPay":"NO","futureMilitaryRetiredPay":"YES","futureMilitaryRetiredPayExplanation":"Explanation of future military retired pay","militaryRetiredPay":{"branchOfService":"Air Force","monthlyAmount":240},"retiredStatus":"PERMANENT_DISABILITY_RETIRED_LIST","favorMilitaryRetiredPay":false,"receivedSeparationOrSeverancePay":"YES","separationSeverancePay":{"datePaymentReceived":"2018-07-31","branchOfService":"Air Force","preTaxAmountReceived":179},"favorTrainingPay":false},"directDeposit":{"accountNumber":"123123123123","accountType":"CHECKING","financialInstitutionName":"Chase","routingNumber":"123456789"},"claimantCertification":true}}}}}},"required":true}}},"/veterans/{veteranId}/526/generatePDF/minimum-validations":{"post":{"summary":"Returns filled out 526EZ form as PDF with minimum validations (restricted access)","tags":["Disability Compensation Claims"],"operationId":"POST:/veterans/{veteranId}/526/generatePDF/minimum-validations","security":[{"productionOauth":["system/526-pdf.override"]},{"sandboxOauth":["system/526-pdf.override"]},{"bearer_token":[]}],"parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"description":"Returns a filled out 526EZ form for a disability compensation claim (21-526EZ).\n\nThis endpoint can be used to generate the PDF based on the request data in the case that the submission was not able to be successfully auto-established. The PDF can then be uploaded via the [Benefits Intake API](https://developer.va.gov/explore/api/benefits-intake) to digitally submit directly to the Veterans Benefits Administration's (VBA) claims intake process.\n","responses":{"200":{"description":"post pdf response","content":{"application/pdf":{"example":"string","schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]}},"application/pdf":{"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Unable to locate Veteran's ID/ICN in Master Person Index (MPI). Please submit an issue at ask.va.gov or call 1-800-MyVA411 (800-698-2411) for assistance."}]}},"application/pdf":{"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes",null],"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Claims API 526 GeneratePDF Schema","type":"object","additionalProperties":false,"required":["claimantCertification","claimProcessType","disabilities","serviceInformation","veteranIdentification"],"properties":{"claimDate":{"pattern":"^(\\d{4})-(\\d{2})-(\\d{2})$","type":"string","example":"2018-06-04"},"claimProcessType":{"type":"string","description":"Select type of claim program/process that applies to the Veteran.","enum":["STANDARD_CLAIM_PROCESS","FDC_PROGRAM","BDD_PROGRAM"]},"veteranIdentification":{"type":"object","additionalProperties":false,"required":["mailingAddress","currentVaEmployee"],"properties":{"serviceNumber":{"type":"string","description":"Service identification number","nullable":true,"maxLength":1000},"veteranNumber":{"description":"If there isn't a ten digit phone number in VBMS for the Veteran, the exams will not be ordered. Including the phone number is recommended to avoid claim processing delays.","type":"object","nullable":true,"properties":{"telephone":{"description":"Veteran's phone number. Number including area code.","type":"string","example":"5555555555","nullable":true},"internationalTelephone":{"type":"string","description":"Veteran's international phone number.","example":"+44 20 1234 5678","nullable":true,"maxLength":1000}}},"mailingAddress":{"type":"object","additionalProperties":false,"required":["addressLine1","city","country"],"properties":{"addressLine1":{"description":"Address line 1 for the Veteran's current mailing address.","type":"string","maxLength":325,"example":"1234 Couch Street"},"addressLine2":{"description":"Address line 2 for the Veteran's current mailing address.","type":"string","maxLength":325,"example":"Unit 4","nullable":true},"addressLine3":{"description":"Address line 3 for the Veteran's current mailing address.","type":"string","maxLength":325,"example":"Room 1","nullable":true},"city":{"description":"City for the Veteran's current mailing address.","type":"string","example":"Schenectady","maxLength":1000},"state":{"description":"State for the Veteran's current mailing address.","type":"string","example":"NY","maxLength":1000,"nullable":true},"country":{"description":"Country for the Veteran's current mailing address.  Must match the values returned by the /countries endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"USA","maxLength":1000},"zipFirstFive":{"description":"Zip code (First 5 digits) for the Veteran's current mailing address.","type":"string","example":"12345","maxLength":500,"nullable":true},"zipLastFour":{"description":"Zip code (Last 4 digits) for the Veteran's current mailing address.","type":"string","example":"6789","nullable":true,"maxLength":500},"internationalPostalCode":{"description":"International postal code for the Veteran's current mailing address.","type":"string","maxLength":1000,"nullable":true}}},"emailAddress":{"description":"Information associated with the Veteran's email address.","type":"object","nullable":true,"properties":{"email":{"type":"string","description":"The most current email address of the Veteran.","maxLength":1000,"nullable":true},"agreeToEmailRelatedToClaim":{"type":"boolean","description":"Agreement to email information relating to this claim.","example":true,"default":false,"nullable":true}}},"currentVaEmployee":{"type":"boolean","description":"Set to true if Veteran is a VA employee.","nullable":false}}},"changeOfAddress":{"description":"If 'changeOfAddress' is included, the following attributes are required: 'typeOfAddressChange', 'dates.beginDate', 'addressLine1', 'city', 'state', 'country', 'zipFirstFive'.","type":"object","nullable":true,"additionalProperties":false,"properties":{"typeOfAddressChange":{"description":"Temporary or Permanent change of address. If 'TEMPORARY', 'beginDate' and 'endDate' are required.","type":"string","enum":["TEMPORARY","PERMANENT"],"example":"PERMANENT"},"addressLine1":{"description":"Address line 1 for the Veteran's new address.","type":"string","maxLength":325,"example":"1234 Couch Street"},"addressLine2":{"description":"Address line 2 for the Veteran's new address.","type":"string","maxLength":325,"example":"Unit 4","nullable":true},"addressLine3":{"description":"Address line 3 for the Veteran's new address.","type":"string","maxLength":325,"example":"Room 1","nullable":true},"city":{"description":"City for the Veteran's new address.","type":"string","example":"Schenectady","maxLength":1000},"state":{"description":"State for the Veteran's new address.","type":"string","example":"NY","maxLength":1000,"nullable":true},"country":{"description":"Country for the Veteran's new address. Value must match the values returned by the /countries endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"USA","maxLength":1000,"nullable":true},"zipFirstFive":{"description":"Zip code (First 5 digits) for the Veteran's new address.","type":"string","example":"12345","maxLength":500,"nullable":true},"zipLastFour":{"description":"Zip code (Last 4 digits) for the Veteran's new address.","type":"string","nullable":true,"example":"6789","maxLength":500},"internationalPostalCode":{"description":"International postal code for the Veteran's new address.","type":"string","maxLength":1000,"nullable":true},"dates":{"type":"object","properties":{"beginDate":{"description":"Begin date for the Veteran's new address.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2018-06-04"},"endDate":{"description":"Date in YYYY-MM-DD the changed address expires, if change is temporary.","type":"string","nullable":true,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2018-06-04"}}}}},"homeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"isCurrentlyHomeless":{"type":"boolean","nullable":true,"description":"Is the Veteran currently homeless?"},"currentlyHomeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"homelessSituationOptions":{"description":"Veteran's living situation.","type":"string","nullable":true,"default":"other","enum":["LIVING_IN_A_HOMELESS_SHELTER","NOT_CURRENTLY_IN_A_SHELTERED_ENVIRONMENT","STAYING_WITH_ANOTHER_PERSON","FLEEING_CURRENT_RESIDENCE","OTHER"],"example":"FLEEING_CURRENT_RESIDENCE"},"otherDescription":{"description":"Explanation of living situation. Required if 'homelessSituationOptions' is 'OTHER'.","type":"string","nullable":true,"maxLength":5000,"example":"other living situation"}}},"isAtRiskOfBecomingHomeless":{"type":"boolean","nullable":true,"description":"Is the Veteran currently at risk of becoming homeless?"},"riskOfBecomingHomeless":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"livingSituationOptions":{"type":"string","nullable":true,"default":"HOUSING_WILL_BE_LOST_IN_30_DAYS","enum":["HOUSING_WILL_BE_LOST_IN_30_DAYS","LEAVING_PUBLICLY_FUNDED_SYSTEM_OF_CARE","OTHER"]},"otherDescription":{"description":"Explanation of living situation. Required if 'livingSituationOptions' is 'OTHER'.","type":"string","nullable":true,"maxLength":5000,"example":"other living situation"}}},"pointOfContact":{"description":"Individual in direct contact with Veteran.","type":"string","nullable":true,"minLength":1,"maxLength":1000,"example":"Jane Doe"},"pointOfContactNumber":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"telephone":{"description":"Ten digit primary phone of point of contact.","type":"string","example":"5555555555","nullable":true},"internationalTelephone":{"description":"International phone of point of contact.","type":"string","example":"+44 20 1234 5678","nullable":true,"maxLength":1000}}}}},"toxicExposure":{"type":"object","nullable":true,"properties":{"gulfWarHazardService":{"type":"object","nullable":true,"description":"Toxic exposure related to the Gulf war.","properties":{"servedInGulfWarHazardLocations":{"type":"string","description":"Set to true if the Veteran served in any of the following Gulf War hazard locations: Iraq; Kuwait; Saudi Arabia; the neutral zone between Iraq and Saudi Arabia; Bahrain; Qatar; the United Arab Emirates; Oman; Yemen; Lebanon; Somalia; Afghanistan; Israel; Egypt; Turkey; Syria; Jordan; Djibouti; Uzbekistan; the Gulf of Aden; the Gulf of Oman; the Persian Gulf; the Arabian Sea; and the Red Sea.","example":"YES","enum":["NO","YES"],"nullable":true},"serviceDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for serving in Gulf War hazard location.","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for serving in Gulf War hazard location.","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018"}}}}},"herbicideHazardService":{"description":"Toxic exposure related to herbicide (Agent Orange) hazards.","type":"object","nullable":true,"properties":{"servedInHerbicideHazardLocations":{"type":"string","description":"Set to true if the Veteran served in any of the following herbicide/Agent Orange locations: Republic of Vietnam to include the 12 nautical mile territorial waters; Thailand at any United States or Royal Thai base; Laos; Cambodia at Mimot or Krek; Kampong Cham Province; Guam or American Samoa; or in the territorial waters thereof; Johnston Atoll or a ship that called at Johnston Atoll; Korean demilitarized zone; aboard (to include repeated operations and maintenance with) a C-123 aircraft known to have been used to spray an herbicide agent (during service in the Air Force and Air Force Reserves).","example":"YES","enum":["NO","YES"],"nullable":true},"otherLocationsServed":{"type":"string","nullable":true,"description":"Other location(s) where Veteran served.","maxLength":5000},"serviceDates":{"description":"Date range for exposure in herbicide hazard location.","type":"object","nullable":true,"properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for serving in herbicide location.","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for serving in herbicide location.","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018"}}}}},"additionalHazardExposures":{"type":"object","nullable":true,"description":"Additional hazardous exposures.","properties":{"additionalExposures":{"description":"Additional exposure incidents.","type":"array","nullable":true,"maxItems":5000,"items":{"type":"string","additionalProperties":false,"enum":["ASBESTOS","MUSTARD_GAS","RADIATION","SHIPBOARD_HAZARD_AND_DEFENSE","MILITARY_OCCUPATIONAL_SPECIALTY_RELATED_TOXIN","CONTAMINATED_WATER_AT_CAMP_LEJEUNE","OTHER"]}},"specifyOtherExposures":{"type":"string","nullable":true,"description":"Exposure to asbestos.","maxLength":5000},"exposureDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for exposure.","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for exposure.","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018"}}}}},"multipleExposures":{"type":"array","nullable":true,"maxItems":5000,"minItems":0,"items":{"type":"object","additionalProperties":false,"properties":{"hazardExposedTo":{"type":"string","nullable":true,"description":"Hazard the Veteran was exposed to.","maxLength":1000},"exposureLocation":{"type":"string","nullable":true,"description":"Location where the exposure happened.","maxLength":1000},"exposureDates":{"type":"object","nullable":true,"description":"Date range for when the exposure happened.","properties":{"beginDate":{"type":"string","nullable":true,"description":"Approximate begin date for exposure.","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018"},"endDate":{"type":"string","nullable":true,"description":"Approximate end date for exposure.","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018"}}}}}}}},"disabilities":{"description":"Any current disabilities or symptoms the Veteran is claiming are related to their military service and/or are service-connected.","type":"array","maxItems":5000,"minItems":1,"items":{"type":"object","additionalProperties":false,"required":["disabilityActionType","name"],"properties":{"name":{"description":"Name of the disability. The /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible disability names.","type":"string","example":"PTSD (post traumatic stress disorder)","maxLength":1000},"exposureOrEventOrInjury":{"type":"string","description":"What caused the disability?","nullable":true,"examples":["Agent Orange","radiation","burn pits"],"maxLength":1000},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury. If the disabilityActionType is 'NEW', the serviceRelevance is required.","type":"string","nullable":true,"example":"Heavy equipment operator in service.","maxLength":1000},"approximateDate":{"description":"Approximate date disability began. Date must be in the past. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02 or 2018-03 or 2018","nullable":true,"maxLength":1000},"disabilityActionType":{"description":"Action type requested for the disability. If 'INCREASE' or 'NONE', then 'ratedDisabilityId' and 'diagnosticCode' should be included. 'NONE' should be used when including a secondary disability.","type":"string","enum":["NONE","NEW","INCREASE"],"example":"NEW"},"classificationCode":{"type":"string","description":"Classification code for the associated body system. Must match an active code returned by the /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","example":"249470","nullable":true},"ratedDisabilityId":{"description":"When submitting a contention with action type 'INCREASE', the previously rated disability id may be included.","type":"string","example":"1100583","nullable":true},"diagnosticCode":{"description":"If the disabilityActionType is 'NONE' or 'INCREASE', the diagnosticCode should correspond to an existing rated disability.","type":"integer","example":9999,"nullable":true},"isRelatedToToxicExposure":{"type":"boolean","description":"Is the disability related to toxic exposures? If true, related 'toxicExposure' must be included.","example":true,"default":false,"nullable":true},"specialIssues":{"type":"array","nullable":true,"uniqueItems":true,"items":{"maxItems":2,"additionalProperties":false,"type":"string","enum":["POW","EMP"]}},"secondaryDisabilities":{"description":"If secondaryDisability is included, the following attributes are required: 'secondaryDisability.name', 'secondaryDisability.disabilityActionType' and 'secondaryDisability.serviceRelevance'","type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"description":"Name of the disability. The /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible disability names.","type":"string","example":"PTSD (post traumatic stress disorder)","maxLength":1000},"exposureOrEventOrInjury":{"type":"string","description":"What caused the disability?","nullable":true,"examples":["Agent Orange","radiation","burn pits"],"maxLength":1000},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","nullable":true,"example":"Heavy equipment operator in service.","maxLength":1000},"disabilityActionType":{"description":"The status of the secondary disability.","type":"string","example":"SECONDARY","enum":["SECONDARY"]},"approximateDate":{"description":"Approximate date disability began. Date must be in the past. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02 or 2018-03 or 2018","nullable":true,"maxLength":1000},"classificationCode":{"type":"string","description":"Classification code for the associated body system. Must match an active code returned by the /disabilities endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","example":"249470","nullable":true}}}}}}},"treatments":{"description":"Identifies the Service Treatment information of the Veteran. The combination of treatedDisabilityName, center name, center city, and center state must be less than 10,000 characters to successfully generate a PDF.","type":"array","nullable":true,"maxItems":5000,"items":{"type":"object","additionalProperties":false,"properties":{"beginDate":{"description":"Begin date for treatment. If treatment began from 2005 to present, you do not need to provide dates. Each treatment begin date must be after the first 'servicePeriod.activeDutyBeginDate'.","type":"string","pattern":"^(\\d{4}(-\\d{2})?)?$","example":"2018-06 or 2018","nullable":true},"treatedDisabilityNames":{"description":"Name(s) of disabilities treated in this time frame.","type":"array","nullable":true,"maxItems":101,"items":{"type":"string","additionalProperties":false,"example":["PTSD (post traumatic stress disorder)","Trauma"]}},"center":{"description":"VA Medical Center(s) and Department of Defense Military Treatment Facilities where the Veteran received treatment after discharge for any claimed disabilities.","type":"object","nullable":true,"additionalProperties":false,"properties":{"name":{"description":"Name of facility Veteran was treated in. The /treatment-centers endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve possible treatment center names.","type":"string","nullable":true,"example":"Private Facility 2","maxLength":100},"city":{"description":"City of treatment facility.","type":"string","example":"Schenectady","nullable":true},"state":{"description":"State of treatment facility.","type":"string","example":"NY","nullable":true}}}}}},"serviceInformation":{"type":"object","additionalProperties":false,"required":["servicePeriods"],"properties":{"alternateNames":{"description":"List any other names under which the Veteran served, if applicable.","type":"array","nullable":true,"maxItems":5000,"items":{"type":"string","additionalProperties":false,"examples":["jane","janey lee","jane lee MacDonald"]}},"servicePeriods":{"description":"Identifies the Service dates and Branch the Veteran served in.","type":"array","maxItems":5000,"minItems":1,"items":{"type":"object","required":["serviceBranch","serviceComponent","activeDutyBeginDate","activeDutyEndDate"],"properties":{"serviceBranch":{"description":"Branch of service during period. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","example":"Air Force","maxLength":1000},"serviceComponent":{"type":"string","description":"","enum":["Active","Reserves","National Guard"]},"activeDutyBeginDate":{"description":"Date started active duty. This date must be in the past.","type":"string","pattern":"^(?:\\d{4})-(?:\\d{2})-(?:\\d{2})$","example":"2018-06-06"},"activeDutyEndDate":{"description":"Date completed active duty.","type":"string","pattern":"^(?:\\d{4})-(?:\\d{2})-(?:\\d{2})$","example":"2018-06-06"},"separationLocationCode":{"description":"Location code for the facility the Veteran plans to separate from. Code must match the values returned by the /intake-sites endpoint on the [Benefits reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","nullable":true,"example":"98283"}}}},"servedInActiveCombatSince911":{"type":"string","enum":["YES","NO"],"description":"Did Veteran serve in a combat zone since 9-11-2001?","example":"YES","nullable":true},"reservesNationalGuardService":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"component":{"type":"string","nullable":true,"description":"","enum":["Reserves","National Guard"]},"obligationTermsOfService":{"type":"object","nullable":true,"description":"If 'obligationTermsOfService' is included, the following attributes are required: 'beginDate ' and 'endDate'.","additionalProperties":false,"properties":{"beginDate":{"type":"string","nullable":true,"pattern":"^(?:\\d{4})-(?:\\d{2})-(?:\\d{2})$","example":"2018-06-06"},"endDate":{"type":"string","nullable":true,"pattern":"^(?:\\d{4})-(?:\\d{2})-(?:\\d{2})$","example":"2018-06-06"}}},"unitName":{"type":"string","maxLength":1000,"nullable":true},"unitAddress":{"type":"string","maxLength":1000,"nullable":true},"unitPhone":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"areaCode":{"type":"string","nullable":true,"maxLength":1000,"example":"555"},"phoneNumber":{"type":"string","nullable":true,"maxLength":20,"example":"5555555"}}},"receivingInactiveDutyTrainingPay":{"type":"string","enum":["YES","NO"],"nullable":true,"example":"YES"}}},"federalActivation":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"activationDate":{"description":"Date cannot be in the future and must be after the earliest servicePeriod.activeDutyBeginDate.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$|^$","example":"2018-06-06","nullable":true},"anticipatedSeparationDate":{"description":"Anticipated date of separation. Date must be in the future.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$|^$","example":"2018-06-06","nullable":true}}},"confinements":{"type":"array","nullable":true,"maxItems":5000,"items":{"additionalProperties":false,"type":"object","properties":{"approximateBeginDate":{"description":"The approximateBeginDate must be after the earliest servicePeriod activeDutyBeginDate.","type":"string","nullable":true,"pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-06-06 or 2018-06"},"approximateEndDate":{"type":"string","nullable":true,"pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-06-06 or 2018-06"}}}}}},"servicePay":{"type":"object","nullable":true,"additionalProperties":false,"properties":{"receivingMilitaryRetiredPay":{"description":"Is the Veteran receiving military retired pay?","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"futureMilitaryRetiredPay":{"description":"Will the Veteran receive military retired pay pay in future? \n If true, then 'futurePayExplanation' is required.","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"futureMilitaryRetiredPayExplanation":{"description":"Explains why future pay will be received.","type":"string","example":"Will be retiring soon.","nullable":true,"maxLength":1000},"militaryRetiredPay":{"type":"object","nullable":true,"description":"","properties":{"branchOfService":{"description":"Branch of service. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","nullable":true,"maxLength":1000,"example":"Air Force"},"monthlyAmount":{"description":"Amount being received.","type":"integer","nullable":true,"example":100}}},"retiredStatus":{"type":"string","nullable":true,"description":"","enum":["RETIRED","TEMPORARY_DISABILITY_RETIRED_LIST","PERMANENT_DISABILITY_RETIRED_LIST"]},"favorMilitaryRetiredPay":{"description":"Is the Veteran waiving VA benefits to retain military retired pay? See item 26 on form 21-526EZ for more details.","type":"boolean","nullable":true,"example":true,"default":false},"receivedSeparationOrSeverancePay":{"description":"Has the Veteran ever received separation pay, disability severance pay, or any other lump sum payment from their branch of service?","type":"string","enum":["YES","NO"],"example":"YES","nullable":true},"separationSeverancePay":{"type":"object","nullable":true,"description":"","properties":{"datePaymentReceived":{"description":"Approximate date separation pay was received. \n Format can be either YYYY-MM-DD or YYYY-MM or YYYY","type":"string","pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02 or 2018-03 or 2018"},"branchOfService":{"description":"Branch of service. The /service-branches endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current) may be used to retrieve list of possible service branches.","type":"string","maxLength":1000,"nullable":true,"example":"Air Force"},"preTaxAmountReceived":{"description":"Amount being received.","type":"integer","nullable":true,"example":100}}},"favorTrainingPay":{"description":"Is the Veteran waiving VA benefits to retain training pay? See item 28 on form 21-526EZ for more details. ","type":"boolean","nullable":true,"example":true,"default":false}}},"directDeposit":{"type":"object","nullable":true,"additionalProperties":false,"description":"If direct deposit information is included, the following attributes are required: accountType, accountNumber, routingNumber.","properties":{"noAccount":{"type":"boolean","nullable":true,"description":"Claimant certifies that they do not have an account with a financial institution or certified payment agent.","default":false},"accountNumber":{"description":"Account number for the direct deposit.","type":"string","maxLength":1000,"nullable":true,"example":"123123123123"},"accountType":{"description":"Account type for the direct deposit.","type":"string","nullable":true,"example":"CHECKING","enum":["CHECKING","SAVINGS"]},"financialInstitutionName":{"description":"Provide the name of the financial institution where the Veteran wants the direct deposit.","maxLength":1000,"type":"string","nullable":true,"example":"Some Bank"},"routingNumber":{"description":"Routing number for the direct deposit.","type":"string","nullable":true,"maxLength":9,"example":"123123123"}}},"claimantCertification":{"type":"boolean","description":"Claimant certifies and authorizes release of information.","default":false},"claimNotes":{"type":"string","description":"An optional notes section.","maxLength":4000}}}}}},"example":{"data":{"type":"form/526","attributes":{"claimDate":"2018-06-25","claimProcessType":"STANDARD_CLAIM_PROCESS","claimNotes":"Some things that are important to know, and are not included in any other place.","veteranIdentification":{"serviceNumber":"123456789","veteranNumber":{"telephone":"5555555555"},"mailingAddress":{"addressLine1":"123 Main Street","addressLine2":"Unit 1","addressLine3":"Room 2","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"1234"},"emailAddress":{"email":"valid@somedomain.com","agreeToEmailRelatedToClaim":true},"currentVaEmployee":false},"changeOfAddress":{"typeOfAddressChange":"TEMPORARY","addressLine1":"456 Main Street","addressLine2":"Unit 3","addressLine3":"Room 4","city":"Schenectady","state":"NY","country":"USA","zipFirstFive":"12345","zipLastFour":"9897","dates":{"beginDate":"2025-06-04","endDate":"2025-12-31"}},"homeless":{"currentlyHomeless":{"homelessSituationOptions":"OTHER","otherDescription":"Other living situation"},"pointOfContact":"John Doe","pointOfContactNumber":{"telephone":"5555555555"}},"toxicExposure":{"gulfWarHazardService":{"servedInGulfWarHazardLocations":"NO"},"herbicideHazardService":{"servedInHerbicideHazardLocations":"YES","otherLocationsServed":"Other locations served","serviceDates":{"beginDate":"1972-05","endDate":"1980-10"}},"additionalHazardExposures":{"additionalExposures":["OTHER"],"specifyOtherExposures":"Agent Orange","exposureDates":{"beginDate":"1972-05","endDate":"1980-10"}},"multipleExposures":[{"hazardExposedTo":"Agent Orange","exposureLocation":"Vietnam","exposureDates":{"beginDate":"1972-05","endDate":"1973-01"}},{"hazardExposedTo":"Agent Orange","exposureLocation":"Vietnam","exposureDates":{"beginDate":"1979-04","endDate":"1980-10"}}]},"disabilities":[{"name":"Diabetes","exposureOrEventOrInjury":"Agent Orange","serviceRelevance":"Service in Vietnam War","approximateDate":"1975-05","disabilityActionType":"NEW","isRelatedToToxicExposure":true},{"name":"Hearing Loss","exposureOrEventOrInjury":"Noise","serviceRelevance":"Heavy equipment operator in service","approximateDate":"1968-07","disabilityActionType":"INCREASE","classificationCode":"8987","ratedDisabilityId":"1234567","diagnosticCode":5678,"isRelatedToToxicExposure":false}],"treatments":[{"beginDate":"2021-04","treatedDisabilityNames":["Diabetes"],"center":{"name":"ATLANTA VA MEDICAL CENTER","state":"GA","city":"ATLANTA"}},{"beginDate":"1996-03","treatedDisabilityNames":["Hearing Loss"],"center":{"name":"ATLANTA VA MEDICAL CENTER","state":"GA","city":"ATLANTA"}}],"serviceInformation":{"alternateNames":["Jon Doe","Jane Doe"],"servicePeriods":[{"serviceBranch":"Air Force","serviceComponent":"Active","activeDutyBeginDate":"1964-11-14","activeDutyEndDate":"1980-10-30","separationLocationCode":"98289"}],"servedInActiveCombatSince911":"NO","reservesNationalGuardService":{"component":"National Guard","obligationTermsOfService":{"beginDate":"1990-11-24","endDate":"1995-11-17"},"unitName":"National Guard Unit Name","unitAddress":"1243 Main Street","unitPhone":{"areaCode":"555","phoneNumber":"5555555"},"receivingInactiveDutyTrainingPay":"YES"},"confinements":[{"approximateBeginDate":"1970-06-11","approximateEndDate":"1970-09-11"}]},"servicePay":{"receivingMilitaryRetiredPay":"NO","futureMilitaryRetiredPay":"YES","futureMilitaryRetiredPayExplanation":"Explanation of future military retired pay","militaryRetiredPay":{"branchOfService":"Air Force","monthlyAmount":240},"retiredStatus":"PERMANENT_DISABILITY_RETIRED_LIST","favorMilitaryRetiredPay":false,"receivedSeparationOrSeverancePay":"YES","separationSeverancePay":{"datePaymentReceived":"2018-07-31","branchOfService":"Air Force","preTaxAmountReceived":179},"favorTrainingPay":false},"directDeposit":{"accountNumber":"123123123123","accountType":"CHECKING","financialInstitutionName":"Chase","routingNumber":"123456789"},"claimantCertification":true}}}}}},"required":true}}},"/veterans/{veteranId}/claims":{"get":{"summary":"Find all benefits claims for a VA claimant","tags":["Claims"],"operationId":"GET:/veterans/{veteranId}/claims","security":[{"productionOauth":["system/claim.read"]},{"sandboxOauth":["system/claim.read"]},{"bearer_token":[]}],"parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"200":{"description":"claim response","content":{"application/json":{"example":{"data":[{"id":"555555555","type":"claim","attributes":{"baseEndProductCode":"400","claimDate":"2017-05-02","claimPhaseDates":{"phaseChangeDate":"2017-10-18","phaseType":"COMPLETE"},"claimType":"Compensation","claimTypeCode":"400PREDSCHRG","closeDate":"2017-10-18","decisionLetterSent":false,"developmentLetterSent":false,"documentsNeeded":false,"endProductCode":"404","evidenceWaiverSubmitted5103":false,"lighthouseId":null,"status":"COMPLETE"}}]},"schema":{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"required":["id","type","attributes"],"additionalProperties":false,"description":"Claim details","properties":{"id":{"type":"string","nullable":true,"description":"Claim ID in VBMS. If a claim was submitted with Lighthouse and not successfully established upstream, it could have a null claimId.","example":"600131328"},"type":{"type":"string","example":"claim"},"attributes":{"type":"object","required":["baseEndProductCode","claimType","claimDate","claimPhaseDates","closeDate","developmentLetterSent","decisionLetterSent","documentsNeeded","endProductCode","evidenceWaiverSubmitted5103","lighthouseId","status"],"properties":{"baseEndProductCode":{"type":"string","description":"Base end product code for claim","example":"400"},"claimType":{"type":"string","description":"Name of claim type","example":"Compensation"},"claimDate":{"format":"date","type":"string","description":"Date the claim was first filed. In YYYY-MM-DD format.","example":"2018-06-04"},"claimPhaseDates":{"type":"object","properties":{"phaseChangeDate":{"format":"date","type":"string","description":"The date that the claim changed to its current phase","example":"2017-10-18"},"phaseType":{"type":"string","enum":["CLAIM_RECEIVED","UNDER_REVIEW","GATHERING_OF_EVIDENCE","REVIEW_OF_EVIDENCE","PREPARATION_FOR_DECISION","PENDING_DECISION_APPROVAL","PREPARATION_FOR_NOTIFICATION","COMPLETE"],"description":"The most current phase for the claim","example":"UNDER_REVIEW"}}},"closeDate":{"format":"date","type":"string","description":"Date claim was closed","example":"2019-09-04"},"developmentLetterSent":{"type":"boolean","description":"If true, a development letter has been sent to the claimant regarding a benefit claim","example":"false"},"decisionLetterSent":{"type":"boolean","description":"If true, a decision letter has been sent to the claimant regarding a benefit claim","example":"false"},"documentsNeeded":{"type":"boolean","description":"If true, the claim requires additional documents to be submitted","example":"false"},"endProductCode":{"type":"string","description":"End product code of claim"},"evidenceWaiverSubmitted5103":{"type":"boolean","nullable":true,"description":"If true, indicates a decision has been requested and/or a Waiver 5103 has been submitted","example":"false"},"lighthouseId":{"type":"string","nullable":true,"description":"Claim ID in Lighthouse","example":"00000000-0000-0000-0000-000000000006"},"status":{"type":"string","description":"Status of claim","enum":["PENDING","CLAIM_RECEIVED","INITIAL_REVIEW","EVIDENCE_GATHERING_REVIEW_DECISION","PREPARATION_FOR_NOTIFICATION","COMPLETE","ERRORED","CANCELED"]}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/veterans/{veteranId}/claims/{id}":{"get":{"summary":"Find claim by ID.","tags":["Claims"],"operationId":"GET:/veterans/{veteranId}/claims/{id}","security":[{"productionOauth":["system/claim.read"]},{"sandboxOauth":["system/claim.read"]},{"bearer_token":[]}],"description":"Retrieves a specific claim for a Veteran","parameters":[{"name":"id","in":"path","example":"600400703","description":"The ID of the claim being requested","required":true,"schema":{"type":"string"}},{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"200":{"description":"errored claim response","content":{"application/json":{"examples":{"returns a 200 response for established claim":{"value":{"data":{"id":"555555555","type":"claim","attributes":{"claimTypeCode":"400PREDSCHRG","claimDate":"2017-05-02","claimPhaseDates":{"phaseChangeDate":"2017-10-18","currentPhaseBack":false,"latestPhaseType":"COMPLETE","previousPhases":{"phase7CompleteDate":"2017-10-18"}},"claimType":"Compensation","closeDate":"2017-10-18","contentions":[{"name":"abnormal heart (New)"},{"name":"abscess kidney (New)"},{"name":"encephalitis lethargica residuals (New)"},{"name":"dracunculiasis (New)"},{"name":"gingivitis (New)"},{"name":"abnormal weight loss (New)"},{"name":"groin condition (New)"},{"name":"metritis (New)"}],"decisionLetterSent":false,"developmentLetterSent":false,"documentsNeeded":false,"endProductCode":"404","evidenceWaiverSubmitted5103":false,"errors":[],"jurisdiction":"National Work Queue","lighthouseId":null,"maxEstClaimDate":null,"minEstClaimDate":null,"status":"CANCELED","submitterApplicationCode":"EBN","submitterRoleCode":"VET","supportingDocuments":[],"tempJurisdiction":null,"trackedItems":[{"closedDate":"2021-06-04","description":null,"displayName":"21-4142a","overdue":false,"receivedDate":null,"requestedDate":"2021-05-05","status":"NO_LONGER_REQUIRED","suspenseDate":"2021-06-04","id":293440,"uploadsAllowed":false},{"closedDate":"2021-06-04","description":null,"displayName":"Employment info needed","overdue":false,"receivedDate":null,"requestedDate":"2021-05-05","status":"NO_LONGER_REQUIRED","suspenseDate":"2021-06-04","id":293443,"uploadsAllowed":false},{"closedDate":"2021-06-04","description":null,"displayName":"Accidental injury - 21-4176 needed","overdue":false,"receivedDate":null,"requestedDate":"2021-05-05","status":"NO_LONGER_REQUIRED","suspenseDate":"2021-06-04","id":293444,"uploadsAllowed":false},{"closedDate":"2021-06-04","description":null,"displayName":"Buddy mentioned - No complete address","overdue":false,"receivedDate":null,"requestedDate":"2021-05-05","status":"NO_LONGER_REQUIRED","suspenseDate":"2021-06-04","id":293446,"uploadsAllowed":false}]}}}},"returns a 200 response for errored claim":{"value":{"data":{"id":null,"type":"claim","attributes":{"claimTypeCode":null,"claimDate":null,"claimPhaseDates":null,"claimType":null,"closeDate":null,"contentions":null,"decisionLetterSent":null,"developmentLetterSent":null,"documentsNeeded":null,"endProductCode":null,"evidenceWaiverSubmitted5103":null,"errors":[{"detail":"ERROR must match d{7}","source":"form526/serviceInformation/reservesNationalGuardService/unitPhone/phoneNumber/Pattern"},{"detail":"ERROR must match d{7}","source":"form526/veteran/homelessness/pointOfContact/primaryPhone/phoneNumber/Pattern"}],"jurisdiction":null,"lighthouseId":"00000000-0000-0000-0000-000000000007","maxEstClaimDate":null,"minEstClaimDate":null,"status":"ERRORED","submitterApplicationCode":null,"submitterRoleCode":null,"supportingDocuments":[],"tempJurisdiction":null,"trackedItems":[]}}}}},"schema":{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","required":["data"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"additionalProperties":false,"description":"Claim details","properties":{"id":{"type":"string","nullable":true,"description":"Claim ID in VBMS. If a claim was submitted with Lighthouse and not successfully established upstream, it could have a null claimId.","example":"600131328"},"type":{"type":"string","example":"evss_claims"},"attributes":{"type":"object","additionalProperties":false,"required":["claimTypeCode","claimDate","claimPhaseDates","claimType","closeDate","contentions","decisionLetterSent","developmentLetterSent","documentsNeeded","endProductCode","evidenceWaiverSubmitted5103","errors","jurisdiction","lighthouseId","maxEstClaimDate","minEstClaimDate","status","submitterApplicationCode","submitterRoleCode","supportingDocuments","tempJurisdiction","trackedItems"],"properties":{"claimTypeCode":{"type":"string","description":"Type code of benefit claim","example":"400PREDSCHRG"},"claimType":{"type":"string","description":"Name of claim type","example":"Compensation"},"contentions":{"type":"array","description":"The contentions being submitted with a claim","items":{"type":"object","properties":{"name":{"type":"string","example":"abscess kidney (New)"}}}},"claimDate":{"format":"date","type":"string","nullable":true,"description":"The date a claim was filed","example":"2017-10-18"},"claimPhaseDates":{"type":"object","properties":{"currentPhaseBack":{"type":"boolean","description":"Indicates whether the current phase is moving backward."},"latestPhaseType":{"type":"string","enum":["CLAIM_RECEIVED","UNDER_REVIEW","GATHERING_OF_EVIDENCE","REVIEW_OF_EVIDENCE","PREPARATION_FOR_DECISION","PENDING_DECISION_APPROVAL","PREPARATION_FOR_NOTIFICATION","COMPLETE"],"nullable":true,"description":"The most current phase for the claim"},"phaseChangeDate":{"format":"date","type":"string","nullable":true,"description":"The date that the claim changed to its current phase","example":"2017-10-18"},"previousPhases":{"type":"object","properties":{"phase1CompleteDate":{"format":"date","type":"string","description":"Completed date of the claim received phase.","example":"2017-10-18"},"phase2CompleteDate":{"format":"date","type":"string","description":"Completed date of the initial review phase.","example":"2017-10-18"},"phase3CompleteDate":{"format":"date","type":"string","description":"Completed date of the gathering of evidence phase.","example":"2017-10-18"},"phase4CompleteDate":{"format":"date","type":"string","description":"Completed date of the reviewing of evidence phase.","example":"2017-10-18"},"phase5CompleteDate":{"format":"date","type":"string","description":"Completed date of the preparation for decision phase.","example":"2017-10-18"},"phase6CompleteDate":{"format":"date","type":"string","description":"Completed date of the pending decision approval phase.","example":"2017-10-18"},"phase7CompleteDate":{"format":"date","type":"string","description":"Completed date of the preparation for notification phase.","example":"2017-10-18"},"phase8CompleteDate":{"format":"date","type":"string","description":"Completed date of the completed phase.","example":"2017-10-18"}}}}},"closeDate":{"format":"date","type":"string","nullable":true,"description":"Date claim was closed","example":"2019-09-04"},"decisionLetterSent":{"type":"boolean","description":"If true, a decision letter has been sent to the claimant regarding a benefit claim"},"developmentLetterSent":{"type":"boolean","description":"If true, a development letter has been sent to the claimant regarding a benefit claim"},"documentsNeeded":{"type":"boolean","description":"If true, the claim requires additional documents to be submitted"},"endProductCode":{"type":"string","description":"End product code of claim","example":"930"},"evidenceWaiverSubmitted5103":{"type":"boolean","nullable":true,"description":"If true, indicates a decision has been requested and/or a Waiver 5103 has been submitted","example":"false"},"errors":{"type":"array","description":"Error details if claim is in an errored state.","items":{"properties":{"detail":{"type":"string","example":"Something happened"},"source":{"type":"string","example":"some/error/path"}}}},"jurisdiction":{"type":"string","description":"Regional office to which the claim is currently assigned."},"lighthouseId":{"type":"string","nullable":true,"description":"Claim ID in Lighthouse","example":"00000000-0000-0000-0000-000000000008"},"minEstClaimDate":{"format":"date","type":"string","nullable":true,"description":"Minimum estimated claim completion date","example":"2019-06-04"},"maxEstClaimDate":{"format":"date","type":"string","nullable":true,"description":"Maximum estimated claim completion date","example":"2019-09-04"},"status":{"type":"string","description":"Status of claim","enum":["PENDING","CLAIM_RECEIVED","INITIAL_REVIEW","EVIDENCE_GATHERING_REVIEW_DECISION","PREPARATION_FOR_NOTIFICATION","COMPLETE","ERRORED","CANCELED"]},"submitterApplicationCode":{"type":"string","description":"Application code of benefit claim submitter","example":"EBN"},"submitterRoleCode":{"type":"string","description":"Role code of benefit claim submitter","example":"VET"},"supportingDocuments":{"type":"array","description":"Information regarding any supported documents attached to a claim","items":{"properties":{"documentId":{"type":"string","description":"Unique identifier for the current version of this document"},"documentUuid":{"type":"string","description":"Version-independent UUID for this document","nullable":true},"documentTypeLabel":{"type":"string","nullable":true},"originalFileName":{"type":"string","description":"Name of document","nullable":true},"trackedItemId":{"type":"string","nullable":true},"uploadDate":{"format":"date","type":"string","description":"Date document was uploaded","example":"2023-04-14","nullable":true},"uploadDateTime":{"format":"date","type":"string","description":"Date and time document was uploaded in UTC format","example":"2023-04-14T13:54:52Z","nullable":true}}}},"tempJurisdiction":{"type":"string","description":"Temporary jurisdiction of claim"},"trackedItems":{"type":"array","description":"","items":{"type":"object","additionalProperties":false,"properties":{"closedDate":{"format":"date","type":"string","nullable":true,"description":"Date the tracked item was closed","example":"2017-10-18"},"description":{"type":"string","nullable":true,"description":"Description of the tracked item","example":"You may also submit statements from individuals having knowledge of your claimed condition."},"requestedDate":{"format":"date","type":"string","nullable":true,"description":"Date the tracked item was requested","example":"2017-10-18"},"id":{"type":"integer","description":"ID of the tracked item","example":293454},"displayName":{"type":"string","nullable":true,"description":"Description of the tracked item","example":"Submit buddy statement(s)"},"receivedDate":{"format":"date","type":"string","nullable":true,"description":"Date the tracked item was received","example":"2017-10-18"},"overdue":{"type":"boolean","nullable":true,"description":"True if the item is overdue","example":true},"status":{"type":"string","nullable":true,"description":"Enum with the status of the tracked item","example":"NO_LONGER_REQUIRED","enum":["ACCEPTED","INITIAL_REVIEW_COMPLETE","NEEDED_FROM_YOU","NEEDED_FROM_OTHERS","NO_LONGER_REQUIRED","SUBMITTED_AWAITING_REVIEW"]},"suspenseDate":{"format":"date","type":"string","nullable":true,"example":"2017-10-18"},"uploadsAllowed":{"type":"boolean","example":true}}}}}}}}},"benefit_claim_details_dto":{"attention_needed":"No","base_end_prdct_type_cd":"400","benefit_claim_id":"555555555","bnft_claim_lc_status":{"phase_chngd_dt":"2017-10-18T08:23:35.000+00:00","phase_type":"COMPLETE","phase_type_change_ind":"78"},"bnft_claim_type_cd":"400PREDSCHRG","claim_complete_dt":"2017-10-18T08:23:35.000+00:00","claim_dt":"2017-05-02","claim_status":"CAN","claim_status_type":"Compensation","contentions":"abnormal heart (New), abscess kidney (New), encephalitis lethargica residuals (New), dracunculiasis (New), gingivitis (New), abnormal weight loss (New), groin condition (New), metritis (New)","decision_notification_sent":"No","development_letter_sent":"No","end_prdct_type_cd":"404","errors":[],"poa":"RANDOM E PERSON","program_type":"CPL","ptcpnt_clmant_id":"111111111","ptcpnt_vet_id":"111111111","regional_office_jrsdctn":"National Work Queue","submtr_applcn_type_cd":"EBN","submtr_role_type_cd":"VET","temp_regional_office_jrsdctn":null,"wsyswwn":{"address_line1":"National Work Queue","address_line2":"810 Vermont Avenue NW","address_line3":null,"city":"Washington","state":"DC","zip":"20420"}},"@xmlns:ns0":"http://claimstatus.services.ebenefits.vba.va.gov/"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"Claim not found"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/veterans/{veteranId}/intent-to-file/{type}":{"get":{"summary":"Returns claimant's last active Intent to File submission for given benefit type.","tags":["Intent to File"],"operationId":"GET:/veterans/{veteranId}/intent-to-file/{type}","security":[{"productionOauth":["system/claim.read"]},{"sandboxOauth":["system/claim.read"]},{"bearer_token":[]}],"description":"Returns claimant's last active Intent to File submission for given benefit type of compensation, pension, or survivor.","parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}},{"name":"type","in":"path","required":true,"example":"compensation","description":"Type of Intent to File to return. Available values - compensation, pension, survivor.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response with active Intent to File","content":{"application/json":{"example":{"data":{"id":"193685","type":"intent_to_file","attributes":{"creationDate":"2021-03-16T19:15:21.000-05:00","expirationDate":"2022-03-16T19:15:20.000-05:00","type":"compensation","status":"active"}}},"schema":{"$schema":"http://json-schema.org/draft-04/schema#","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Intent To File ID","example":"600131328"},"type":{"type":"string","example":"intent_to_file"},"attributes":{"required":["creationDate","expirationDate","status","type"],"properties":{"creationDate":{"type":"string","format":"date","description":"Date the Intent to File was received at VA"},"expirationDate":{"type":"string","format":"date","description":"Date the Intent to File expires, this is 1 year from the createdDate"},"status":{"type":"string","description":"The status of the Intent to File","example":"active"},"type":{"type":"string","description":"The type of Intent to File filed","example":"compensation"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"No active 'C' intent to file found."}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/veterans/{veteranId}/intent-to-file":{"post":{"summary":"Submit form 0966 Intent to File.","tags":["Intent to File"],"operationId":"POST:/veterans/{veteranId}/intent-to-file","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"description":"Establishes an Intent to File for disability compensation, pension, and survivor claims.","parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"200":{"description":"0966 Response","content":{"application/json":{"example":{"data":{"id":"294045","type":"intent_to_file","attributes":{"creationDate":"2025-02-07T09:17:18-06:00","expirationDate":"2026-02-07T07:12:40-06:00","type":"compensation","status":"duplicate"}}},"schema":{"$schema":"http://json-schema.org/draft-04/schema#","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Intent To File ID","example":"600131328"},"type":{"type":"string","example":"intent_to_file"},"attributes":{"required":["creationDate","expirationDate","status","type"],"properties":{"creationDate":{"type":"string","format":"date","description":"Date the Intent to File was received at VA"},"expirationDate":{"type":"string","format":"date","description":"Date the Intent to File expires, this is 1 year from the createdDate"},"status":{"type":"string","description":"The status of the Intent to File","example":"active"},"type":{"type":"string","description":"The type of Intent to File filed","example":"compensation"}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"errors":[{"title":"invalid value for type","detail":"some-invalid-value is not valid for type"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"0966 Response","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"Veteran ID not found"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable entity","content":{"application/json":{"example":{"errors":[{"title":"Unprocessable Entity","detail":"Invalid claimantSsn parameter"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"502":{"description":"0966 Response","content":{"application/json":{"example":{"errors":[{"title":"Bad Gateway","detail":"Bad Gateway","code":"502","status":"502"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"required":["type"],"properties":{"type":{"type":"string","example":"compensation","description":"For an Intent to File for Survivor's Pension of Dependency and Indemnity Compensation(DIC), use type \"survivor\" and include claimant_ssn or participant_claimant_id to identify the surviving dependent of the Veteran.","enum":["compensation","pension","survivor"]},"claimantSsn":{"type":"string","example":"001122334","description":"SSN of the Claimant."}},"example":{"type":"compensation"}}}}},"example":{"data":{"type":"intent_to_file","attributes":{"type":"compensation"}}}}}},"required":true}}},"/veterans/{veteranId}/intent-to-file/validate":{"post":{"summary":"Validate form 0966 Intent to File.","tags":["Intent to File"],"operationId":"POST:/veterans/{veteranId}/intent-to-file/validate","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"description":"Validates an Intent to File for disability compensation, pension, and survivor claims.","parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"200":{"description":"0966 Response","content":{"application/json":{"example":{"data":{"type":"intent_to_file_validation","attributes":{"status":"valid"}}},"schema":{"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","description":"The status of the Intent to File","enum":["valid"]}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"errors":[{"title":"invalid value for type","detail":"some-invalid-value is not valid for type"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"code":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"required":["type"],"properties":{"type":{"type":"string","example":"compensation","description":"For an Intent to File for Survivor's Pension of Dependency and Indemnity Compensation(DIC), use type \"survivor\" and include claimant_ssn or participant_claimant_id to identify the surviving dependent of the Veteran.","enum":["compensation","pension","survivor"]},"claimantSsn":{"type":"string","example":"001122334","description":"SSN of the Claimant."}},"example":{"type":"compensation"}}}}},"example":{"data":{"type":"intent_to_file","attributes":{"type":"compensation"}}}}}},"required":true}}},"/veterans/{veteranId}/power-of-attorney":{"get":{"summary":"Retrieves current power of attorney","tags":["Power of Attorney"],"operationId":"GET:/veterans/{veteranId}/power-of-attorney","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"description":"Retrieve a claimant’s currently appointed accredited representative with power of attorney (General POA) for the claimant. Returns empty data if no General POA is assigned.","parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response with a current Power of Attorney","content":{"application/json":{"example":{"data":{"type":"individual","attributes":{"code":"A1Q","name":"Firstname Lastname","phoneNumber":"555-555-5555"}}},"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string","nullable":true,"description":"Type of representative, organization or individual","example":"individual"},"attributes":{"type":"object","additionalProperties":false,"required":["code","name","phoneNumber"],"properties":{"code":{"type":"string","nullable":true,"description":"Power of Attorney Code currently assigned to Veteran"},"name":{"description":"Name of individual representative or organization","type":"string","nullable":true,"example":"Jane Smith"},"phoneNumber":{"description":"Phone number of representative. Can be organization or individual phone number.","type":"string","nullable":true,"example":"555-555-5555"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not retrieve Power of Attorney with code: A1Q"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"errors":[{"title":"Unprocessable entity","status":"422","detail":"Could not retrieve Power of Attorney due to multiple representatives with code: A1Q","source":{"pointer":"/modules/claims_api/app/controllers/claims_api/v2/veterans/power_of_attorney/base_controller.rb:191:in `representative'"}}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/veterans/{veteranId}/power-of-attorney-request":{"post":{"summary":"Creates power of attorney request for an accredited representative","description":"Request the appointment of an accredited representative, on behalf of a claimant.","tags":["Power of Attorney"],"operationId":"POST:/veterans/{veteranId}/power-of-attorney-request","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"201":{"description":"Valid request response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000009","type":"power-of-attorney-request","attributes":{"veteran":{"serviceNumber":"123678453","serviceBranch":"ARMY","address":{"addressLine1":"2719 Hyperion Ave","addressLine2":"Apt 2","city":"Los Angeles","stateCode":"CA","countryCode":"US","zipCode":"92264","zipCodeSuffix":"0200"},"phone":{"countryCode":null,"areaCode":"555","phoneNumber":"5551234"},"email":"test@test.com","insuranceNumber":"1234567890"},"claimant":{"claimantId":null,"address":{"addressLine1":null,"addressLine2":null,"city":null,"stateCode":null,"countryCode":null,"zipCode":null,"zipCodeSuffix":null},"phone":{"countryCode":null,"areaCode":null,"phoneNumber":null},"email":null,"relationship":null},"representative":{"poaCode":"067"},"recordConsent":true,"consentLimits":["DRUG_ABUSE","SICKLE_CELL","HIV","ALCOHOLISM"],"consentAddressChange":true}}},"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["power-of-attorney-request"]},"attributes":{"type":"object","required":["veteran","claimant","representative"],"properties":{"veteran":{"type":"object","properties":{"serviceNumber":{"type":"string"},"serviceBranch":{"type":"string"},"phone":{"type":"object","properties":{"countryCode":{"type":"string"},"areaCode":{"type":"string"},"phoneNumber":{"type":"string"}}},"address":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"city":{"type":"string"},"stateCode":{"type":"string"},"countryCode":{"type":"string"},"zipCode":{"type":"string"},"zipCodeSuffix":{"type":"string"}}},"email":{"type":"string"},"insuranceNumber":{"type":"string"}}},"claimant":{"type":"object","properties":{"claimantId":{"type":"string"},"phone":{"type":"object","properties":{"countryCode":{"type":"string"},"areaCode":{"type":"string"},"phoneNumber":{"type":"string"}}},"address":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"city":{"type":"string"},"stateCode":{"type":"string"},"countryCode":{"type":"string"},"zipCode":{"type":"string"},"zipCodeSuffix":{"type":"string"}}},"email":{"type":"string"},"relationship":{"type":"string"}}},"representative":{"type":"object","properties":{"poaCode":{"type":"string"}}},"consentLimits":{"type":"array","items":{"type":"string","enum":["DRUG_ABUSE","ALCOHOLISM","HIV","SICKLE_CELL"]}},"consentAddressChange":{"description":"Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.","type":"boolean"},"recordConsent":{"description":"Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C.","type":"boolean"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not find an Accredited Representative with poa code: 067"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"errors":[{"title":"Unprocessable entity","detail":"The property /representative did not contain the required key poaCode","status":"422","source":{"pointer":"data/attributes/representative"}}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes",null],"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"POA Request (21-22/a) Schema","type":"object","additionalProperties":false,"required":["veteran","representative","recordConsent","consentAddressChange"],"properties":{"veteran":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"serviceNumber":{"description":"Service number for the veteran.","type":"string","maxLength":9},"serviceBranch":{"description":"Service branch for the veteran.","type":"string","enum":["AIR_FORCE","ARMY","COAST_GUARD","MARINE_CORPS","NAVY","SPACE_FORCE","OTHER"],"example":"ARMY"},"address":{"type":"object","additionalProperties":false,"required":["addressLine1","city","stateCode","countryCode","zipCode"],"properties":{"addressLine1":{"description":"Street number and name for the veteran's address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the veteran's address.","type":"string","maxLength":5},"city":{"description":"City for the veteran's address.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the veteran's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the veteran's address.","type":"string","example":"US","pattern":"^[A-Za-z0-9-]{2,6}$"},"zipCode":{"description":"Zip code (first 5 digits) for the veteran's address.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the veteran's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the veteran's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the veteran's phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the veteran.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the veteran.","type":"string","pattern":".@.","maxLength":61,"example":"veteran@example.com"},"insuranceNumber":{"type":"string","maxLength":10,"description":"Insurance number for the veteran, if applicable. Include letter prefix."}}},"claimant":{"description":"Include claimant information for dependent claimants.","type":"object","additionalProperties":false,"properties":{"claimantId":{"description":"Integration Control Number (ICN) for the dependent claimant.","type":"string","example":"123456789"},"address":{"type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Street number and name for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the dependent claimant's address.","type":"string","maxLength":5},"city":{"description":"City for the dependent claimant's address. Required if claimant information provided.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the dependent claimant's address. Required if claimant information provided.","type":"string","example":"US","pattern":"^[A-Za-z0-9-]{2,6}$"},"zipCode":{"description":"Zip code (first 5 digits) for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the dependent claimant's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the dependent claimant's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the dependent claimant's phone number.  Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the dependent claimant.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the dependent claimant.","type":"string","pattern":".@.","maxLength":61,"example":"claimant@example.com"},"relationship":{"description":"Relationship of claimant to the veteran. Required if claimant information provided.","type":"string","example":"Spouse"}}},"representative":{"description":"Details of the requested Power of Attorney representing the veteran.","type":"object","additionalProperties":false,"required":["poaCode"],"properties":{"poaCode":{"description":"The POA code of the accredited representative or organization.","type":"string","example":"A1Q"}}},"recordConsent":{"description":"Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C. Explicitly permits the designated representative to access sensitive medical records within VA. Setting 'recordConsent' to false will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"boolean"},"consentLimits":{"description":"Consent for the disclosure of records relating to treatment for drug abuse, alcoholism or alcohol abuse, infection with the human immunodeficiency virus (HIV), or sickle cell anemia is limited to this list. Including 'consentLimits' will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"array","items":{"type":"string","enum":["DRUG_ABUSE","ALCOHOLISM","HIV","SICKLE_CELL"]},"example":"DRUG ABUSE"},"consentAddressChange":{"description":"Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.","type":"boolean"}}}}}},"example":{"data":{"attributes":{"veteran":{"serviceNumber":"123678453","serviceBranch":"ARMY","address":{"addressLine1":"2719 Hyperion Ave","addressLine2":"Apt 2","city":"Los Angeles","countryCode":"US","stateCode":"CA","zipCode":"92264","zipCodeSuffix":"0200"},"phone":{"areaCode":"555","phoneNumber":"5551234"},"email":"test@test.com","insuranceNumber":"1234567890"},"representative":{"poaCode":"067"},"recordConsent":true,"consentAddressChange":true,"consentLimits":["DRUG_ABUSE","SICKLE_CELL","HIV","ALCOHOLISM"]}}}}}},"required":true}}},"/veterans/power-of-attorney-requests":{"post":{"summary":"Retrieves power of attorney requests for accredited representatives","tags":["Power of Attorney"],"operationId":"POST:/veterans/power-of-attorney-requests","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"description":"Search for power of attorney requests by specified POA codes. Optional filters include searching by status, city, state, and country.","parameters":[{"name":"page[size]","in":"query","required":false,"example":"20","description":"Number of results to return per page. Max value allowed is 100."},{"name":"page[number]","in":"query","required":false,"example":"1","description":"Number of pages of results to return. Max value allowed is 100."}],"responses":{"200":{"description":"Search results","content":{"application/json":{"example":{"data":[{"id":null,"type":"power-of-attorney-request","attributes":{"veteran":{"firstName":"[Vet First Name]","middleName":null,"lastName":"[Vet Last Name]"},"claimant":{"firstName":"[Claimant First Name]","lastName":"[Claimant Last Name]"},"address":{"city":"Charlottesville","stateCode":null,"zipCode":"00123","countryCode":"USA"},"representative":{"poaCode":"083"},"receivedDate":"2012-11-23T16:49:16-06:00","actionedDate":"2024-05-25T13:45:00-05:00","status":"New","declinedReason":null,"consentAddressChange":true,"recordConsent":true}},{"id":null,"type":"power-of-attorney-request","attributes":{"veteran":{"firstName":"first","middleName":null,"lastName":"last"},"claimant":{"firstName":null,"lastName":null},"address":{"city":"USAG J","stateCode":null,"zipCode":"01234","countryCode":"USA"},"representative":{"poaCode":"002"},"receivedDate":"2013-01-14T08:50:17-06:00","actionedDate":"2013-01-14T08:50:17-06:00","status":"New","declinedReason":null,"consentAddressChange":true,"recordConsent":true}},{"id":null,"type":"power-of-attorney-request","attributes":{"veteran":{"firstName":"first","middleName":null,"lastName":"last"},"claimant":{"firstName":null,"lastName":null},"address":{"city":"Bourges","stateCode":null,"zipCode":"00123","countryCode":"France"},"representative":{"poaCode":"002"},"receivedDate":"2013-01-14T08:51:25-06:00","actionedDate":"2013-01-14T08:51:25-06:00","status":"New","declinedReason":null,"consentAddressChange":true,"recordConsent":true}}],"meta":{"pagination":{"pageNumber":1,"pageSize":10,"pages":1,"records":3}}},"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["power-of-attorney-request"]},"attributes":{"type":"object","required":["veteran","claimant","representative"],"properties":{"veteran":{"type":"object","properties":{"firstName":{"description":"First name for the veteran.","type":"string"},"lastName":{"description":"Last name for the veteran.","type":"string"},"middleName":{"description":"Middle name for the veteran.","type":"string"}}},"claimant":{"type":"object","properties":{"firstName":{"description":"First name for the dependent claimant.","type":"string"},"lastName":{"description":"Last name for the dependent claimant.","type":"string"},"middleName":{"description":"Middle name for the dependent claimant.","type":"string"}}},"address":{"city":{"type":"string"},"country":{"type":"string"},"militaryPo":{"type":"string"},"militaryPostalCode":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"representative":{"type":"object","properties":{"poaCode":{"type":"string"},"vsoUserEmail":{"type":"string"},"vsoUserFirstName":{"type":"string"},"vsoUserLastName":{"type":"string"}}},"receivedDate":{"description":"Date the request for representation was established.","type":"string","format":"date-time"},"actionedDate":{"description":"Date the request for representation was accepted or declined by a representative.","type":"string","format":"date-time"},"status":{"description":"Status of the request for representation.","type":"string"},"declinedReason":{"description":"Reason for declining the request for representation.","type":"string"},"consentAddressChange":{"description":"Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.","type":"boolean","enum":[true,false]},"recordConsent":{"description":"Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C.","type":"boolean","enum":[true,false]}}}}}},"meta":{"type":"object","required":["pagination"],"properties":{"pagination":{"type":"object","required":["pageNumber","pageSize","pages","records"],"properties":{"pageNumber":{"description":"Current page number.","type":"integer"},"pageSize":{"description":"Number of results per page.","type":"integer"},"pages":{"description":"Total number of pages.","type":"integer"},"records":{"description":"Total number of records.","type":"integer"}}}}}}}}}},"400":{"description":"Invalid request","content":{"application/json":{"example":{"errors":[{"title":"Missing parameter","detail":"poaCodes is required and cannot be empty","code":"108","status":"400"}]},"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string"},"detail":{"type":"string"},"code":{"type":"string"},"status":{"type":"string","enum":["400"]}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","status"],"properties":{"title":{"type":"string","enum":["Not authorized"]},"detail":{"type":"string","enum":["Not authorized"]},"status":{"type":"string","enum":["401"]}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["attributes"],"properties":{"attributes":{"type":"object","additionalProperties":false,"required":["poaCodes"],"properties":{"poaCodes":{"type":"array","minItems":1,"items":{"type":"string","minLength":1}},"pageSize":{"type":"string"},"pageIndex":{"type":"string"},"filter":{"type":"object","additionalProperties":false,"properties":{"status":{"type":"array","items":{"type":"string","enum":["NEW","ACCEPTED","DECLINED"]}},"state":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"}}}}}}}},"example":{"data":{"attributes":{"poaCodes":["002","003","083"],"filter":{"status":["NEW","ACCEPTED","DECLINED"],"state":"OR","city":"Portland","country":"USA"}}}}}}},"required":true}}},"/veterans/power-of-attorney-requests/{id}":{"get":{"summary":"Retrieves a power of attorney request","tags":["Power of Attorney"],"operationId":"GET:/veterans/power-of-attorney-requests/{id}","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"description":"Retrieve a power of attorney request by id.","parameters":[{"name":"id","in":"path","required":true,"example":"00000000-0000-0000-0000-000000000010","description":"The ID of the Power of Attorney request","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response with a current Power of Attorney request","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000011","type":"power-of-attorney-request","attributes":{"veteran":{"firstName":"ANDREA","middleName":"L","lastName":"MITCHELL"},"claimant":{"firstName":null,"lastName":null},"address":{"city":"Portland","stateCode":"OR","zipCode":"56789","countryCode":"USA"},"representative":{"poaCode":"074"},"receivedDate":"2024-10-30T08:22:07-05:00","actionedDate":"2025-01-09T10:19:26-06:00","status":"Accepted","declinedReason":null,"consentAddressChange":true,"recordConsent":true}}},"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["power-of-attorney-request"]},"attributes":{"type":"object","required":["veteran","claimant","representative"],"properties":{"veteran":{"type":"object","properties":{"firstName":{"description":"First name for the veteran.","type":"string"},"lastName":{"description":"Last name for the veteran.","type":"string"},"middleName":{"description":"Middle name for the veteran.","type":"string"}}},"claimant":{"type":"object","properties":{"firstName":{"description":"First name for the dependent claimant.","type":"string"},"lastName":{"description":"Last name for the dependent claimant.","type":"string"},"middleName":{"description":"Middle name for the dependent claimant.","type":"string"}}},"address":{"city":{"type":"string"},"country":{"type":"string"},"militaryPo":{"type":"string"},"militaryPostalCode":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"representative":{"type":"object","properties":{"poaCode":{"type":"string"},"vsoUserEmail":{"type":"string"},"vsoUserFirstName":{"type":"string"},"vsoUserLastName":{"type":"string"}}},"receivedDate":{"description":"Date the request for representation was established.","type":"string","format":"date-time"},"actionedDate":{"description":"Date the request for representation was accepted or declined by a representative.","type":"string","format":"date-time"},"status":{"description":"Status of the request for representation.","type":"string"},"declinedReason":{"description":"Reason for declining the request for representation.","type":"string"},"consentAddressChange":{"description":"Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.","type":"boolean","enum":[true,false]},"recordConsent":{"description":"Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C.","type":"boolean","enum":[true,false]}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","status"],"properties":{"title":{"type":"string","enum":["Not authorized"]},"detail":{"type":"string","enum":["Not authorized"]},"status":{"type":"string","enum":["401"]}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not find Power of Attorney Request with id: 12e13134-7229-4e44-90ae-bcea2a4525fa"}]},"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","status"],"properties":{"title":{"type":"string","enum":["Resource not found"]},"detail":{"type":"string"},"status":{"type":"string","enum":["404"]}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}},"/veterans/power-of-attorney-requests/{id}/decide":{"post":{"summary":"Submits representative decision for a power of attorney request","tags":["Power of Attorney"],"operationId":"POST:/veterans/power-of-attorney-requests/{id}/decide","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"description":"Approve or decline a power of attorney request. If approved, the power of attorney request will be submitted to VA. The claimant will be notified of the decision by email.","parameters":[{"name":"id","in":"path","required":true,"example":"00000000-0000-0000-0000-000000000012","description":"The ID of the request for representation","schema":{"type":"string"}}],"responses":{"200":{"description":"Submit decision","content":{"application/json":{"example":{"data":{"id":"5ff6a995-5b29-4819-91af-13f1bb312fg5","type":"power-of-attorney-request","attributes":{"veteran":{"firstName":"ANDREA","middleName":"L","lastName":"MITCHELL"},"claimant":{"firstName":null,"lastName":null},"address":{"city":"Portland","stateCode":"OR","zipCode":"56789","countryCode":"USA"},"representative":{"poaCode":"074"},"receivedDate":"2024-10-30T08:22:07-05:00","actionedDate":"2025-01-09T10:19:26-06:00","status":"Accepted","declinedReason":null,"consentAddressChange":true,"recordConsent":true}}},"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["power-of-attorney-request"]},"attributes":{"type":"object","required":["veteran","claimant","representative"],"properties":{"veteran":{"type":"object","properties":{"firstName":{"description":"First name for the veteran.","type":"string"},"lastName":{"description":"Last name for the veteran.","type":"string"},"middleName":{"description":"Middle name for the veteran.","type":"string"}}},"claimant":{"type":"object","properties":{"firstName":{"description":"First name for the dependent claimant.","type":"string"},"lastName":{"description":"Last name for the dependent claimant.","type":"string"},"middleName":{"description":"Middle name for the dependent claimant.","type":"string"}}},"address":{"city":{"type":"string"},"country":{"type":"string"},"militaryPo":{"type":"string"},"militaryPostalCode":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"representative":{"type":"object","properties":{"poaCode":{"type":"string"},"vsoUserEmail":{"type":"string"},"vsoUserFirstName":{"type":"string"},"vsoUserLastName":{"type":"string"}}},"receivedDate":{"description":"Date the request for representation was established.","type":"string","format":"date-time"},"actionedDate":{"description":"Date the request for representation was accepted or declined by a representative.","type":"string","format":"date-time"},"status":{"description":"Status of the request for representation.","type":"string"},"declinedReason":{"description":"Reason for declining the request for representation.","type":"string"},"consentAddressChange":{"description":"Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.","type":"boolean","enum":[true,false]},"recordConsent":{"description":"Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C.","type":"boolean","enum":[true,false]}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","enum":["Not authorized"]},"detail":{"type":"string","enum":["Not authorized"]},"status":{"type":"string","enum":["401"]}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not find Power of Attorney request with id: 348fa995-5b29-4819-91af-13f1bb3c7d77"}],"schema_validation_error":{"summary":"Schema validation error","value":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not find Power of Attorney request with id: 348fa995-5b29-4819-91af-13f1bb3c7d77"}]}}},"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","status"],"properties":{"title":{"type":"string","enum":["Resource not found"]},"detail":{"type":"string"},"status":{"type":"string","enum":["404"]}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Malformed request body","content":{"application/json":{"example":{"errors":[{"title":"Unprocessable entity","status":"422","detail":"The request body is not a valid JSON object: Hash/Object not terminated (after ) at line 1","source":{"pointer":" at line 1"}}]},"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","status"],"properties":{"title":{"type":"string"},"detail":{"type":"string"},"source":{"type":"object"},"status":{"type":"string","enum":["422"]}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Power Of Attorney Request Decision","type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["attributes"],"properties":{"attributes":{"type":"object","additionalProperties":false,"required":["decision","representativeId"],"properties":{"decision":{"type":"string","description":"The decision of the request.","enum":["ACCEPTED","DECLINED"]},"declinedReason":{"type":"string","description":"The reason for declining the request.","nullable":true},"representativeId":{"type":"string","description":"The unique identifier of the requestʼs representative."}}}}}},"example":{"data":{"attributes":{"decision":"ACCEPTED","representativeId":"12345678","declinedReason":null}}}}}},"required":true}}},"/veterans/{veteranId}/2122/validate":{"post":{"summary":"Validates request to establish an organization as a claimant’s accredited representative","tags":["Power of Attorney"],"operationId":"POST:/veterans/{veteranId}/2122/validate","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"description":"Validate a request to establish an organization with power of attorney (VA Form 21-22). Use POST\n/veterans/{veteranId}/2122 to automatically establish submit VA Form 21-22.\n","responses":{"200":{"description":"Valid request response","content":{"application/json":{"example":{"data":{"type":"form/21-22/validation","attributes":{"status":"valid"}}},"schema":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","description":"Says if submission of 21-22 would work with the given parameters","enum":["valid"]}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not find an Accredited Representative with registration number: 999999999999 and poa code: 083"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"errors":[{"title":"Unprocessable entity","detail":"The property /serviceOrganization did not contain the required key poaCode","status":"422","source":{"pointer":"data/attributes/serviceOrganization"}},{"title":"Unprocessable entity","detail":"The property /serviceOrganization did not contain the required key registrationNumber","status":"422","source":{"pointer":"data/attributes/serviceOrganization"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key veteran","status":"422","source":{"pointer":"data/attributes/"}},{"title":"Unprocessable entity","detail":"The property /serviceOrganization/withoutPoaCode is not defined on the schema. Additional properties are not allowed","status":"422","source":{"pointer":"data/attributes/serviceOrganization/withoutPoaCode"}}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes",null],"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 2122 Schema","type":"object","additionalProperties":false,"required":["veteran","serviceOrganization"],"properties":{"veteran":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"object","additionalProperties":false,"required":["addressLine1","city","stateCode","countryCode"],"properties":{"addressLine1":{"description":"Street number and name for the veteran's address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the veteran's address.","type":"string","maxLength":5},"city":{"description":"City for the veteran's address.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the veteran's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the veteran's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"US"},"zipCode":{"description":"Zip code (first 5 digits) for the veteran's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the veteran's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the veteran's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the veteran's phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the veteran.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the veteran.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":61,"example":"veteran@example.com"},"serviceNumber":{"description":"Service number for the veteran.","type":"string","pattern":"^\\d{9}?$","example":"123456789"},"insuranceNumber":{"type":"string","maxLength":60,"description":"Insurance number for the veteran, if applicable. Include letter prefix."}}},"claimant":{"description":"Include claimant information for dependent claimants.","type":"object","additionalProperties":false,"properties":{"claimantId":{"type":"string","example":"123456789","description":"Integration Control Number (ICN) for the dependent claimant."},"address":{"type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Street number and name for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the dependent claimant's address.","type":"string","maxLength":5},"city":{"description":"City for the dependent claimant's address. Required if claimant information provided.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"US"},"zipCode":{"description":"Zip code (first 5 digits) for the dependent claimant's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the dependent claimant's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"additionalProperties":{"type":"boolean"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the dependent claimant's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the dependent claimant's phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the dependent claimant.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the dependent claimant.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":30,"example":"claimant@example.com"},"relationship":{"description":"Relationship of claimant to the veteran. Required if claimant information provided.","type":"string","example":"Spouse"}}},"serviceOrganization":{"description":"Details of the Service Organization representing the veteran.","type":"object","additionalProperties":false,"required":["poaCode","registrationNumber"],"properties":{"poaCode":{"description":"The POA code of the organization.","type":"string","example":"A1Q"},"registrationNumber":{"description":"Registration Number of representative.","type":"string","example":"12345"},"jobTitle":{"description":"Job title of the representative.","type":"string","example":"Veteran Service representative"},"email":{"description":"Email address of the service organization or representative.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":61,"example":"veteran_representative@example.com"}}},"recordConsent":{"description":"Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C. Explicitly permits the designated representative to access sensitive medical records within VA. Setting 'recordConsent' to false will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"boolean"},"consentLimits":{"description":"Consent for the disclosure of records relating to treatment for drug abuse, alcoholism or alcohol abuse, infection with the human immunodeficiency virus (HIV), or sickle cell anemia is limited to this list. Including 'consentLimits' will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"array","items":{"type":"string","enum":["DRUG_ABUSE","ALCOHOLISM","HIV","SICKLE_CELL"]},"example":"DRUG_ABUSE"},"consentAddressChange":{"description":"Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.","type":"boolean"}}}}}},"example":{"data":{"attributes":{"veteran":{"address":{"addressLine1":"123","city":"city","stateCode":"OR","countryCode":"US","zipCode":"12345"}},"serviceOrganization":{"poaCode":"083","registrationNumber":"999999999999"}}}}}}},"required":true}}},"/veterans/{veteranId}/2122":{"post":{"summary":"Automatically establishes an organization as a claimant’s accredited representative (VA Form 21-22)","description":"Submit VA Form 21-22 to automatically establish a VA accredited organization with power of attorney\n(General POA).\n","tags":["Power of Attorney"],"operationId":"POST:/veterans/{veteranId}/2122","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"responses":{"202":{"description":"Valid request response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000013","type":"organization","attributes":{"code":"083","name":"083 - DISABLED AMERICAN VETERANS","phoneNumber":"555-555-5555"}}},"schema":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","description":"code for Power of attorney"},"phoneNumber":{"type":"string"},"name":{"type":"string"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not find an Accredited Representative with registration number: 999999999999 and poa code: 083"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"errors":[{"title":"Unprocessable entity","detail":"The property /serviceOrganization did not contain the required key poaCode","status":"422","source":{"pointer":"data/attributes/serviceOrganization"}},{"title":"Unprocessable entity","detail":"The property /serviceOrganization did not contain the required key registrationNumber","status":"422","source":{"pointer":"data/attributes/serviceOrganization"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key veteran","status":"422","source":{"pointer":"data/attributes/"}},{"title":"Unprocessable entity","detail":"The property /serviceOrganization/withoutPoaCode is not defined on the schema. Additional properties are not allowed","status":"422","source":{"pointer":"data/attributes/serviceOrganization/withoutPoaCode"}}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes",null],"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 2122 Schema","type":"object","additionalProperties":false,"required":["veteran","serviceOrganization"],"properties":{"veteran":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"object","additionalProperties":false,"required":["addressLine1","city","stateCode","countryCode"],"properties":{"addressLine1":{"description":"Street number and name for the veteran's address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the veteran's address.","type":"string","maxLength":5},"city":{"description":"City for the veteran's address.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the veteran's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the veteran's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"US"},"zipCode":{"description":"Zip code (first 5 digits) for the veteran's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the veteran's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the veteran's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the veteran's phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the veteran.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the veteran.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":61,"example":"veteran@example.com"},"serviceNumber":{"description":"Service number for the veteran.","type":"string","pattern":"^\\d{9}?$","example":"123456789"},"insuranceNumber":{"type":"string","maxLength":60,"description":"Insurance number for the veteran, if applicable. Include letter prefix."}}},"claimant":{"description":"Include claimant information for dependent claimants.","type":"object","additionalProperties":false,"properties":{"claimantId":{"type":"string","example":"123456789","description":"Integration Control Number (ICN) for the dependent claimant."},"address":{"type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Street number and name for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the dependent claimant's address.","type":"string","maxLength":5},"city":{"description":"City for the dependent claimant's address. Required if claimant information provided.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"US"},"zipCode":{"description":"Zip code (first 5 digits) for the dependent claimant's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the dependent claimant's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"additionalProperties":{"type":"boolean"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the dependent claimant's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the dependent claimant's phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the dependent claimant.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the dependent claimant.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":30,"example":"claimant@example.com"},"relationship":{"description":"Relationship of claimant to the veteran. Required if claimant information provided.","type":"string","example":"Spouse"}}},"serviceOrganization":{"description":"Details of the Service Organization representing the veteran.","type":"object","additionalProperties":false,"required":["poaCode","registrationNumber"],"properties":{"poaCode":{"description":"The POA code of the organization.","type":"string","example":"A1Q"},"registrationNumber":{"description":"Registration Number of representative.","type":"string","example":"12345"},"jobTitle":{"description":"Job title of the representative.","type":"string","example":"Veteran Service representative"},"email":{"description":"Email address of the service organization or representative.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":61,"example":"veteran_representative@example.com"}}},"recordConsent":{"description":"Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C. Explicitly permits the designated representative to access sensitive medical records within VA. Setting 'recordConsent' to false will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"boolean"},"consentLimits":{"description":"Consent for the disclosure of records relating to treatment for drug abuse, alcoholism or alcohol abuse, infection with the human immunodeficiency virus (HIV), or sickle cell anemia is limited to this list. Including 'consentLimits' will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"array","items":{"type":"string","enum":["DRUG_ABUSE","ALCOHOLISM","HIV","SICKLE_CELL"]},"example":"DRUG_ABUSE"},"consentAddressChange":{"description":"Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.","type":"boolean"}}}}}},"example":{"data":{"attributes":{"veteran":{"address":{"addressLine1":"123","city":"city","stateCode":"OR","countryCode":"US","zipCode":"12345"}},"serviceOrganization":{"poaCode":"083","registrationNumber":"999999999999"}}}}},"examples":{"POA for Veteran":{"value":{"data":{"attributes":{"veteran":{"address":{"addressLine1":"123","city":"city","stateCode":"OR","countryCode":"US","zipCode":"12345"}},"serviceOrganization":{"poaCode":"083","registrationNumber":"999999999999"}}}}},"POA for Dependent Claimant":{"value":{"data":{"attributes":{"veteran":{"address":{"addressLine1":"123","city":"city","stateCode":"OR","countryCode":"US","zipCode":"12345"}},"serviceOrganization":{"poaCode":"083","registrationNumber":"999999999999"},"claimant":{"claimantId":"1013093331V548481","address":{"addressLine1":"123 anystreet","city":"anytown","stateCode":"OR","countryCode":"US","zipCode":"12345"},"relationship":"Spouse"}}}}}}}},"required":true}}},"/veterans/{veteranId}/2122a/validate":{"post":{"summary":"Validates request to establish an individual as a claimant’s accredited representative (VA Form 21-22a)","tags":["Power of Attorney"],"operationId":"POST:/veterans/{veteranId}/2122a/validate","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"description":"Validate a request to establish an individual with power of attorney (VA Form 21-22a). Use POST\n/veterans/{veteranId}/2122a to automatically establish submit VA Form 21-22a.\n","responses":{"200":{"description":"Valid request response","content":{"application/json":{"example":{"data":{"type":"form/21-22a/validation","attributes":{"status":"valid"}}},"schema":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","description":"Says if submission of 21-22a would work with the given parameters","enum":["valid"]}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not find an Accredited Representative with registration number: 999999999999 and poa code: 067"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"errors":[{"title":"Unprocessable entity","detail":"The property /representative did not contain the required key poaCode","status":"422","source":{"pointer":"data/attributes/representative"}},{"title":"Unprocessable entity","detail":"The property /representative did not contain the required key registrationNumber","status":"422","source":{"pointer":"data/attributes/representative"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key veteran","status":"422","source":{"pointer":"data/attributes/"}}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes",null],"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 2122a Schema","type":"object","additionalProperties":false,"required":["veteran","representative"],"properties":{"veteran":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"serviceNumber":{"description":"Service number for the veteran.","type":"string","maxLength":9},"serviceBranch":{"description":"Service Branch for the veteran.","type":"string","enum":["AIR_FORCE","ARMY","COAST_GUARD","MARINE_CORPS","NAVY","SPACE_FORCE","OTHER"],"example":"ARMY"},"serviceBranchOther":{"description":"For a 'service branch' of value 'other', please provide the service branch name.","type":"string","maxLength":27,"example":"Air National Guard"},"address":{"type":"object","additionalProperties":false,"required":["addressLine1","city","stateCode","countryCode"],"properties":{"addressLine1":{"description":"Street number and name for the veteran's address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the veteran's address.","type":"string","maxLength":5},"city":{"description":"City for the veteran's address.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the veteran's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the veteran's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"US"},"zipCode":{"description":"Zip code (first 5 digits) for the veteran's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the veteran's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the veteran's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the veteran's phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the veteran.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the veteran.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":61,"example":"veteran@example.com"}}},"claimant":{"description":"Include claimant information for dependent claimants.","type":"object","additionalProperties":false,"properties":{"claimantId":{"type":"string","example":"123456789","description":"Integration Control Number (ICN) for the dependent claimant."},"address":{"type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Street number and name for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the dependent claimant's address.","type":"string","maxLength":5},"city":{"description":"City for the dependent claimant's address. Required if claimant information provided.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"USA"},"zipCode":{"description":"Zip code (first 5 digits) for the dependent claimant's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the dependent claimant's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the dependent claimant's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the dependent claimant's phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the dependent claimant.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the dependent claimant.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":30,"example":"claimant@example.com"},"relationship":{"description":"Relationship of claimant to the veteran. Required if claimant information provided.","type":"string","example":"Spouse"}}},"representative":{"description":"Details of the individual representative representing the veteran.","type":"object","additionalProperties":false,"required":["poaCode","registrationNumber","type"],"properties":{"poaCode":{"description":"The POA code of the representative.","type":"string","example":"A1Q"},"registrationNumber":{"description":"Registration Number of representative.","type":"string","example":"12345"},"type":{"description":"Type of individual representative","type":"string","enum":["ATTORNEY","AGENT"],"example":"ATTORNEY"},"address":{"type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Street number and name for the representative's address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the representative's address.","type":"string","maxLength":5},"city":{"description":"City for the representative's address.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the representative's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the representative's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"US"},"zipCode":{"description":"Zip code (first 5 digits) for the representative's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the representative's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}}}},"recordConsent":{"description":"Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C. Explicitly permits the designated representative to access sensitive medical records within VA. Setting 'recordConsent' to false will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"boolean"},"consentLimits":{"description":"Consent for the disclosure of records relating to treatment for drug abuse, alcoholism or alcohol abuse, infection with the human immunodeficiency virus (HIV), or sickle cell anemia is limited to this list. Including 'consentLimits' will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"array","items":{"type":"string","enum":["DRUG_ABUSE","ALCOHOLISM","HIV","SICKLE_CELL"]},"example":"DRUG ABUSE"},"consentAddressChange":{"description":"Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.","type":"boolean"},"conditionsOfAppointment":{"description":"If the individual named in Item 15A is an accredited agent or attorney, the scope of representation provided before VA may be limited by the agent or attorney as indicated below in Item 23","type":"array","items":{"type":"string"}}}}}}},"example":{"data":{"attributes":{"veteran":{"address":{"addressLine1":"123","addressLine2":"2a","city":"city","countryCode":"US","stateCode":"OR","zipCode":"12345","zipCodeSuffix":"6789"}},"representative":{"poaCode":"067","registrationNumber":"999999999999","type":"ATTORNEY","address":{"addressLine1":"123","addressLine2":"2a","city":"city","countryCode":"US","stateCode":"OR","zipCode":"12345","zipCodeSuffix":"6789"}}}}}}}},"required":true}}},"/veterans/{veteranId}/2122a":{"post":{"summary":"Automatically establishes an individual as a claimant’s accredited representative (VA Form 21-22a)","tags":["Power of Attorney"],"operationId":"POST:/veterans/{veteranId}/2122a","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}}],"description":"Submit VA Form 21-22 to automatically establish a VA accredited individual with power of attorney (General POA).\n","responses":{"202":{"description":"Valid request response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000014","type":"individual","attributes":{"code":"067","name":"Firstname Lastname","phoneNumber":"555-555-5555"}}},"schema":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["type","attributes"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","description":"code for Power of attorney"},"phoneNumber":{"type":"string"},"name":{"type":"string"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not find an Accredited Representative with registration number: 999999999999 and poa code: 067"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"errors":[{"title":"Unprocessable entity","detail":"The property /representative did not contain the required key poaCode","status":"422","source":{"pointer":"data/attributes/representative"}},{"title":"Unprocessable entity","detail":"The property /representative did not contain the required key registrationNumber","status":"422","source":{"pointer":"data/attributes/representative"}},{"title":"Unprocessable entity","detail":"The property / did not contain the required key veteran","status":"422","source":{"pointer":"data/attributes/"}}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["attributes",null],"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 2122a Schema","type":"object","additionalProperties":false,"required":["veteran","representative"],"properties":{"veteran":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"serviceNumber":{"description":"Service number for the veteran.","type":"string","maxLength":9},"serviceBranch":{"description":"Service Branch for the veteran.","type":"string","enum":["AIR_FORCE","ARMY","COAST_GUARD","MARINE_CORPS","NAVY","SPACE_FORCE","OTHER"],"example":"ARMY"},"serviceBranchOther":{"description":"For a 'service branch' of value 'other', please provide the service branch name.","type":"string","maxLength":27,"example":"Air National Guard"},"address":{"type":"object","additionalProperties":false,"required":["addressLine1","city","stateCode","countryCode"],"properties":{"addressLine1":{"description":"Street number and name for the veteran's address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the veteran's address.","type":"string","maxLength":5},"city":{"description":"City for the veteran's address.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the veteran's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the veteran's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"US"},"zipCode":{"description":"Zip code (first 5 digits) for the veteran's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the veteran's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the veteran's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the veteran's phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the veteran.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the veteran.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":61,"example":"veteran@example.com"}}},"claimant":{"description":"Include claimant information for dependent claimants.","type":"object","additionalProperties":false,"properties":{"claimantId":{"type":"string","example":"123456789","description":"Integration Control Number (ICN) for the dependent claimant."},"address":{"type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Street number and name for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the dependent claimant's address.","type":"string","maxLength":5},"city":{"description":"City for the dependent claimant's address. Required if claimant information provided.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the dependent claimant's address. Required if claimant information provided.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"USA"},"zipCode":{"description":"Zip code (first 5 digits) for the dependent claimant's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the dependent claimant's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}},"phone":{"$comment":"the phone fields must not exceed 20 chars, when concatenated","type":"object","additionalProperties":false,"required":["phoneNumber"],"properties":{"countryCode":{"description":"Country code for the dependent claimant's phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code for the dependent claimant's phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[0-9]{1,5}$","example":"555"},"phoneNumber":{"description":"Phone number for the dependent claimant.","type":"string","pattern":"^\\d(?:[- ]?\\d){0,14}$","example":"5555555","minLength":1,"maxLength":23}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address for the dependent claimant.","type":"string","pattern":"^(?!.*\\s).+@.+\\..+|^$","maxLength":30,"example":"claimant@example.com"},"relationship":{"description":"Relationship of claimant to the veteran. Required if claimant information provided.","type":"string","example":"Spouse"}}},"representative":{"description":"Details of the individual representative representing the veteran.","type":"object","additionalProperties":false,"required":["poaCode","registrationNumber","type"],"properties":{"poaCode":{"description":"The POA code of the representative.","type":"string","example":"A1Q"},"registrationNumber":{"description":"Registration Number of representative.","type":"string","example":"12345"},"type":{"description":"Type of individual representative","type":"string","enum":["ATTORNEY","AGENT"],"example":"ATTORNEY"},"address":{"type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Street number and name for the representative's address.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"addressLine2":{"description":"Apartment or unit number for the representative's address.","type":"string","maxLength":5},"city":{"description":"City for the representative's address.","type":"string","example":"Portland","maxLength":18},"stateCode":{"description":"State abbreviation for the representative's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"},"countryCode":{"description":"Two-letter country code for the representative's address.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"US"},"zipCode":{"description":"Zip code (first 5 digits) for the representative's address. Required if 'countryCode' is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipCodeSuffix":{"description":"Zip code suffix (last 4 digits) for the representative's address.","type":"string","pattern":"^\\d{4}?$","example":"6789"}}}}},"recordConsent":{"description":"Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C. Explicitly permits the designated representative to access sensitive medical records within VA. Setting 'recordConsent' to false will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"boolean"},"consentLimits":{"description":"Consent for the disclosure of records relating to treatment for drug abuse, alcoholism or alcohol abuse, infection with the human immunodeficiency virus (HIV), or sickle cell anemia is limited to this list. Including 'consentLimits' will prevent the designated representative from accessing the claimant's documents in VBMS.","type":"array","items":{"type":"string","enum":["DRUG_ABUSE","ALCOHOLISM","HIV","SICKLE_CELL"]},"example":"DRUG ABUSE"},"consentAddressChange":{"description":"Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.","type":"boolean"},"conditionsOfAppointment":{"description":"If the individual named in Item 15A is an accredited agent or attorney, the scope of representation provided before VA may be limited by the agent or attorney as indicated below in Item 23","type":"array","items":{"type":"string"}}}}}}},"example":{"data":{"attributes":{"veteran":{"address":{"addressLine1":"123","addressLine2":"2a","city":"city","countryCode":"US","stateCode":"OR","zipCode":"12345","zipCodeSuffix":"6789"}},"representative":{"poaCode":"067","registrationNumber":"999999999999","type":"ATTORNEY","address":{"addressLine1":"123","addressLine2":"2a","city":"city","countryCode":"US","stateCode":"OR","zipCode":"12345","zipCodeSuffix":"6789"}}}}}},"examples":{"POA for Veteran":{"value":{"data":{"attributes":{"veteran":{"address":{"addressLine1":"123","addressLine2":"2a","city":"city","countryCode":"US","stateCode":"OR","zipCode":"12345","zipCodeSuffix":"6789"}},"representative":{"poaCode":"067","registrationNumber":"999999999999","type":"ATTORNEY","address":{"addressLine1":"123","addressLine2":"2a","city":"city","countryCode":"US","stateCode":"OR","zipCode":"12345","zipCodeSuffix":"6789"}}}}}},"POA for Dependent Claimant":{"value":{"data":{"attributes":{"veteran":{"address":{"addressLine1":"123","addressLine2":"2a","city":"city","countryCode":"US","stateCode":"OR","zipCode":"12345","zipCodeSuffix":"6789"}},"representative":{"poaCode":"067","registrationNumber":"999999999999","type":"ATTORNEY","address":{"addressLine1":"123","addressLine2":"2a","city":"city","countryCode":"US","stateCode":"OR","zipCode":"12345","zipCodeSuffix":"6789"}},"claimant":{"claimantId":"1013093331V548481","address":{"addressLine1":"123 anystreet","city":"anytown","stateCode":"OR","countryCode":"US","zipCode":"12345"},"relationship":"Spouse"}}}}}}}},"required":true}}},"/veterans/{veteranId}/power-of-attorney/{id}":{"get":{"summary":"Checks status of power of attorney submission (VA Forms 21-22 or 21-22a)","description":"Check the submissions status of a request to appoint power of attorney (VA Forms 21-22 or 21-22a).","tags":["Power of Attorney"],"operationId":"GET:/veterans/{veteranId}/power-of-attorney/{id}","security":[{"productionOauth":["system/claim.read","system/claim.write"]},{"sandboxOauth":["system/claim.read","system/claim.write"]},{"bearer_token":[]}],"parameters":[{"name":"veteranId","in":"path","required":true,"example":"1012667145V762142","description":"ID of claimant","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"example":"00000000-0000-0000-0000-000000000015","description":"The ID of the 21-22 submission","schema":{"type":"string"}}],"responses":{"200":{"description":"Valid request response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000016","type":"claimsApiPowerOfAttorneys","attributes":{"createdAt":"2024-01-01 00:00:00 UTC","representative":{"poaCode":"074"},"status":"pending","errors":[],"steps":[{"type":"PDF_SUBMISSION","status":"NOT_STARTED","completedAt":null,"nextStep":"POA_UPDATE"},{"type":"POA_UPDATE","status":"NOT_STARTED","completedAt":null,"nextStep":"POA_ACCESS_UPDATE"},{"type":"POA_ACCESS_UPDATE","status":"NOT_STARTED","completedAt":null,"nextStep":"CLAIMANT_NOTIFICATION"},{"type":"CLAIMANT_NOTIFICATION","status":"NOT_STARTED","completedAt":null,"nextStep":null}]}}},"schema":{"$schema":"http://json-schema.org/draft-04/schema#","type":"object","required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Power of Attorney Submission UUID"},"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["status","createdAt","representative"],"properties":{"status":{"type":"string","description":"Says if the power of attorney is pending, submitted, updated or errored","enum":["pending","submitted","updated","errored"]},"createdAt":{"type":"string","description":"Date request was first accepted","format":"date"},"errors":{"type":"array","description":"Error details if applicable","items":{"type":"object","additionalProperties":false,"properties":{"title":{"type":"string"},"detail":{"type":"string"},"code":{"type":"string","enum":["PDF_SUBMISSION","POA_UPDATE","POA_ACCESS_UPDATE","CLAIMANT_NOTIFICATION"]}}}},"steps":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["PDF_SUBMISSION","POA_UPDATE","POA_ACCESS_UPDATE","CLAIMANT_NOTIFICATION"]},"status":{"type":"string","enum":["NOT_STARTED","IN_PROGRESS","SUCCESS","FAILED"]},"completedAt":{"type":"string","format":"date"},"nextStep":{"type":"string","enum":["POA_UPDATE","POA_ACCESS_UPDATE","CLAIMANT_NOTIFICATION"]}}}},"representative":{"type":"object","additionalProperties":false,"required":["poaCode"],"properties":{"poaCode":{"type":"string","description":"Power of Attorney Code submitted for Veteran"}}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","status":"401","detail":"Not authorized"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"status":"404","title":"Resource not found","detail":"Could not find Power of Attorney with id: -1"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"status":{"type":"string","description":"HTTP error status code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}}},"servers":[{"url":"https://sandbox-api.va.gov/services/claims/{version}/","description":"Sandbox","variables":{"version":{"default":"v2"}}},{"url":"https://api.va.gov/services/claims/{version}/","description":"Production","variables":{"version":{"default":"v2"}}}]}