{"openapi":"3.0.1","info":{"title":"Benefits Claims","version":"v1","termsOfService":"https://developer.va.gov/terms-of-service","description":"This API automatically establishes and submits these VA forms.\n| Form number       | Form name     | Description     |\n| :------------- | :----------: | -----------: |\n| [21-526EZ](https://www.va.gov/find-forms/about-form-21-526ez/) | Application for Disability Compensation and Related Compensation Benefits | Used to apply for VA disability compensation and related benefits. |\n| [21-0966](https://www.va.gov/find-forms/about-form-21-0966/) | Intent to File a Claim for Compensation and/or Pension, or Survivors Pension and/or DIC | Submits an intent to file to secure the earliest possible effective date for any retroactive payments. |\n| [21-22](https://www.va.gov/find-forms/about-form-21-22/) | Appointment of Veterans Service Organization as Claimant's Representative | Used to assign a Veterans Service Organization as a POA to help a Veteran or dependent with benefits or claims. |\n| [21-22a](https://www.va.gov/find-forms/about-form-21-22a/) | Appointment of Individual As Claimant's Representative | Used to assign an individual as a POA to help a Veteran with benefits or claims. |\n\nIt also lets claimants or their authorized representatives:\n - Digitally submit supporting documentation for disability compensation claims.\n - Retrieve information such as status for any claim, including pension and burial.\n - Retrieve power of attorney (POA) status for individuals and Veterans Service Organizations (VSOs).\n - Retrieve intent to file status.\n\n## Background\nThe Benefits Claims API offers faster establishment and enhanced reporting for several VA claims and forms. Using this API provides many benefits, such as:\n\n - Automatic claim and POA establishment.\n - Direct establishment of disability compensation claims in Veterans Benefits Management System (VBMS) to avoid unnecessary manual processing and entry by Veteran Service Representatives (VSRs).\n - Faster claims processing by several days.\n - End-to-end claims status and result tracking by claim ID.\n\nForms not supported by the Benefits Claims API are submitted using the [Benefits Intake API](https://developer.va.gov/explore/benefits/docs/benefits?version=current), which places uploaded PDFs into the Centralized Mail Portal to be manually processed.\n\n## Appointing an accredited representative for dependents\nDependents of Veterans, such as spouses, children (biological and step), and parents (biological and foster) may be eligible 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 representative 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 representative is being appointed, the dependentʼs relationship to the Veteran will be validated first. The representative will be appointed to the dependent, not the Veteran.\n\n## Technical Overview\nThis API accepts a payload of requests and responses on a per-form basis, with the payload identifying the form and claimant. Trackable responses provide a unique ID which is used with the appropriate GET endpoint to track a submission’s processing status.\n\n### Attachment and file size limits\nThere is no limit on the number of files a payload can contain, but size limits do apply.\n - Uploaded documents cannot be larger than 11\" x 11\"\n - The entire payload cannot exceed 100 MB\n - No single file in a payload can exceed 25 MB\n\n### Authentication and authorization\nTo make an API request, follow our [authentication process](https://developer.va.gov/explore/api/benefits-claims/authorization-code) to receive an [OAuth token](https://oauth.net/2/).\n\n#### Representative authorization\nRepresentatives seeking authorization for a claimant must first [authenticate](https://developer.va.gov/explore/api/benefits-claims/authorization-code) and then pass the claimant’s information in the right header:\n - SSN in X-VA-SSN\n - First name in X-VA-First-Name\n - Last name in X-VA-Last-Name\n - Date of birth in X-VA-Birth-Date\n\nOmitting the information will cause the API to treat the representative as the claimant.\n\n#### Claimant authorization\nClaimants seeking authorization do not need to include headers such as X-VA-First-Name since the token authentication via ID.me, MyHealtheVet, or DSLogon provides this information.\n\n### POA Codes\nVeteran representatives receive their organization’s POA code. If they are the assigned POA for a claimant, that claimant will have a matching POA code. When a claim is submitted, this API verifies that the representative and claimant codes match against each other and the codes in the [Office of General Council (OGC) Database](https://www.va.gov/ogc/apps/accreditation/index.asp).\n\nUse the [Power of Attorney endpoint](#operations-Power_of_Attorney-post2122) to assign or update POA status. A newly appointed representative may not be able to submit forms for a claimant until a day after their POA code is first associated with the OGC data set.\n\n### Test data for sandbox environment use\n[Test data](https://developer.va.gov/explore/api/benefits-claims/test-users/2671/f1097c9772b447bb755b26dcd3e652aecad632389a28f0e19a7ebb082808db39) is used for all forms in the sandbox environment and for 21-526 submissions in the staging environment.\n\n### Claim and form processing\nClaims and forms are first submitted by this API and then established in VBMS. A 200 response means only that your claim or form was submitted successfully. To see if your submission is processed or has reached VBMS, you must check its status using the appropriate GET endpoint and the ID returned with your submission response.\n\nA “claim established” status means the claim has reached VBMS. In sandbox, submissions can take over an hour to reach “claim established” status. In production, this may take over two days.\n"},"tags":[{"name":"Claims","description":"Allows authenticated and authorized users to access claims data for a single claim by ID, or for all claims based on claimant data. No data is returned if the user is not authenticated and authorized.\n"},{"name":"Disability","description":"Used for 526 claims."},{"name":"Intent to File","description":"Used for 0966 submissions."},{"name":"Power of Attorney","description":"Used for 21-22 and 21-22a form submissions."}],"components":{"securitySchemes":{"bearer_token":{"type":"http","scheme":"bearer"},"productionOauth":{"type":"oauth2","description":"This API uses OAuth 2 with the authorization code grant flow. [More info](https://developer.va.gov/explore/api/benefits-claims/authorization-code)","flows":{"authorizationCode":{"authorizationUrl":"https://api.va.gov/oauth2/authorization","tokenUrl":"https://api.va.gov/oauth2/token","scopes":{"claim.read":"Retrieve claim data","claim.write":"Submit claim data"}}}},"sandboxOauth":{"type":"oauth2","description":"This API uses OAuth 2 with the authorization code grant flow. [More info](https://developer.va.gov/explore/api/benefits-claims/authorization-code)","flows":{"authorizationCode":{"authorizationUrl":"https://sandbox-api.va.gov/oauth2/authorization","tokenUrl":"https://sandbox-api.va.gov/oauth2/token","scopes":{"claim.read":"Retrieve claim data","claim.write":"Submit claim data"}}}}}},"paths":{"/forms/0966":{"get":{"summary":"Get 0966 JSON Schema for form.","deprecated":true,"tags":["Intent to File"],"operationId":"GET:/forms/0966","description":"Returns a single 0966 JSON schema to auto generate a form.","responses":{"200":{"description":"schema response","content":{"application/json":{"example":{"data":[{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 0966 Schema","type":"object","additionalProperties":false,"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 \"burial\" and include claimant_ssn or participant_claimant_id to identify the surviving dependent of the Veteran.","enum":["compensation","pension","burial"]},"participant_claimant_id":{"type":"string","example":"123456789","description":"Participant ID of the Claimant."},"participant_vet_id":{"type":"string","example":"987654321","description":"Participant ID of the Veteran."},"received_date":{"type":"string","example":"2015-01-05T17:42:12.058Z","format":"datetime"},"claimant_ssn":{"type":"string","example":"123456789","description":"SSN of the Claimant."}}}]}}}},"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"}}}}}}},"post":{"summary":"Submit form 0966 Intent to File.","tags":["Intent to File"],"operationId":"POST:/forms/0966","security":[{"productionOauth":["claim.read","claim.write"]},{"sandboxOauth":["claim.read","claim.write"]},{"bearer_token":[]}],"description":"Establishes an intent to file for disability compensation, burial, or pension claims.\n","parameters":[{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"0966 Response","content":{"application/json":{"example":{"data":{"id":"294045","type":"intent_to_file","attributes":{"creation_date":"2025-02-07T09:17:18-06:00","expiration_date":"2026-02-07T07:12:40-06:00","type":"compensation","status":"duplicate"}}},"schema":{"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Intent to File ID from EVSS"},"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["creation_date","expiration_date","type","status"],"properties":{"creation_date":{"type":"string","format":"date","description":"Date the Intent to File was received at the VA"},"expiration_date":{"type":"string","format":"date","description":"Date the ITF expires, this is 1 year from the created_date"},"type":{"type":"string","description":"The type of ITF filed. Compensation, Pension, or Burial","enum":["compensation","burial","pension"]},"status":{"type":"string","description":"The status of the Intent to File","enum":["active","duplicate"]}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"errors":[{"title":"Forbidden","detail":"Veteran cannot file for type 'burial'","code":"403","status":"403"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":[{"status":422,"detail":"The property /type did not match the following requirements: {\"type\"=>\"string\", \"example\"=>\"compensation\", \"description\"=>\"For an Intent to File for Survivor's Pension of Dependency and Indemnity Compensation(DIC), use type \\\"burial\\\" and include claimant_ssn or participant_claimant_id to identify the surviving dependent of the Veteran.\", \"enum\"=>[\"compensation\", \"pension\", \"burial\"]}","source":"/type"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["status","detail","source"],"properties":{"status":{"type":"integer","description":"HTTP error code"},"detail":{"type":"string","description":"HTTP error detail"},"source":{"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"],"example":{"type":"form/0966","attributes":{"type":"compensation"}},"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 0966 Schema","type":"object","additionalProperties":false,"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 \"burial\" and include claimant_ssn or participant_claimant_id to identify the surviving dependent of the Veteran.","enum":["compensation","pension","burial"]},"participant_claimant_id":{"type":"string","example":"123456789","description":"Participant ID of the Claimant."},"participant_vet_id":{"type":"string","example":"987654321","description":"Participant ID of the Veteran."},"received_date":{"type":"string","example":"2015-01-05T17:42:12.058Z","format":"datetime"},"claimant_ssn":{"type":"string","example":"123456789","description":"SSN of the Claimant."}}}}}}}}},"required":true}}},"/forms/0966/active":{"get":{"summary":"Returns last active 0966 Intent to File form submission.","tags":["Intent to File"],"operationId":"GET:/forms/0966/active","security":[{"productionOauth":["claim.read"]},{"sandboxOauth":["claim.read"]},{"bearer_token":[]}],"description":"Returns the last active 0966 form for a Veteran.","parameters":[{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}},{"name":"type","in":"query","description":"The type of 0966 you wish to get the active submission for.","example":"compensation","schema":{"type":"string"}}],"responses":{"200":{"description":"0966 response","content":{"application/json":{"example":{"data":{"id":"183042","type":"intent_to_file","attributes":{"creation_date":"2020-06-05T11:24:28-05:00","expiration_date":"2021-06-05T11:24:28-05:00","type":"compensation","status":"active"}}},"schema":{"required":["data"],"properties":{"data":{"type":"object","additionalProperties":false,"required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"Intent to File ID from EVSS"},"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["expiration_date","type","status"],"properties":{"creation_date":{"type":"string","nullable":true,"format":"date","description":"Date the Intent to File was received at the VA"},"expiration_date":{"type":"string","format":"date","description":"Date the ITF expires, this is 1 year from the created_date"},"type":{"type":"string","description":"The type of ITF filed. Compensation, Pension, or Burial","enum":["compensation","burial","pension"]},"status":{"type":"string","description":"The status of the Intent to File","enum":["active","inactive"]}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"No Intent to file is on record for WESLEY FORD of type compensation","code":"404","status":"404"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":"Must include either compensation, pension or burial as a 'type' parameter.","code":"422","status":"422"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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"}}}}}}}},"/forms/0966/validate":{"post":{"summary":"Test the 0966 Intent to File form submission.","deprecated":true,"tags":["Intent to File"],"operationId":"POST:/forms/0966/validate","security":[{"productionOauth":["claim.read","claim.write"]},{"sandboxOauth":["claim.read","claim.write"]},{"bearer_token":[]}],"description":"Test to ensure the form submission works with your parameters.\nSubmission is validated against the GET /forms/0966 schema.\n","parameters":[{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"0966 Response","content":{"application/json":{"example":{"data":{"type":"intentToFileValidation","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"]}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"413":{"description":"Payload too large","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"Request size limit exceeded"}}}}},"422":{"description":"Unprocessable","content":{"application/json":{"example":{"errors":[{"status":422,"detail":"The property / did not contain the required key type","source":"/"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["status","detail","source"],"properties":{"status":{"type":"integer","description":"HTTP error code"},"detail":{"type":"string","description":"HTTP error detail"},"source":{"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"],"example":{"type":"form/0966","attributes":{"type":"compensation"}},"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 0966 Schema","type":"object","additionalProperties":false,"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 \"burial\" and include claimant_ssn or participant_claimant_id to identify the surviving dependent of the Veteran.","enum":["compensation","pension","burial"]},"participant_claimant_id":{"type":"string","example":"123456789","description":"Participant ID of the Claimant."},"participant_vet_id":{"type":"string","example":"987654321","description":"Participant ID of the Veteran."},"received_date":{"type":"string","example":"2015-01-05T17:42:12.058Z","format":"datetime"},"claimant_ssn":{"type":"string","example":"123456789","description":"SSN of the Claimant."}}}}}}}}},"required":true}}},"/forms/2122":{"get":{"summary":"Gets schema for POA form.","deprecated":true,"tags":["Power of Attorney"],"operationId":"GET:/forms/2122","description":"Returns schema to automatically generate a POA form.","responses":{"200":{"description":"schema response","content":{"application/json":{"example":{"data":[{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 2122 Schema","type":"object","additionalProperties":false,"required":["serviceOrganization"],"properties":{"veteran":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"object","additionalProperties":false,"required":["numberAndStreet","city","country"],"allOf":[{"if":{"properties":{"country":{"const":"US"}}},"then":{"required":["zipFirstFive"]}}],"properties":{"numberAndStreet":{"description":"Street address with number and name.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"aptUnitNumber":{"oneOf":[{"type":"integer"},{"type":"string"}]},"city":{"description":"City for the address.","type":"string","example":"Portland"},"state":{"description":"State or province for the address.","type":"string","example":"OR"},"country":{"description":"Country of the address.","type":"string","example":"US"},"zipFirstFive":{"description":"Zip code (First 5 digits) of the address. Required if country is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zip code (Last 4 digits) of the 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 of the phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code of the phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[2-9][0-9]{2}$","example":"555"},"phoneNumber":{"description":"Phone number.","type":"string","pattern":"^[0-9]{1,14}$","example":"5555555"},"phoneNumberExt":{"type":"string","pattern":"^[a-zA-Z0-9]{1,10}$"}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address of the veteran.","type":"string","pattern":".@.","maxLength":61,"example":"veteran@example.com"},"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":50,"example":"Air National Guard"}}},"claimant":{"type":"object","additionalProperties":false,"required":["firstName","lastName","address","relationship"],"properties":{"firstName":{"description":"First name of Claimant.","type":"string","example":"John"},"middleInitial":{"description":"Middle initial of Claimant.","type":"string","example":"M"},"lastName":{"description":"Last name of Claimant.","type":"string","example":"Dow"},"address":{"type":"object","additionalProperties":false,"required":["numberAndStreet","city","country"],"allOf":[{"if":{"properties":{"country":{"const":"US"}}},"then":{"required":["zipFirstFive"]}}],"properties":{"numberAndStreet":{"description":"Street address with number and name.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"aptUnitNumber":{"oneOf":[{"type":"integer"},{"type":"string"}]},"city":{"description":"City for the address.","type":"string","example":"Portland"},"state":{"description":"State or province for the address.","type":"string","example":"OR"},"country":{"description":"Country of the address.","type":"string","example":"US"},"zipFirstFive":{"description":"Zip code (First 5 digits) of the address. Required if country is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zip code (Last 4 digits) of the 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 of the phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code of the phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[2-9][0-9]{2}$","example":"555"},"phoneNumber":{"description":"Phone number.","type":"string","pattern":"^[0-9]{1,14}$","example":"5555555"},"phoneNumberExt":{"type":"string","pattern":"^[a-zA-Z0-9]{1,10}$"}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address of the claimant.","type":"string","pattern":".@.","maxLength":61,"example":"claimant@example.com"},"relationship":{"description":"Relationship of claimant to the veteran.","type":"string","example":"Spouse"}}},"serviceOrganization":{"description":"Details of the service organization or individual representing the veteran.","type":"object","additionalProperties":false,"required":["poaCode"],"properties":{"poaCode":{"description":"The POA code of the organization or individual representative","type":"string","example":"A1Q"},"organizationName":{"description":"Name of the service organization.","type":"string","example":"I help vets LLC."},"firstName":{"description":"First Name of the representative","type":"string","example":"John"},"lastName":{"description":"Last Name of the representative","type":"string","example":"Doe"},"jobTitle":{"description":"Job title of the representative","type":"string","example":"Veteran Service representative"},"address":{"type":"object","description":"address details for an individual representative","additionalProperties":false,"required":["numberAndStreet","city","country"],"allOf":[{"if":{"properties":{"country":{"const":"US"}}},"then":{"required":["zipFirstFive"]}}],"properties":{"numberAndStreet":{"description":"Street address with number and name.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"aptUnitNumber":{"oneOf":[{"type":"integer"},{"type":"string"}]},"city":{"description":"City for the address.","type":"string","example":"Portland"},"state":{"description":"State or province for the address.","type":"string","example":"OR"},"country":{"description":"Country of the address.","type":"string","example":"US"},"zipFirstFive":{"description":"Zip code (First 5 digits) of the address. Required if country is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zip code (Last 4 digits) of the address.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"additionalProperties":{"type":"boolean"}}},"email":{"description":"Email address of the service organization or representative.","type":"string","pattern":".@.","maxLength":61,"example":"veteran_representative@example.com"},"appointmentDate":{"description":"Date of appointment with Veteran.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"}}},"recordConsent":{"description":"AUTHORIZATION FOR REPRESENTATIVE'S ACCESS TO RECORDS PROTECTED BY SECTION 7332, TITLE 38, U.S.C.","type":"boolean"},"consentLimits":{"description":"Consent in Item 19 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 as follows.","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"},"signatures":{"type":"object","additionalProperties":false,"required":["veteran","representative"],"properties":{"veteran":{"description":"Base64 encoded png image of the veteran or claimant signature.","title":"Signature of the Veteran","type":"string"},"representative":{"description":"Base64 encoded png image of the representative signature.","title":"Signature of the Veteran Representative","type":"string"}}}}}]}}}},"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"}}}}}}},"post":{"summary":"Submit a POA form.","tags":["Power of Attorney"],"operationId":"POST:/forms/2122","security":[{"productionOauth":["claim.read","claim.write"]},{"sandboxOauth":["claim.read","claim.write"]},{"bearer_token":[]}],"description":"Signature images\n\n\n\nIf the request includes signature images for both the Veteran and the representative, the API will:\n\n   - Generate VA Form 21-22 PDF for organizations or VA Form 21-22a PDF for individual representatives.\n\n   - Automatically establish POA for the representative.\n\n\n\nThe signature can be provided in either of these formats:\n\n   - Base64-encoded image or signature block. This allows the API to auto-populate and attach the VA Form\n   21-22 without requiring a manual PDF upload.\n\n   - PDF of VA Form 21-22 with an ink signature. This should be attached using the PUT /forms/2122/{id}\n   endpoint.\n\n\n\n   If signature images are not included in the initial request, the response will return an id which must be\n   used to submit the signed PDF via the PUT /forms/2122/{id} endpoint.\n\n\n\nDependent claimant information:\n\n   - If dependent claimant information is included in the request, the dependentʼs relationship to the Veteran\n   will be validated.\n\n   - In this case, the representative will be appointed to the dependent claimant, not the Veteran.\n\n\n\nResponse information:\n\n   - A successful submission returns a 200 response, indicating that the request was successfully processed.\n\n   - A 200 response does not confirm that the POA has been appointed.\n\n   - To check the status of a POA submission, use the GET /forms/2122/{id} endpoint.\n\n","parameters":[{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"2122 Response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000001","type":"claims_api_power_of_attorneys","attributes":{"date_request_accepted":"2024-01-01","previous_poa":null,"representative":{"service_organization":{"poa_code":"074"}},"status":"pending"}}},"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","date_request_accepted","representative"],"properties":{"status":{"type":"string","description":"Says if the power of attorney is pending, submitted, updated or errored","enum":["pending","submitted","updated","errored"]},"date_request_accepted":{"type":"string","description":"Date request was first accepted","format":"date"},"representative":{"type":"object","additionalProperties":false,"required":["service_organization"],"properties":{"service_organization":{"type":"object","additionalProperties":true,"required":["poa_code"],"properties":{"poa_code":{"type":"string","description":"Power of Attorney Code submitted for Veteran"}}}}},"previous_poa":{"type":"string","nullable":true,"description":"Current or Previous Power of Attorney Code submitted for Veteran"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":[{"status":422,"detail":"The property /serviceOrganization/poaCode did not match the following requirements: {\"description\"=>\"The POA code of the organization or individual representative\", \"type\"=>\"string\", \"example\"=>\"A1Q\"}","source":"/serviceOrganization/poaCode"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["status","detail","source"],"properties":{"status":{"type":"integer","description":"HTTP error code"},"detail":{"type":"string","description":"HTTP error detail"},"source":{"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"],"example":{"type":"form/21-22","attributes":{"serviceOrganization":{"poaCode":"A1Q"}}},"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 2122 Schema","type":"object","additionalProperties":false,"required":["serviceOrganization"],"properties":{"veteran":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"object","additionalProperties":false,"required":["numberAndStreet","city","country"],"allOf":[{"if":{"properties":{"country":{"const":"US"}}},"then":{"required":["zipFirstFive"]}}],"properties":{"numberAndStreet":{"description":"Street address with number and name.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"aptUnitNumber":{"oneOf":[{"type":"integer"},{"type":"string"}]},"city":{"description":"City for the address.","type":"string","example":"Portland"},"state":{"description":"State or province for the address.","type":"string","example":"OR"},"country":{"description":"Country of the address.","type":"string","example":"US"},"zipFirstFive":{"description":"Zip code (First 5 digits) of the address. Required if country is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zip code (Last 4 digits) of the 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 of the phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code of the phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[2-9][0-9]{2}$","example":"555"},"phoneNumber":{"description":"Phone number.","type":"string","pattern":"^[0-9]{1,14}$","example":"5555555"},"phoneNumberExt":{"type":"string","pattern":"^[a-zA-Z0-9]{1,10}$"}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address of the veteran.","type":"string","pattern":".@.","maxLength":61,"example":"veteran@example.com"},"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":50,"example":"Air National Guard"}}},"claimant":{"type":"object","additionalProperties":false,"required":["firstName","lastName","address","relationship"],"properties":{"firstName":{"description":"First name of Claimant.","type":"string","example":"John"},"middleInitial":{"description":"Middle initial of Claimant.","type":"string","example":"M"},"lastName":{"description":"Last name of Claimant.","type":"string","example":"Dow"},"address":{"type":"object","additionalProperties":false,"required":["numberAndStreet","city","country"],"allOf":[{"if":{"properties":{"country":{"const":"US"}}},"then":{"required":["zipFirstFive"]}}],"properties":{"numberAndStreet":{"description":"Street address with number and name.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"aptUnitNumber":{"oneOf":[{"type":"integer"},{"type":"string"}]},"city":{"description":"City for the address.","type":"string","example":"Portland"},"state":{"description":"State or province for the address.","type":"string","example":"OR"},"country":{"description":"Country of the address.","type":"string","example":"US"},"zipFirstFive":{"description":"Zip code (First 5 digits) of the address. Required if country is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zip code (Last 4 digits) of the 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 of the phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code of the phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[2-9][0-9]{2}$","example":"555"},"phoneNumber":{"description":"Phone number.","type":"string","pattern":"^[0-9]{1,14}$","example":"5555555"},"phoneNumberExt":{"type":"string","pattern":"^[a-zA-Z0-9]{1,10}$"}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address of the claimant.","type":"string","pattern":".@.","maxLength":61,"example":"claimant@example.com"},"relationship":{"description":"Relationship of claimant to the veteran.","type":"string","example":"Spouse"}}},"serviceOrganization":{"description":"Details of the service organization or individual representing the veteran.","type":"object","additionalProperties":false,"required":["poaCode"],"properties":{"poaCode":{"description":"The POA code of the organization or individual representative","type":"string","example":"A1Q"},"organizationName":{"description":"Name of the service organization.","type":"string","example":"I help vets LLC."},"firstName":{"description":"First Name of the representative","type":"string","example":"John"},"lastName":{"description":"Last Name of the representative","type":"string","example":"Doe"},"jobTitle":{"description":"Job title of the representative","type":"string","example":"Veteran Service representative"},"address":{"type":"object","description":"address details for an individual representative","additionalProperties":false,"required":["numberAndStreet","city","country"],"allOf":[{"if":{"properties":{"country":{"const":"US"}}},"then":{"required":["zipFirstFive"]}}],"properties":{"numberAndStreet":{"description":"Street address with number and name.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"aptUnitNumber":{"oneOf":[{"type":"integer"},{"type":"string"}]},"city":{"description":"City for the address.","type":"string","example":"Portland"},"state":{"description":"State or province for the address.","type":"string","example":"OR"},"country":{"description":"Country of the address.","type":"string","example":"US"},"zipFirstFive":{"description":"Zip code (First 5 digits) of the address. Required if country is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zip code (Last 4 digits) of the address.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"additionalProperties":{"type":"boolean"}}},"email":{"description":"Email address of the service organization or representative.","type":"string","pattern":".@.","maxLength":61,"example":"veteran_representative@example.com"},"appointmentDate":{"description":"Date of appointment with Veteran.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"}}},"recordConsent":{"description":"AUTHORIZATION FOR REPRESENTATIVE'S ACCESS TO RECORDS PROTECTED BY SECTION 7332, TITLE 38, U.S.C.","type":"boolean"},"consentLimits":{"description":"Consent in Item 19 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 as follows.","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"},"signatures":{"type":"object","additionalProperties":false,"required":["veteran","representative"],"properties":{"veteran":{"description":"Base64 encoded png image of the veteran or claimant signature.","title":"Signature of the Veteran","type":"string"},"representative":{"description":"Base64 encoded png image of the representative signature.","title":"Signature of the Veteran Representative","type":"string"}}}}}}}}},"examples":{"POA for Veteran":{"value":{"data":{"type":"form/2122","attributes":{"serviceOrganization":{"poaCode":"074"}}}}},"POA for Dependent Claimant":{"value":{"data":{"type":"form/2122","attributes":{"serviceOrganization":{"poaCode":"074"},"claimant":{"firstName":"Mary","lastName":"Lincoln","address":{"numberAndStreet":"123 anystreet","city":"anytown","state":"OR","country":"USA","zipFirstFive":"12345"},"relationship":"Spouse"}}}}}}}}}}},"/forms/2122/{id}":{"put":{"summary":"Upload a signed 21-22 document.","tags":["Power of Attorney"],"operationId":"PUT:/forms/2122/{id}","security":[{"productionOauth":["claim.read","claim.write"]},{"sandboxOauth":["claim.read","claim.write"]},{"bearer_token":[]}],"description":"Accepts a document binary as part of a multipart payload.\nUse this PUT endpoint after the POST endpoint for uploading the signed 21-22 PDF form.\n\n","parameters":[{"name":"id","in":"path","description":"UUID given when Power of Attorney was submitted","required":true,"schema":{"type":"string"}},{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"2122 Response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000002","type":"claims_api_power_of_attorneys","attributes":{"date_request_accepted":"2024-01-01","previous_poa":"074","representative":{"service_organization":{"poa_code":"074"}},"status":"submitted"}}},"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","date_request_accepted","representative"],"properties":{"status":{"type":"string","description":"Says if the power of attorney is pending, submitted, updated or errored","enum":["pending","submitted","updated","errored"]},"date_request_accepted":{"type":"string","description":"Date request was first accepted","format":"date"},"representative":{"type":"object","additionalProperties":false,"required":["service_organization"],"properties":{"service_organization":{"type":"object","additionalProperties":true,"required":["poa_code"],"properties":{"poa_code":{"type":"string","description":"Power of Attorney Code submitted for Veteran"}}}}},"previous_poa":{"type":"string","nullable":true,"description":"Current or Previous Power of Attorney Code submitted for Veteran"}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"errors":[{"title":"Missing parameter","detail":"Must include attachment","code":"108","status":"400"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"Resource not found","code":"404","status":"404"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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 SSN provided does not match Master Person Index (MPI). Please correct the SSN or submit an issue at ask.va.gov or call 1-800-MyVA411 (800-698-2411) for assistance.","code":"422","status":"422"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"424":{"description":"Failed Dependency","content":{"application/json":{"example":{"errors":[{"title":"Failed Dependency","detail":"Failure occurred in a system dependency","code":"424","status":"424"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachment":{"type":"file","description":"Attachment contents. Must be provided in binary PDF or [base64 string](https://va.ghe.com/software/vets-api/blob/master/modules/claims_api/spec/fixtures/base64pdf) format and less than 11 in x 11 in.\n"}}}}},"required":true}},"get":{"summary":"Check POA status by ID.","tags":["Power of Attorney"],"operationId":"GET:/forms/2122/{id}","security":[{"productionOauth":["claim.read"]},{"sandboxOauth":["claim.read"]},{"bearer_token":[]}],"description":"Based on ID, returns a 21-22 submission and current status.","parameters":[{"name":"id","in":"path","description":"The ID of the 21-22 submission","required":true,"schema":{"type":"string"}},{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"2122 response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000003","type":"claims_api_power_of_attorneys","attributes":{"date_request_accepted":"2024-01-01","previous_poa":"074","representative":{"service_organization":{"poa_code":"074"}},"status":"errored"}}},"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","date_request_accepted","representative"],"properties":{"status":{"type":"string","description":"Says if the power of attorney is pending, submitted, updated or errored","enum":["pending","submitted","updated","errored"]},"date_request_accepted":{"type":"string","description":"Date request was first accepted","format":"date"},"representative":{"type":"object","additionalProperties":false,"required":["service_organization"],"properties":{"service_organization":{"type":"object","additionalProperties":true,"required":["poa_code"],"properties":{"poa_code":{"type":"string","description":"Power of Attorney Code submitted for Veteran"}}}}},"previous_poa":{"type":"string","nullable":true,"description":"Current or Previous Power of Attorney Code submitted for Veteran"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"Resource not found","code":"404","status":"404"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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"}}}}}}}},"/forms/2122/active":{"get":{"summary":"Check active POA status.","tags":["Power of Attorney"],"operationId":"GET:/forms/2122/active","security":[{"productionOauth":["claim.read"]},{"sandboxOauth":["claim.read"]},{"bearer_token":[]}],"description":"Returns the last active POA for a claimant.\nTo check the status of new POA submissions, use the GET /forms/2122/{id} endpoint.\n\n","parameters":[{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"2122 response","content":{"application/json":{"example":{"data":{"id":null,"type":"claims_api_power_of_attorneys","attributes":{"status":"updated","date_request_accepted":null,"representative":{"service_organization":{"first_name":"Jane","last_name":"Doe","organization_name":null,"phone_number":"555-555-5555","poa_code":"A01"}},"previous_poa":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":"null"},"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["status","date_request_accepted","representative"],"properties":{"status":{"type":"string","description":"Status of Power of Attorney establishment","enum":["pending","submitted","updated","errored"]},"date_request_accepted":{"type":"string","nullable":true,"description":"Date request was first accepted","format":"date"},"representative":{"type":"object","additionalProperties":false,"required":["service_organization"],"properties":{"service_organization":{"type":"object","additionalProperties":false,"required":["poa_code"],"properties":{"poa_code":{"type":"string","description":"Power of Attorney Code submitted for Veteran"},"first_name":{"description":"First name of representative, null if representative is an organization","type":"string","nullable":true,"example":"Jane"},"last_name":{"description":"Last name of representative, null if representative is an organization","type":"string","nullable":true,"example":"Doe"},"organization_name":{"description":"Name of representing organization, null if representative is an individual","type":"string","nullable":true,"example":"Some Great Organization"},"phone_number":{"description":"Phone number of representative. Can be organization or individual phone number.","type":"string","example":"555-555-5555"}}}}},"previous_poa":{"type":"string","nullable":true,"description":"Current or Previous Power of Attorney Code submitted for Veteran"}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"Power of Attorney not found","code":"404","status":"404"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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"}}}}}}}},"/forms/2122/validate":{"post":{"summary":"21-22 POA form submission test run.","deprecated":true,"tags":["Power of Attorney"],"operationId":"POST:/forms/2122/validate","security":[{"productionOauth":["claim.read","claim.write"]},{"sandboxOauth":["claim.read","claim.write"]},{"bearer_token":[]}],"description":"Test to make sure the form submission works with your parameters.\n","parameters":[{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"2122 Response","content":{"application/json":{"example":{"data":{"type":"powerOfAttorneyValidation","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","description":"Says if the power of attorney is pending, submitted, updated or errored","enum":["valid"]}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":[{"status":422,"detail":"The property / did not contain the required key serviceOrganization","source":"/"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["status","detail","source"],"properties":{"status":{"type":"integer","description":"HTTP error code"},"detail":{"type":"string","description":"HTTP error detail"},"source":{"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"],"example":{"type":"form/21-22","attributes":{"serviceOrganization":{"poaCode":"A1Q"}}},"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Form 2122 Schema","type":"object","additionalProperties":false,"required":["serviceOrganization"],"properties":{"veteran":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"object","additionalProperties":false,"required":["numberAndStreet","city","country"],"allOf":[{"if":{"properties":{"country":{"const":"US"}}},"then":{"required":["zipFirstFive"]}}],"properties":{"numberAndStreet":{"description":"Street address with number and name.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"aptUnitNumber":{"oneOf":[{"type":"integer"},{"type":"string"}]},"city":{"description":"City for the address.","type":"string","example":"Portland"},"state":{"description":"State or province for the address.","type":"string","example":"OR"},"country":{"description":"Country of the address.","type":"string","example":"US"},"zipFirstFive":{"description":"Zip code (First 5 digits) of the address. Required if country is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zip code (Last 4 digits) of the 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 of the phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code of the phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[2-9][0-9]{2}$","example":"555"},"phoneNumber":{"description":"Phone number.","type":"string","pattern":"^[0-9]{1,14}$","example":"5555555"},"phoneNumberExt":{"type":"string","pattern":"^[a-zA-Z0-9]{1,10}$"}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address of the veteran.","type":"string","pattern":".@.","maxLength":61,"example":"veteran@example.com"},"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":50,"example":"Air National Guard"}}},"claimant":{"type":"object","additionalProperties":false,"required":["firstName","lastName","address","relationship"],"properties":{"firstName":{"description":"First name of Claimant.","type":"string","example":"John"},"middleInitial":{"description":"Middle initial of Claimant.","type":"string","example":"M"},"lastName":{"description":"Last name of Claimant.","type":"string","example":"Dow"},"address":{"type":"object","additionalProperties":false,"required":["numberAndStreet","city","country"],"allOf":[{"if":{"properties":{"country":{"const":"US"}}},"then":{"required":["zipFirstFive"]}}],"properties":{"numberAndStreet":{"description":"Street address with number and name.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"aptUnitNumber":{"oneOf":[{"type":"integer"},{"type":"string"}]},"city":{"description":"City for the address.","type":"string","example":"Portland"},"state":{"description":"State or province for the address.","type":"string","example":"OR"},"country":{"description":"Country of the address.","type":"string","example":"US"},"zipFirstFive":{"description":"Zip code (First 5 digits) of the address. Required if country is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zip code (Last 4 digits) of the 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 of the phone number. Required for international phone numbers.","type":"string","pattern":"^[0-9]+$"},"areaCode":{"description":"Area code of the phone number. Required if countryCode is '1' or not included.","type":"string","pattern":"^[2-9][0-9]{2}$","example":"555"},"phoneNumber":{"description":"Phone number.","type":"string","pattern":"^[0-9]{1,14}$","example":"5555555"},"phoneNumberExt":{"type":"string","pattern":"^[a-zA-Z0-9]{1,10}$"}},"if":{"properties":{"countryCode":{"anyOf":[{"type":"string","enum":["1"]}]}}},"then":{"required":["areaCode"]},"else":{"anyOf":[{"required":["countryCode"]},{"required":["areaCode"]}]}},"email":{"description":"Email address of the claimant.","type":"string","pattern":".@.","maxLength":61,"example":"claimant@example.com"},"relationship":{"description":"Relationship of claimant to the veteran.","type":"string","example":"Spouse"}}},"serviceOrganization":{"description":"Details of the service organization or individual representing the veteran.","type":"object","additionalProperties":false,"required":["poaCode"],"properties":{"poaCode":{"description":"The POA code of the organization or individual representative","type":"string","example":"A1Q"},"organizationName":{"description":"Name of the service organization.","type":"string","example":"I help vets LLC."},"firstName":{"description":"First Name of the representative","type":"string","example":"John"},"lastName":{"description":"Last Name of the representative","type":"string","example":"Doe"},"jobTitle":{"description":"Job title of the representative","type":"string","example":"Veteran Service representative"},"address":{"type":"object","description":"address details for an individual representative","additionalProperties":false,"required":["numberAndStreet","city","country"],"allOf":[{"if":{"properties":{"country":{"const":"US"}}},"then":{"required":["zipFirstFive"]}}],"properties":{"numberAndStreet":{"description":"Street address with number and name.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30},"aptUnitNumber":{"oneOf":[{"type":"integer"},{"type":"string"}]},"city":{"description":"City for the address.","type":"string","example":"Portland"},"state":{"description":"State or province for the address.","type":"string","example":"OR"},"country":{"description":"Country of the address.","type":"string","example":"US"},"zipFirstFive":{"description":"Zip code (First 5 digits) of the address. Required if country is 'US'.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zip code (Last 4 digits) of the address.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"additionalProperties":{"type":"boolean"}}},"email":{"description":"Email address of the service organization or representative.","type":"string","pattern":".@.","maxLength":61,"example":"veteran_representative@example.com"},"appointmentDate":{"description":"Date of appointment with Veteran.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"}}},"recordConsent":{"description":"AUTHORIZATION FOR REPRESENTATIVE'S ACCESS TO RECORDS PROTECTED BY SECTION 7332, TITLE 38, U.S.C.","type":"boolean"},"consentLimits":{"description":"Consent in Item 19 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 as follows.","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"},"signatures":{"type":"object","additionalProperties":false,"required":["veteran","representative"],"properties":{"veteran":{"description":"Base64 encoded png image of the veteran or claimant signature.","title":"Signature of the Veteran","type":"string"},"representative":{"description":"Base64 encoded png image of the representative signature.","title":"Signature of the Veteran Representative","type":"string"}}}}}}}}}}},"required":true}}},"/forms/526":{"get":{"summary":"Get a 526 schema for a claim.","deprecated":true,"tags":["Disability"],"operationId":"GET:/forms/526","description":"Returns a single 526 schema to automatically generate a form. Using this GET endpoint allows users to download our current validations.\n","responses":{"200":{"description":"schema response","content":{"application/json":{"example":{"data":[{"$schema":"http://json-schema.org/draft-07/schema#","description":"Claims API 526 Schema","type":"object","additionalProperties":false,"required":["veteran","serviceInformation","disabilities","standardClaim","autoCestPDFGenerationDisabled"],"properties":{"veteran":{"description":"Veteran Object being submitted in Claim","type":"object","additionalProperties":false,"required":["currentMailingAddress","currentlyVAEmployee"],"properties":{"flashes":{"description":"Attributes that describe special circumstances which apply to a Veteran.","type":"array","items":{"type":"string","enum":["Agent Orange - Vietnam","Amyotrophic Lateral Sclerosis","Blind","Blue Water Navy","Formerly Homeless","GW Undiagnosed Illness","Hardship","Homeless","Medal of Honor","POW","Priority Processing - Veteran over age 85","Purple Heart","Seriously Injured/Very Seriously Injured","Specially Adapted Housing Claimed","Terminally Ill"]},"example":"Hardship"},"currentlyVAEmployee":{"type":"boolean","description":"Flag if Veteran is VA Employee.","example":false},"currentMailingAddress":{"description":"Current Mailing Address Object being submitted.","type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Address Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30,"example":"1234 Couch Street"},"addressLine2":{"description":"Additional Address Information Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":10,"example":"Apt. 22"},"addressLine3":{"description":"Additional Address Information Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":10,"example":"Box 123"},"city":{"description":"City Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.#]([-a-zA-Z0-9'.# ])?)+$","maxLength":20,"example":"Portland"},"country":{"description":"Country Veteran resides in.  Value must match the values returned by the \"/countries\" endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"USA"},"zipFirstFive":{"description":"Zipcode (First 5 digits) Veteran resides in.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zipcode (Last 4 digits) Veteran resides in.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"internationalPostalCode":{"type":"string"},"type":{"description":"Type of residence Veteran resides in.  \n If value is \"INTERNATIONAL\", then \"addressLine1\", \"city\", \"country\", and \"internationalPostalCode\" are required.  \n If value is \"DOMESTIC\", then \"addressLine1\", \"city\", \"state\", \"country\", and \"zipFirstFive\" are required.  \n If value is \"MILITARY\", then \"addressLine1\", \"country\", \"militaryStateCode\", \"militaryPostOfficeTypeCode\", and \"zipFirstFive\" are required.","type":"string","default":"DOMESTIC","enum":["INTERNATIONAL","MILITARY","DOMESTIC"],"example":"DOMESTIC"},"state":{"description":"State or province Veteran resides in.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"}},"allOf":[{"if":{"properties":{"type":{"const":"INTERNATIONAL"}}},"then":{"required":["addressLine1","city","country","type","internationalPostalCode"]}},{"if":{"properties":{"type":{"const":"DOMESTIC"}}},"then":{"required":["addressLine1","city","country","zipFirstFive","type","state"]}},{"if":{"properties":{"type":{"const":"MILITARY"}}},"then":{"required":["addressLine1","country","zipFirstFive","militaryStateCode","militaryPostOfficeTypeCode","type"]}}]},"changeOfAddress":{"description":"A Change of Address Object being submitted.","type":"object","additionalProperties":false,"required":["country","type","addressLine1","addressChangeType","beginningDate"],"properties":{"beginningDate":{"description":"Date in YYYY-MM-DD the Veteran changed address. Date must be in the future if change is temporary.","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","type":"string","example":"2018-06-04"},"endingDate":{"description":"Date in YYYY-MM-DD the changed address expires, if change is temporary.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-04"},"addressChangeType":{"description":"Temporary or Permanent change of address.","type":"string","example":"PERMANENT"},"addressLine1":{"description":"New Address Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30,"example":"1234 Couch Street"},"addressLine2":{"description":"New Additional Address Information Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30,"example":"Apt. 22"},"city":{"description":"New city Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.#]([-a-zA-Z0-9'.# ])?)+$","maxLength":20,"example":"Portland"},"country":{"description":"New country Veteran resides in. Value must match the values returned by the \"/countries\" endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"USA"},"zipFirstFive":{"description":"New zipcode (First 5 digits) Veteran resides in.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"New zipcode (Last 4 digits) Veteran resides in.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"internationalPostalCode":{"type":"string"},"type":{"description":"New type of residence Veteran resides in.  \n If value is \"INTERNATIONAL\", then \"city\" and \"internationalPostalCode\" are required.  \n If value is \"DOMESTIC\", then \"city\", \"state\", and \"zipFirstFive\" are required.  \n If value is \"MILITARY\", then \"militaryStateCode\", \"militaryPostOfficeTypeCode\", and \"zipFirstFive\" are required.","type":"string","default":"DOMESTIC","enum":["INTERNATIONAL","MILITARY","DOMESTIC"],"example":"DOMESTIC"},"militaryStateCode":{"type":"string"},"militaryPostOfficeTypeCode":{"type":"string"},"state":{"description":"New state or province Veteran resides in.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"}},"allOf":[{"if":{"properties":{"type":{"const":"INTERNATIONAL"}}},"then":{"required":["city","internationalPostalCode"]}},{"if":{"properties":{"type":{"const":"DOMESTIC"}}},"then":{"required":["city","zipFirstFive","state"]}},{"if":{"properties":{"type":{"const":"MILITARY"}}},"then":{"required":["zipFirstFive","militaryStateCode","militaryPostOfficeTypeCode"]}}]},"homelessness":{"description":"Object describing Veteran Homelessness if applicable.","type":"object","additionalProperties":false,"properties":{"pointOfContact":{"description":"Object describing Homeless Veteran Point of Contact.","type":"object","additionalProperties":false,"required":["pointOfContactName","primaryPhone"],"properties":{"pointOfContactName":{"description":"Point of contact in direct contact with Veteran.","type":"string","minLength":1,"maxLength":100,"pattern":"^([-a-zA-Z0-9/']+( ?))*$","example":"Jane Doe"},"primaryPhone":{"description":"Phone Number Object for Point of Contact.","type":"object","additionalProperties":false,"required":["areaCode","phoneNumber"],"properties":{"areaCode":{"description":"Area code of Point of Contact.","type":"string","example":"555"},"phoneNumber":{"description":"Primary phone of Point of Contact.","type":"string","example":"5555555"}}}}},"currentlyHomeless":{"type":"object","additionalProperties":false,"required":["homelessSituationType","otherLivingSituation"],"properties":{"homelessSituationType":{"description":"Current state of the veteran's homelessness.","type":"string","default":"other","enum":["fleeing","shelter","notShelter","anotherPerson","other"],"example":"fleeing"},"otherLivingSituation":{"description":"For a 'homelessSituationType' of value 'other', please provide additional comments on the living situation.","type":"string","maxLength":500,"example":"other living situation"}}},"homelessnessRisk":{"type":"object","additionalProperties":false,"required":["homelessnessRiskSituationType","otherLivingSituation"],"properties":{"homelessnessRiskSituationType":{"type":"string","default":"other","enum":["losingHousing","leavingShelter","other"]},"otherLivingSituation":{"description":"For a 'homelessnessRiskSituationType' of value 'other', please provide additional comments on the living situation.","type":"string","maxLength":500,"example":"other living situation"}}}}},"isTerminallyIll":{"type":"boolean"}}},"serviceInformation":{"description":"Overview of Veteran's service history.","type":"object","additionalProperties":false,"required":["servicePeriods"],"properties":{"servicePeriods":{"description":"Identifies the Service dates and Branch the Veteran served in.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["serviceBranch","activeDutyBeginDate","activeDutyEndDate"],"properties":{"serviceBranch":{"description":"Branch of Service during period.","type":"string","example":"Air Force","enum":["Air Force","Air Force Academy","Air Force Reserves","Air Force Civilian","Air National Guard","Army","Army Air Corps","Army Air Corps or Army Air Force","Army National Guard","Army Nurse Corps","Army Reserves","Coast Guard","Coast Guard Academy","Coast Guard Reserves","Commonwealth Army Veteran","Guerrilla Combination Service","Marine","Marine Corps","Marine Corps Reserves","Merchant Marine","National Oceanic & Atmospheric Administration","National Oceanic and Atmospheric Administration","Naval Academy","Navy","Navy Reserves","Other","Public Health Service","Regular Philippine Scout","Regular Scout Service","Space Force","Special Philippine Scout","Unknown","US Military Academy","Woman Air Corps","Women's Army Corps"]},"activeDutyBeginDate":{"description":"Date Started Active Duty. This date must be in the past.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"1980-02-05"},"activeDutyEndDate":{"description":"Date Completed Active Duty. Cannot be more than 180 days in the future, unless past service is also included.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"1990-01-02"},"separationLocationCode":{"description":"Code for the facility the Veteran plans to separate from. Code must match the values returned by the /intake-sites endpoint on the [Benefits reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"98283"}}}},"confinements":{"description":"Used if the Veteran was ever a prisoner of war.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["confinementBeginDate","confinementEndDate"],"properties":{"confinementBeginDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"confinementEndDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"}}}},"reservesNationalGuardService":{"type":"object","additionalProperties":false,"required":["obligationTermOfServiceFromDate","obligationTermOfServiceToDate"],"properties":{"title10Activation":{"description":"Include if the Veteran is currently activated on federal orders within the National Guard or Reserves","type":"object","additionalProperties":false,"required":["anticipatedSeparationDate","title10ActivationDate"],"properties":{"anticipatedSeparationDate":{"description":"Anticipated date of separation. Date must be in the future.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"title10ActivationDate":{"description":"Date cannot be in the future and must be after the earliest servicePeriod.activeDutyBeginDate.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"}}},"obligationTermOfServiceFromDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"obligationTermOfServiceToDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"unitName":{"type":"string","pattern":"([a-zA-Z0-9\\-'.,# ][a-zA-Z0-9\\-'.,# ]?)*$"},"unitPhone":{"type":"object","additionalProperties":false,"required":["areaCode","phoneNumber"],"properties":{"areaCode":{"type":"string","example":"555"},"phoneNumber":{"type":"string","example":"5555555"}}},"receivingInactiveDutyTrainingPay":{"type":"boolean"}}},"alternateNames":{"description":"List any other names under which the Veteran served, if applicable.","type":"array","minItems":1,"maxItems":100,"items":{"type":"object","additionalProperties":false,"required":["firstName","lastName"],"properties":{"firstName":{"type":"string","min":1,"max":30,"pattern":"^([-a-zA-Z0-9/']+( ?))+$"},"middleName":{"type":"string","min":1,"max":30,"pattern":"^([-a-zA-Z0-9/']+( ?))+$"},"lastName":{"type":"string","min":1,"max":30,"pattern":"^([-a-zA-Z0-9/']+( ?))+$"}}}}}},"disabilities":{"description":"Any current disabilities or symptoms the Veteran is claiming are related to their military service and/or are service-connected.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["disabilityActionType","name"],"properties":{"specialIssues":{"description":"The special issues related to the disability. Note :: Only add special issues that you are certain about.  Incorrect special issues can lead to processing delays or denials.  [See special issue descriptions.](https://www.knowva.ebenefits.va.gov/system/templates/selfservice/va_ssnew/help/customer/locale/en-US/portal/554400000001018/content/554400000179710/Appendix-E-Index-of-Corporate-Flashes-and-Special-Issues#2b)","type":"array","items":{"type":"string","enum":["ALS","HEPC","PTSD/1","PTSD/2","PTSD/3","PTSD/4","MST","38 USC 1151","ABA Election","Abandoned VDC Claim","AMC NOD Brokering Project","Administrative Decision Review - Level 1","Administrative Decision Review - Level 2","Agent Orange - Vietnam","Agent Orange - outside Vietnam or unknown","AMA SOC/SSOC Opt-In","Amyotrophic Lateral Sclerosis (ALS)","Annual Eligibility Report","Asbestos","AutoEstablish","Automated Drill Pay Adjustment","Automated Return to Active Duty","BDD – Excluded","Brokered - D1BC","Brokered - Internal","Burn Pit Exposure","C-123","COWC","Character of Discharge","Challenge","ChemBio","Claimant Service Verification Accepted","Combat Related Death","Compensation Service Review – AO Outside RVN & Ship","Compensation Service Review - Equitable Relief","Compensation Service Review - Extraschedular","Compensation Service Review – MG/CBRNE/Shad","Compensation Service Review - Opinion","Compensation Service Review - Over $25K","Compensation Service Review - POW","Compensation Service Review - Radiation","Decision Ready Claim","Decision Ready Claim - Deferred","Decision Ready Claim - Partial Deferred","Disability Benefits Questionnaire - Private","Disability Benefits Questionnaire - VA","DRC – Exam Review Complete Approved","DRC – Exam Review Complete Disapproved","DRC – Pending File Scan","DRC – Vendor Exam Recommendation","DTA Error – Exam/MO","DTA Error – Fed Recs","DTA Error – Other Recs","DTA Error – PMRs","Emergency Care – CH17 Determination","Enhanced Disability Severance Pay","Environmental Hazard - Camp Lejeune","Environmental Hazard – Camp Lejeune – Louisville","Environmental Hazard in Gulf War","Extra-Schedular 3.321(b)(1)","Extra-Schedular IU 4.16(b)","FDC Excluded - Additional Claim Submitted","FDC Excluded - All Required Items Not Submitted","FDC Excluded - Appeal Pending","FDC Excluded - Appeal submitted","FDC Excluded - Claim Pending","FDC Excluded - Claimant Declined FDC Processing","FDC Excluded - Evidence Received After FDC CEST","FDC Excluded - FDC Certification Incomplete","FDC Excluded - FTR to Examination","FDC Excluded - Necessary Form(s) not Submitted","FDC Excluded - Needs Non-Fed Evidence Development","FDC Excluded - requires INDPT VRFCTN of FTI","Fed Record Delay - No Further Dev","Force Majeure","Fully Developed Claim","Gulf War Presumptive","HIV","Hepatitis C","Hospital Adjustment Action Plan FY 18/19","IDES Deferral","JSRRC Request","Local Hearing","Local Mentor Review","Local Quality Review","Local Quality Review IPR","Medical Foster Home","Military Sexual Trauma (MST)","MQAS Separation and Severance Pay Audit","Mustard Gas","National Quality Review","Nehmer AO Peripheral Neuropathy","Nehmer Phase II","Non-ADL Notification Letter","Non-Nehmer AO Peripheral Neuropathy","Non-PTSD Personal Trauma","Potential Under/Overpayment","POW","PTSD - Combat","PTSD - Non-Combat","PTSD - Personal Trauma","RO Special issue 1","RO Special issue 2","RO Special Issue 3","RO Special Issue 4","RO Special Issue 5","RO Special Issue 6","RO Special Issue 7","RO Special Issue 8","RO Special Issue 9","RVSR Examination","Radiation","Radiation Radiogenic Disability Confirmed","Rating Decision Review - Level 1","Rating Decision Review - Level 2","Ready for Exam","RRD","Same Station Review","SHAD","Sarcoidosis","Simultaneous Award Adjustment Not Permitted","Specialized Records Request","Stage 1 Development","Stage 2 Development","Stage 3 Development","TBI Exam Review","Temp 100 Convalescence","Temp 100 Hospitalization","Tobacco","Tort Claim","Traumatic Brain Injury","Upfront Verification","VACO Special issue 1","VACO Special issue 2","VACO Special Issue 3","VACO Special Issue 4","VACO Special Issue 5","VACO Special Issue 6","VACO Special Issue 7","VACO Special Issue 8","VACO Special Issue 9","VASRD-Cardiovascular","VASRD-Dental","VASRD-Digestive","VASRD-Endocrine","VASRD-Eye","VASRD-GU","VASRD-GYN","VASRD-Hemic","VASRD-Infectious","VASRD-Mental","VASRD-Musculoskeletal","VASRD-Neurological","VASRD-Respiratory/Auditory","VASRD-Skin","Vendor Exclusion - No Diagnosis","VONAPP Direct Connect","WARTAC","WARTAC Trainee"]},"example":"ALS"},"ratedDisabilityId":{"description":"The Type of Disability.","type":"string","example":"1100583"},"diagnosticCode":{"description":"Specific Diagnostic Code.","type":"integer","example":9999},"disabilityActionType":{"description":"The status of the current disability.  \n If value is \"INCREASE\", then \"ratedDisabilityId\" and \"diagnosticCode\" are required.","type":"string","enum":["NONE","NEW","INCREASE"],"example":"NEW"},"name":{"description":"What the Disability is called.\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},"classificationCode":{"type":"string","example":"249470"},"approximateBeginDate":{"description":"Approximate date disability began. Date must be in the past.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-03-02"},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","example":"Heavy equipment operator in service."},"secondaryDisabilities":{"description":"Identifies the Secondary Service Disability information of the Veteran.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["name","disabilityActionType","serviceRelevance"],"properties":{"name":{"description":"What the Disability is called.","type":"string","pattern":"^[a-zA-Z0-9'\",.#&;:%<>/()\\[\\]\\\\ -]+$","maxLength":255,"example":"PTSD"},"disabilityActionType":{"description":"The status of the secondary disability.","type":"string","enum":["SECONDARY"],"example":"SECONDARY"},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","example":"Heavy equipment operator in service."},"specialIssues":{"description":"The special issues related to the disability. Note :: Only add special issues that you are certain about.  Incorrect special issues can lead to processing delays or denials.  [See special issue descriptions.](https://www.knowva.ebenefits.va.gov/system/templates/selfservice/va_ssnew/help/customer/locale/en-US/portal/554400000001018/content/554400000179710/Appendix-E-Index-of-Corporate-Flashes-and-Special-Issues?query=special%20issues#2b)","type":"array","items":{"type":"string","enum":["ALS","HEPC","PTSD/1","PTSD/2","PTSD/3","PTSD/4","MST","38 USC 1151","ABA Election","Abandoned VDC Claim","AMC NOD Brokering Project","Administrative Decision Review - Level 1","Administrative Decision Review - Level 2","Agent Orange - Vietnam","Agent Orange - outside Vietnam or unknown","AMA SOC/SSOC Opt-In","Amyotrophic Lateral Sclerosis (ALS)","Annual Eligibility Report","Asbestos","AutoEstablish","Automated Drill Pay Adjustment","Automated Return to Active Duty","BDD – Excluded","Brokered - D1BC","Brokered - Internal","Burn Pit Exposure","C-123","COWC","Character of Discharge","Challenge","ChemBio","Claimant Service Verification Accepted","Combat Related Death","Compensation Service Review – AO Outside RVN & Ship","Compensation Service Review - Equitable Relief","Compensation Service Review - Extraschedular","Compensation Service Review – MG/CBRNE/Shad","Compensation Service Review - Opinion","Compensation Service Review - Over $25K","Compensation Service Review - POW","Compensation Service Review - Radiation","Decision Ready Claim","Decision Ready Claim - Deferred","Decision Ready Claim - Partial Deferred","Disability Benefits Questionnaire - Private","Disability Benefits Questionnaire - VA","DRC – Exam Review Complete Approved","DRC – Exam Review Complete Disapproved","DRC – Pending File Scan","DRC – Vendor Exam Recommendation","DTA Error – Exam/MO","DTA Error – Fed Recs","DTA Error – Other Recs","DTA Error – PMRs","Emergency Care – CH17 Determination","Enhanced Disability Severance Pay","Environmental Hazard - Camp Lejeune","Environmental Hazard – Camp Lejeune – Louisville","Environmental Hazard in Gulf War","Extra-Schedular 3.321(b)(1)","Extra-Schedular IU 4.16(b)","FDC Excluded - Additional Claim Submitted","FDC Excluded - All Required Items Not Submitted","FDC Excluded - Appeal Pending","FDC Excluded - Appeal submitted","FDC Excluded - Claim Pending","FDC Excluded - Claimant Declined FDC Processing","FDC Excluded - Evidence Received After FDC CEST","FDC Excluded - FDC Certification Incomplete","FDC Excluded - FTR to Examination","FDC Excluded - Necessary Form(s) not Submitted","FDC Excluded - Needs Non-Fed Evidence Development","FDC Excluded - requires INDPT VRFCTN of FTI","Fed Record Delay - No Further Dev","Force Majeure","Fully Developed Claim","Gulf War Presumptive","HIV","Hepatitis C","Hospital Adjustment Action Plan FY 18/19","IDES Deferral","JSRRC Request","Local Hearing","Local Mentor Review","Local Quality Review","Local Quality Review IPR","Medical Foster Home","Military Sexual Trauma (MST)","MQAS Separation and Severance Pay Audit","Mustard Gas","National Quality Review","Nehmer AO Peripheral Neuropathy","Nehmer Phase II","Non-ADL Notification Letter","Non-Nehmer AO Peripheral Neuropathy","Non-PTSD Personal Trauma","Potential Under/Overpayment","POW","PTSD - Combat","PTSD - Non-Combat","PTSD - Personal Trauma","RO Special issue 1","RO Special issue 2","RO Special Issue 3","RO Special Issue 4","RO Special Issue 5","RO Special Issue 6","RO Special Issue 7","RO Special Issue 8","RO Special Issue 9","RVSR Examination","Radiation","Radiation Radiogenic Disability Confirmed","Rating Decision Review - Level 1","Rating Decision Review - Level 2","Ready for Exam","Same Station Review","SHAD","Sarcoidosis","Simultaneous Award Adjustment Not Permitted","Specialized Records Request","Stage 1 Development","Stage 2 Development","Stage 3 Development","TBI Exam Review","Temp 100 Convalescence","Temp 100 Hospitalization","Tobacco","Tort Claim","Traumatic Brain Injury","Upfront Verification","VACO Special issue 1","VACO Special issue 2","VACO Special Issue 3","VACO Special Issue 4","VACO Special Issue 5","VACO Special Issue 6","VACO Special Issue 7","VACO Special Issue 8","VACO Special Issue 9","VASRD-Cardiovascular","VASRD-Dental","VASRD-Digestive","VASRD-Endocrine","VASRD-Eye","VASRD-GU","VASRD-GYN","VASRD-Hemic","VASRD-Infectious","VASRD-Mental","VASRD-Musculoskeletal","VASRD-Neurological","VASRD-Respiratory/Auditory","VASRD-Skin","Vendor Exclusion - No Diagnosis","VONAPP Direct Connect","WARTAC","WARTAC Trainee"]},"example":"ALS"},"classificationCode":{"type":"string","example":"249470"},"approximateBeginDate":{"description":"Approximate date disability began.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-03-02"}}}}},"allOf":[{"if":{"properties":{"disabilityActionType":{"enum":["INCREASE"]}}},"then":{"required":["ratedDisabilityId","diagnosticCode"]}},{"if":{"properties":{"disabilityActionType":{"enum":["NONE"]}},"required":["secondaryDisabilities"]},"then":{"required":["diagnosticCode"]}}]}},"treatments":{"description":"Identifies the Service Treatment information of the Veteran.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"startDate":{"description":"Date Veteran started treatment.","type":["null","string"],"pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02, 2018-03, or 2018"},"endDate":{"description":"Date Veteran ended treatment.","type":["null","string"],"pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02, 2018-03, or 2018"},"treatedDisabilityNames":{"description":"Names of any disabilities for which the Veteran was treated.","type":["array","null"],"maxItems":101,"uniqueItems":true,"items":{"description":"Name of Disabilities Veteran was Treated for.","type":"string","example":"PTSD (post traumatic stress disorder)"}},"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","additionalProperties":false,"properties":{"name":{"description":"Name of facility Veteran was treated in.","type":"string","pattern":"([a-zA-Z0-9\"\\/&\\(\\)\\-'.,# ]([a-zA-Z0-9(\\)\\-'.,# ])?)+$","example":"Private Facility 2"},"country":{"description":"Country Veteran was treated in.","minLength":1,"maxLength":50,"type":"string","example":"USA"}}}}}},"servicePay":{"description":"Details about Veteran receiving Service Pay from DoD.","type":"object","additionalProperties":false,"properties":{"waiveVABenefitsToRetainTrainingPay":{"description":"Is Veteran Waiving benefits to retain training pay.","type":"boolean","example":true},"waiveVABenefitsToRetainRetiredPay":{"description":"Is Veteran Waiving benefits to retain Retiree pay.","type":"boolean","example":true},"militaryRetiredPay":{"description":"Retirement Pay information from Military Service.","type":"object","additionalProperties":false,"required":["receiving","payment"],"properties":{"receiving":{"description":"Is Veteran getting Retiree pay?","type":"boolean","example":true},"willReceiveInFuture":{"description":"Will Veteran get Retiree pay in future?  \n If true, then \"futurePayExplanation\" attribute is required.","type":"boolean","default":false,"example":false},"payment":{"description":"Part of DoD paying Retirement Benefits.","type":"object","additionalProperties":false,"required":["serviceBranch"],"properties":{"serviceBranch":{"description":"Branch of Service making payments.","type":"string","enum":["Air Force","Air Force Reserves","Air National Guard","Army","Army National Guard","Army Reserves","Coast Guard","Coast Guard Reserves","Marine Corps","Marine Corps Reserves","National Oceanic &amp; Atmospheric Administration","National Oceanic & Atmospheric Administration","Navy","Navy Reserves","Public Health Service","Air Force Academy","Army Air Corps or Army Air Force","Army Nurse Corps","Coast Guard Academy","Merchant Marine","Naval Academy","Other","US Military Academy","Women's Army Corps","Space Force"],"example":"Air Force"},"amount":{"description":"Amount being received.","type":"number","example":100}}},"futurePayExplanation":{"description":"Explains why future pay will be received.","type":"string","example":"Will be retiring soon."}}},"separationPay":{"description":"Details about separation pay.","type":"object","additionalProperties":false,"required":["received"],"properties":{"received":{"description":"Has separation pay been received?","type":"boolean","example":true,"default":true},"payment":{"description":"Separation pay payment details.","type":"object","additionalProperties":false,"properties":{"serviceBranch":{"description":"Branch of Service making payments.","type":"string","enum":["Air Force","Air Force Reserves","Air National Guard","Army","Army National Guard","Army Reserves","Coast Guard","Coast Guard Reserves","Marine Corps","Marine Corps Reserves","National Oceanic &amp; Atmospheric Administration","National Oceanic & Atmospheric Administration","Navy","Navy Reserves","Public Health Service","Air Force Academy","Army Air Corps or Army Air Force","Army Nurse Corps","Coast Guard Academy","Merchant Marine","Naval Academy","Other","US Military Academy","Women's Army Corps","Space Force"],"example":"Air Force"},"amount":{"description":"Amount being received.","type":"number","example":100}}},"receivedDate":{"description":"Approximate date separation pay was received.","type":"string","pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02, 2018-03, or 2018"}}}}},"directDeposit":{"description":"Financial Direct Deposit information for Veteran.","type":"object","additionalProperties":false,"properties":{"accountType":{"description":"Veteran Account Type (value is case insensitive).","type":"string","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"accountNumber":{"description":"Veteran Bank Account Number.","minLength":4,"maxLength":17,"type":"string","example":"123123123123"},"routingNumber":{"description":"Veteran Bank Routing Number.","type":"string","pattern":"^\\d{9}$","example":"123123123"},"bankName":{"description":"Provide the name of the bank where the Veteran wants the direct deposit.","maxLength":35,"type":"string","example":"Some Bank"}}},"claimantCertification":{"description":"Determines if person submitting the claim is certified to do so.","type":"boolean","example":true},"standardClaim":{"description":"A value of false indicates the claim should be processed as a Fully Developed Claim.","type":"boolean","example":false},"applicationExpirationDate":{"description":"Time stamp of when claim expires.  If not provided, value will be set to 1 year in the future from current day.","type":"string","example":"2018-08-28T19:53:45+00:00"},"autoCestPDFGenerationDisabled":{"description":"Allows you to bypass the auto PDF generation and instead upload the Disability form itself through Support Documents.","type":"boolean","example":false},"claimDate":{"description":"Date (or Timestamp with TimeZone) when claim is being submitted to the VA. Date cannot be in the future. UTC TimeZone is assumed unless otherwise specified.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])(?:T[0-1][0-9]:[0-5][0-9]:[0-5][0-9](?:[-+][0-9]{2}:[0-9]{2}|Z))*$","example":"2018-08-28T19:53:45+00:00"}}}]}}}},"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"}}}}}}},"post":{"summary":"Submits form 526","tags":["Disability"],"operationId":"POST:/forms/526","security":[{"productionOauth":["claim.read","claim.write"]},{"sandboxOauth":["claim.read","claim.write"]},{"bearer_token":[]}],"description":"Establishes a [Disability Compensation Claim](https://www.vba.va.gov/pubs/forms/VBA-21-526EZ-ARE.pdf) in VBMS. Submits any PDF attachments as a multi-part payload and returns an ID. For claims that are not original claims, this endpoint generates a filled 526 PDF along with the submission.\n<br/><br/>\nA 200 response indicates the submission was successful, but the claim has not reached VBMS until it has a “claim established” status. Check claim status using the GET /claims/{id} endpoint.\n<br/><br/>\n**Original claims**<br/>\nAn original claim is the Veteran’s first claim filed with VA, regardless of the claim type or status. The original claim must have either the Veteran’s wet signature or e-signature. Once there is an original claim on file, future claims may be submitted by a representative without the Veteran’s signature. Uploading a PDF for subsequent claims is not required or recommended.\n<br/><br/>\nPOST the original claim with the autoCestPDFGenerationDisabled boolean as true. After a 200 response, use the PUT /forms/526/{id} endpoint to upload a scanned PDF of your form, signed in ink or e-signature, by the Veteran.\n<br/><br/>\nThe claim data submitted through the POST endpoint must match the signed PDF uploaded through the PUT endpoint. If it does not, VA will manually update the data to match the PDF, and your claim may not process correctly.\n<br/><br/>\n**Standard and fully developed claims (FDCs)**<br/>\n[Fully developed claims (FDCs)](https://www.va.gov/disability/how-to-file-claim/evidence-needed/fully-developed-claims/) are claims certified by the submitter to include all information needed for processing. These claims process faster than claims submitted through the standard claim process. If a claim is certified for the FDC, but is missing needed information, it will route through the standard claim process.\n<br/><br/>\nTo certify a claim for the FDC process, set the standardClaim indicator to false.\n<br/><br/>\n**Flashes and special issues**<br/>\nIncluding flashes and special issues in your 526 claim submission helps VA properly route and prioritize current and future claims for the Veteran and reduces claims processing time.\n\n - Flashes are attributes that describe special circumstances which apply to a Veteran, such as homelessness or terminal illness.\n - Special Issues are attributes that describe special circumstances which apply to a particular claim, such as PTSD.\n\n\n<br/>\n**Notes On 'disabilityActionType' and 'secondaryDisabilities'**<br/>\n\n- We now recommend using the value **NEW** instead of **INCREASE** for **disabilityActionType** in the Benefits Claims API. For context:\n\n  - When requesting a disability **INCREASE**, the **ratedDisabiltiyId** and **diagnosticCode** are also required. The Benefits Claims API doesn't have access to specific values that are required for these fields. By submitting **NEW** for **disabilityActionType**, these values are not required.\n\n  - Using **NEW** instead of **INCREASE** will not significantly impact how the claim is processed by VA.\n\n- We don’t support the **disabilityActionType** of **REOPEN**. It didn't provide value in claim processing because its functionality wasn’t supported.\n\n- We now recommend using the **disabilities** attribute with a **disabilityActionType** value of **NEW**, instead of sending disabilities as nested values with the **secondaryDisabilities** attribute.\n\n  - This approach will not significantly impact how the claim is processed by VA and is better aligned with the 526 form.\n\n  - **secondaryDisabilties** is required if the primary disability has a **disabilityActionType** equal to **NONE**.\n\n- If you are required to use **secondaryDisabilities**, there are additional validations that apply:\n\n  - **disabilityActionType** of the secondary disability must equal **SECONDARY**.\n\n  - **classificationCode** in the secondary disability is optional. If provided, its value must match the value of the **name** attribute.\n\n  - If **classificationCode** isn’t provided, then the **name** attribute must not contain any special characters and must not exceed 255 characters.\n\n  - **specialIssues** must be nil.\n\n  - **approximateBeginDate** was added, but it’s optional. If provided, it must be a valid date.\n","parameters":[{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"526 Response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000004","type":"claims_api_claim","attributes":{"evss_id":null,"open":true,"waiver_submitted":null,"requested_decision":null,"claim_type":null,"updated_at":"2024-01-01T00:00:00.000Z","date_filed":null,"min_est_date":null,"max_est_date":null,"development_letter_sent":null,"decision_letter_sent":null,"documents_needed":null,"contention_list":null,"events_timeline":[],"va_representative":null,"phase":null,"phase_change_date":null,"ever_phase_back":null,"current_phase_back":null,"token":"00000000-0000-0000-0000-000000000005","status":"pending","flashes":["Hardship","Homeless"]}}},"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":"Internal vets-api Claim ID"},"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["open","updated_at","events_timeline","token","status","flashes"],"properties":{"evss_id":{"type":"null","description":"EVSS Claim ID"},"date_filed":{"type":"null","description":"Date in YYYY-MM-DD the claim was first filed"},"min_est_date":{"type":"null","description":"Minimum Estimated Claim Completion Date"},"max_est_date":{"type":"null","description":"Maximum Estimated Claim Completion Date"},"phase_change_date":{"type":"null","description":"Date of last phase change"},"open":{"type":"boolean","description":"Has the claim been resolved"},"waiver_submitted":{"type":"null","description":"Requested Decision or Waiver 5103 Submitted"},"documents_needed":{"type":"null","description":"Does the claim require additional documents to be submitted"},"development_letter_sent":{"type":"null","description":"Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim"},"decision_letter_sent":{"type":"null","description":"Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim"},"phase":{"type":"null"},"ever_phase_back":{"type":"null"},"current_phase_back":{"type":"null"},"requested_decision":{"type":"null","description":"The claim filer has requested a claim decision be made"},"claim_type":{"type":"null","description":"The type of claim originally submitted"},"updated_at":{"type":"string","format":"date","description":"Time stamp of last change to the claim"},"contention_list":{"type":"null"},"va_representative":{"type":"null"},"events_timeline":{"type":"array"},"token":{"type":"string"},"status":{"type":"string","enum":["pending"],"description":"Current status of the claim"},"flashes":{"type":"array","items":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":[{"status":422,"detail":"The property /someBadKey is not defined on the schema. Additional properties are not allowed","source":"/someBadKey"}]}},"Not a JSON Object":{"value":{"errors":[{"status":422,"detail":"The request body isn't a JSON object: \"This is not valid JSON\"","source":""}]}}},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["status","detail","source"],"properties":{"status":{"type":"integer","description":"HTTP error code"},"detail":{"type":"string","description":"HTTP error detail"},"source":{"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"],"example":{"type":"form/526","attributes":{"veteran":{"currentlyVAEmployee":false,"currentMailingAddress":{"city":"Portland","country":"USA","zipFirstFive":"12345","addressLine1":"1234 Couch Street","addressLine2":"Apt. 22","type":"DOMESTIC","zipLastFour":"6789","state":"OR"}},"claimantCertification":true,"disabilities":[{"ratedDisabilityId":"1100583","diagnosticCode":9999,"disabilityActionType":"NEW","name":"PTSD (post traumatic stress disorder)","specialIssues":["Asbestos"],"secondaryDisabilities":[{"name":"PTSD personal trauma","disabilityActionType":"SECONDARY","serviceRelevance":"Caused by a service-connected disability\\nLengthy description"}]}],"standardClaim":false,"autoCestPDFGenerationDisabled":false,"applicationExpirationDate":"2015-08-28T19:53:45+00:00","serviceInformation":{"servicePeriods":[{"activeDutyEndDate":"1990-01-02","serviceBranch":"Air Force","activeDutyBeginDate":"1980-02-05"},{"activeDutyEndDate":"1999-01-01","serviceBranch":"Air Force Reserves","activeDutyBeginDate":"1990-04-05"}]}}},"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Claims API 526 Schema","type":"object","additionalProperties":false,"required":["veteran","serviceInformation","disabilities","standardClaim","autoCestPDFGenerationDisabled"],"properties":{"veteran":{"description":"Veteran Object being submitted in Claim","type":"object","additionalProperties":false,"required":["currentMailingAddress","currentlyVAEmployee"],"properties":{"flashes":{"description":"Attributes that describe special circumstances which apply to a Veteran.","type":"array","items":{"type":"string","enum":["Agent Orange - Vietnam","Amyotrophic Lateral Sclerosis","Blind","Blue Water Navy","Formerly Homeless","GW Undiagnosed Illness","Hardship","Homeless","Medal of Honor","POW","Priority Processing - Veteran over age 85","Purple Heart","Seriously Injured/Very Seriously Injured","Specially Adapted Housing Claimed","Terminally Ill"]},"example":"Hardship"},"currentlyVAEmployee":{"type":"boolean","description":"Flag if Veteran is VA Employee.","example":false},"currentMailingAddress":{"description":"Current Mailing Address Object being submitted.","type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Address Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30,"example":"1234 Couch Street"},"addressLine2":{"description":"Additional Address Information Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":10,"example":"Apt. 22"},"addressLine3":{"description":"Additional Address Information Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":10,"example":"Box 123"},"city":{"description":"City Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.#]([-a-zA-Z0-9'.# ])?)+$","maxLength":20,"example":"Portland"},"country":{"description":"Country Veteran resides in.  Value must match the values returned by the \"/countries\" endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"USA"},"zipFirstFive":{"description":"Zipcode (First 5 digits) Veteran resides in.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zipcode (Last 4 digits) Veteran resides in.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"internationalPostalCode":{"type":"string"},"type":{"description":"Type of residence Veteran resides in.  \n If value is \"INTERNATIONAL\", then \"addressLine1\", \"city\", \"country\", and \"internationalPostalCode\" are required.  \n If value is \"DOMESTIC\", then \"addressLine1\", \"city\", \"state\", \"country\", and \"zipFirstFive\" are required.  \n If value is \"MILITARY\", then \"addressLine1\", \"country\", \"militaryStateCode\", \"militaryPostOfficeTypeCode\", and \"zipFirstFive\" are required.","type":"string","default":"DOMESTIC","enum":["INTERNATIONAL","MILITARY","DOMESTIC"],"example":"DOMESTIC"},"state":{"description":"State or province Veteran resides in.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"}},"allOf":[{"if":{"properties":{"type":{"const":"INTERNATIONAL"}}},"then":{"required":["addressLine1","city","country","type","internationalPostalCode"]}},{"if":{"properties":{"type":{"const":"DOMESTIC"}}},"then":{"required":["addressLine1","city","country","zipFirstFive","type","state"]}},{"if":{"properties":{"type":{"const":"MILITARY"}}},"then":{"required":["addressLine1","country","zipFirstFive","militaryStateCode","militaryPostOfficeTypeCode","type"]}}]},"changeOfAddress":{"description":"A Change of Address Object being submitted.","type":"object","additionalProperties":false,"required":["country","type","addressLine1","addressChangeType","beginningDate"],"properties":{"beginningDate":{"description":"Date in YYYY-MM-DD the Veteran changed address. Date must be in the future if change is temporary.","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","type":"string","example":"2018-06-04"},"endingDate":{"description":"Date in YYYY-MM-DD the changed address expires, if change is temporary.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-04"},"addressChangeType":{"description":"Temporary or Permanent change of address.","type":"string","example":"PERMANENT"},"addressLine1":{"description":"New Address Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30,"example":"1234 Couch Street"},"addressLine2":{"description":"New Additional Address Information Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30,"example":"Apt. 22"},"city":{"description":"New city Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.#]([-a-zA-Z0-9'.# ])?)+$","maxLength":20,"example":"Portland"},"country":{"description":"New country Veteran resides in. Value must match the values returned by the \"/countries\" endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"USA"},"zipFirstFive":{"description":"New zipcode (First 5 digits) Veteran resides in.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"New zipcode (Last 4 digits) Veteran resides in.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"internationalPostalCode":{"type":"string"},"type":{"description":"New type of residence Veteran resides in.  \n If value is \"INTERNATIONAL\", then \"city\" and \"internationalPostalCode\" are required.  \n If value is \"DOMESTIC\", then \"city\", \"state\", and \"zipFirstFive\" are required.  \n If value is \"MILITARY\", then \"militaryStateCode\", \"militaryPostOfficeTypeCode\", and \"zipFirstFive\" are required.","type":"string","default":"DOMESTIC","enum":["INTERNATIONAL","MILITARY","DOMESTIC"],"example":"DOMESTIC"},"militaryStateCode":{"type":"string"},"militaryPostOfficeTypeCode":{"type":"string"},"state":{"description":"New state or province Veteran resides in.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"}},"allOf":[{"if":{"properties":{"type":{"const":"INTERNATIONAL"}}},"then":{"required":["city","internationalPostalCode"]}},{"if":{"properties":{"type":{"const":"DOMESTIC"}}},"then":{"required":["city","zipFirstFive","state"]}},{"if":{"properties":{"type":{"const":"MILITARY"}}},"then":{"required":["zipFirstFive","militaryStateCode","militaryPostOfficeTypeCode"]}}]},"homelessness":{"description":"Object describing Veteran Homelessness if applicable.","type":"object","additionalProperties":false,"properties":{"pointOfContact":{"description":"Object describing Homeless Veteran Point of Contact.","type":"object","additionalProperties":false,"required":["pointOfContactName","primaryPhone"],"properties":{"pointOfContactName":{"description":"Point of contact in direct contact with Veteran.","type":"string","minLength":1,"maxLength":100,"pattern":"^([-a-zA-Z0-9/']+( ?))*$","example":"Jane Doe"},"primaryPhone":{"description":"Phone Number Object for Point of Contact.","type":"object","additionalProperties":false,"required":["areaCode","phoneNumber"],"properties":{"areaCode":{"description":"Area code of Point of Contact.","type":"string","example":"555"},"phoneNumber":{"description":"Primary phone of Point of Contact.","type":"string","example":"5555555"}}}}},"currentlyHomeless":{"type":"object","additionalProperties":false,"required":["homelessSituationType","otherLivingSituation"],"properties":{"homelessSituationType":{"description":"Current state of the veteran's homelessness.","type":"string","default":"other","enum":["fleeing","shelter","notShelter","anotherPerson","other"],"example":"fleeing"},"otherLivingSituation":{"description":"For a 'homelessSituationType' of value 'other', please provide additional comments on the living situation.","type":"string","maxLength":500,"example":"other living situation"}}},"homelessnessRisk":{"type":"object","additionalProperties":false,"required":["homelessnessRiskSituationType","otherLivingSituation"],"properties":{"homelessnessRiskSituationType":{"type":"string","default":"other","enum":["losingHousing","leavingShelter","other"]},"otherLivingSituation":{"description":"For a 'homelessnessRiskSituationType' of value 'other', please provide additional comments on the living situation.","type":"string","maxLength":500,"example":"other living situation"}}}}},"isTerminallyIll":{"type":"boolean"}}},"serviceInformation":{"description":"Overview of Veteran's service history.","type":"object","additionalProperties":false,"required":["servicePeriods"],"properties":{"servicePeriods":{"description":"Identifies the Service dates and Branch the Veteran served in.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["serviceBranch","activeDutyBeginDate","activeDutyEndDate"],"properties":{"serviceBranch":{"description":"Branch of Service during period.","type":"string","example":"Air Force","enum":["Air Force","Air Force Academy","Air Force Reserves","Air Force Civilian","Air National Guard","Army","Army Air Corps","Army Air Corps or Army Air Force","Army National Guard","Army Nurse Corps","Army Reserves","Coast Guard","Coast Guard Academy","Coast Guard Reserves","Commonwealth Army Veteran","Guerrilla Combination Service","Marine","Marine Corps","Marine Corps Reserves","Merchant Marine","National Oceanic & Atmospheric Administration","National Oceanic and Atmospheric Administration","Naval Academy","Navy","Navy Reserves","Other","Public Health Service","Regular Philippine Scout","Regular Scout Service","Space Force","Special Philippine Scout","Unknown","US Military Academy","Woman Air Corps","Women's Army Corps"]},"activeDutyBeginDate":{"description":"Date Started Active Duty. This date must be in the past.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"1980-02-05"},"activeDutyEndDate":{"description":"Date Completed Active Duty. Cannot be more than 180 days in the future, unless past service is also included.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"1990-01-02"},"separationLocationCode":{"description":"Code for the facility the Veteran plans to separate from. Code must match the values returned by the /intake-sites endpoint on the [Benefits reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"98283"}}}},"confinements":{"description":"Used if the Veteran was ever a prisoner of war.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["confinementBeginDate","confinementEndDate"],"properties":{"confinementBeginDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"confinementEndDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"}}}},"reservesNationalGuardService":{"type":"object","additionalProperties":false,"required":["obligationTermOfServiceFromDate","obligationTermOfServiceToDate"],"properties":{"title10Activation":{"description":"Include if the Veteran is currently activated on federal orders within the National Guard or Reserves","type":"object","additionalProperties":false,"required":["anticipatedSeparationDate","title10ActivationDate"],"properties":{"anticipatedSeparationDate":{"description":"Anticipated date of separation. Date must be in the future.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"title10ActivationDate":{"description":"Date cannot be in the future and must be after the earliest servicePeriod.activeDutyBeginDate.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"}}},"obligationTermOfServiceFromDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"obligationTermOfServiceToDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"unitName":{"type":"string","pattern":"([a-zA-Z0-9\\-'.,# ][a-zA-Z0-9\\-'.,# ]?)*$"},"unitPhone":{"type":"object","additionalProperties":false,"required":["areaCode","phoneNumber"],"properties":{"areaCode":{"type":"string","example":"555"},"phoneNumber":{"type":"string","example":"5555555"}}},"receivingInactiveDutyTrainingPay":{"type":"boolean"}}},"alternateNames":{"description":"List any other names under which the Veteran served, if applicable.","type":"array","minItems":1,"maxItems":100,"items":{"type":"object","additionalProperties":false,"required":["firstName","lastName"],"properties":{"firstName":{"type":"string","min":1,"max":30,"pattern":"^([-a-zA-Z0-9/']+( ?))+$"},"middleName":{"type":"string","min":1,"max":30,"pattern":"^([-a-zA-Z0-9/']+( ?))+$"},"lastName":{"type":"string","min":1,"max":30,"pattern":"^([-a-zA-Z0-9/']+( ?))+$"}}}}}},"disabilities":{"description":"Any current disabilities or symptoms the Veteran is claiming are related to their military service and/or are service-connected.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["disabilityActionType","name"],"properties":{"specialIssues":{"description":"The special issues related to the disability. Note :: Only add special issues that you are certain about.  Incorrect special issues can lead to processing delays or denials.  [See special issue descriptions.](https://www.knowva.ebenefits.va.gov/system/templates/selfservice/va_ssnew/help/customer/locale/en-US/portal/554400000001018/content/554400000179710/Appendix-E-Index-of-Corporate-Flashes-and-Special-Issues#2b)","type":"array","items":{"type":"string","enum":["ALS","HEPC","PTSD/1","PTSD/2","PTSD/3","PTSD/4","MST","38 USC 1151","ABA Election","Abandoned VDC Claim","AMC NOD Brokering Project","Administrative Decision Review - Level 1","Administrative Decision Review - Level 2","Agent Orange - Vietnam","Agent Orange - outside Vietnam or unknown","AMA SOC/SSOC Opt-In","Amyotrophic Lateral Sclerosis (ALS)","Annual Eligibility Report","Asbestos","AutoEstablish","Automated Drill Pay Adjustment","Automated Return to Active Duty","BDD – Excluded","Brokered - D1BC","Brokered - Internal","Burn Pit Exposure","C-123","COWC","Character of Discharge","Challenge","ChemBio","Claimant Service Verification Accepted","Combat Related Death","Compensation Service Review – AO Outside RVN & Ship","Compensation Service Review - Equitable Relief","Compensation Service Review - Extraschedular","Compensation Service Review – MG/CBRNE/Shad","Compensation Service Review - Opinion","Compensation Service Review - Over $25K","Compensation Service Review - POW","Compensation Service Review - Radiation","Decision Ready Claim","Decision Ready Claim - Deferred","Decision Ready Claim - Partial Deferred","Disability Benefits Questionnaire - Private","Disability Benefits Questionnaire - VA","DRC – Exam Review Complete Approved","DRC – Exam Review Complete Disapproved","DRC – Pending File Scan","DRC – Vendor Exam Recommendation","DTA Error – Exam/MO","DTA Error – Fed Recs","DTA Error – Other Recs","DTA Error – PMRs","Emergency Care – CH17 Determination","Enhanced Disability Severance Pay","Environmental Hazard - Camp Lejeune","Environmental Hazard – Camp Lejeune – Louisville","Environmental Hazard in Gulf War","Extra-Schedular 3.321(b)(1)","Extra-Schedular IU 4.16(b)","FDC Excluded - Additional Claim Submitted","FDC Excluded - All Required Items Not Submitted","FDC Excluded - Appeal Pending","FDC Excluded - Appeal submitted","FDC Excluded - Claim Pending","FDC Excluded - Claimant Declined FDC Processing","FDC Excluded - Evidence Received After FDC CEST","FDC Excluded - FDC Certification Incomplete","FDC Excluded - FTR to Examination","FDC Excluded - Necessary Form(s) not Submitted","FDC Excluded - Needs Non-Fed Evidence Development","FDC Excluded - requires INDPT VRFCTN of FTI","Fed Record Delay - No Further Dev","Force Majeure","Fully Developed Claim","Gulf War Presumptive","HIV","Hepatitis C","Hospital Adjustment Action Plan FY 18/19","IDES Deferral","JSRRC Request","Local Hearing","Local Mentor Review","Local Quality Review","Local Quality Review IPR","Medical Foster Home","Military Sexual Trauma (MST)","MQAS Separation and Severance Pay Audit","Mustard Gas","National Quality Review","Nehmer AO Peripheral Neuropathy","Nehmer Phase II","Non-ADL Notification Letter","Non-Nehmer AO Peripheral Neuropathy","Non-PTSD Personal Trauma","Potential Under/Overpayment","POW","PTSD - Combat","PTSD - Non-Combat","PTSD - Personal Trauma","RO Special issue 1","RO Special issue 2","RO Special Issue 3","RO Special Issue 4","RO Special Issue 5","RO Special Issue 6","RO Special Issue 7","RO Special Issue 8","RO Special Issue 9","RVSR Examination","Radiation","Radiation Radiogenic Disability Confirmed","Rating Decision Review - Level 1","Rating Decision Review - Level 2","Ready for Exam","RRD","Same Station Review","SHAD","Sarcoidosis","Simultaneous Award Adjustment Not Permitted","Specialized Records Request","Stage 1 Development","Stage 2 Development","Stage 3 Development","TBI Exam Review","Temp 100 Convalescence","Temp 100 Hospitalization","Tobacco","Tort Claim","Traumatic Brain Injury","Upfront Verification","VACO Special issue 1","VACO Special issue 2","VACO Special Issue 3","VACO Special Issue 4","VACO Special Issue 5","VACO Special Issue 6","VACO Special Issue 7","VACO Special Issue 8","VACO Special Issue 9","VASRD-Cardiovascular","VASRD-Dental","VASRD-Digestive","VASRD-Endocrine","VASRD-Eye","VASRD-GU","VASRD-GYN","VASRD-Hemic","VASRD-Infectious","VASRD-Mental","VASRD-Musculoskeletal","VASRD-Neurological","VASRD-Respiratory/Auditory","VASRD-Skin","Vendor Exclusion - No Diagnosis","VONAPP Direct Connect","WARTAC","WARTAC Trainee"]},"example":"ALS"},"ratedDisabilityId":{"description":"The Type of Disability.","type":"string","example":"1100583"},"diagnosticCode":{"description":"Specific Diagnostic Code.","type":"integer","example":9999},"disabilityActionType":{"description":"The status of the current disability.  \n If value is \"INCREASE\", then \"ratedDisabilityId\" and \"diagnosticCode\" are required.","type":"string","enum":["NONE","NEW","INCREASE"],"example":"NEW"},"name":{"description":"What the Disability is called.\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},"classificationCode":{"type":"string","example":"249470"},"approximateBeginDate":{"description":"Approximate date disability began. Date must be in the past.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-03-02"},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","example":"Heavy equipment operator in service."},"secondaryDisabilities":{"description":"Identifies the Secondary Service Disability information of the Veteran.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["name","disabilityActionType","serviceRelevance"],"properties":{"name":{"description":"What the Disability is called.","type":"string","pattern":"^[a-zA-Z0-9'\",.#&;:%<>/()\\[\\]\\\\ -]+$","maxLength":255,"example":"PTSD"},"disabilityActionType":{"description":"The status of the secondary disability.","type":"string","enum":["SECONDARY"],"example":"SECONDARY"},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","example":"Heavy equipment operator in service."},"specialIssues":{"description":"The special issues related to the disability. Note :: Only add special issues that you are certain about.  Incorrect special issues can lead to processing delays or denials.  [See special issue descriptions.](https://www.knowva.ebenefits.va.gov/system/templates/selfservice/va_ssnew/help/customer/locale/en-US/portal/554400000001018/content/554400000179710/Appendix-E-Index-of-Corporate-Flashes-and-Special-Issues?query=special%20issues#2b)","type":"array","items":{"type":"string","enum":["ALS","HEPC","PTSD/1","PTSD/2","PTSD/3","PTSD/4","MST","38 USC 1151","ABA Election","Abandoned VDC Claim","AMC NOD Brokering Project","Administrative Decision Review - Level 1","Administrative Decision Review - Level 2","Agent Orange - Vietnam","Agent Orange - outside Vietnam or unknown","AMA SOC/SSOC Opt-In","Amyotrophic Lateral Sclerosis (ALS)","Annual Eligibility Report","Asbestos","AutoEstablish","Automated Drill Pay Adjustment","Automated Return to Active Duty","BDD – Excluded","Brokered - D1BC","Brokered - Internal","Burn Pit Exposure","C-123","COWC","Character of Discharge","Challenge","ChemBio","Claimant Service Verification Accepted","Combat Related Death","Compensation Service Review – AO Outside RVN & Ship","Compensation Service Review - Equitable Relief","Compensation Service Review - Extraschedular","Compensation Service Review – MG/CBRNE/Shad","Compensation Service Review - Opinion","Compensation Service Review - Over $25K","Compensation Service Review - POW","Compensation Service Review - Radiation","Decision Ready Claim","Decision Ready Claim - Deferred","Decision Ready Claim - Partial Deferred","Disability Benefits Questionnaire - Private","Disability Benefits Questionnaire - VA","DRC – Exam Review Complete Approved","DRC – Exam Review Complete Disapproved","DRC – Pending File Scan","DRC – Vendor Exam Recommendation","DTA Error – Exam/MO","DTA Error – Fed Recs","DTA Error – Other Recs","DTA Error – PMRs","Emergency Care – CH17 Determination","Enhanced Disability Severance Pay","Environmental Hazard - Camp Lejeune","Environmental Hazard – Camp Lejeune – Louisville","Environmental Hazard in Gulf War","Extra-Schedular 3.321(b)(1)","Extra-Schedular IU 4.16(b)","FDC Excluded - Additional Claim Submitted","FDC Excluded - All Required Items Not Submitted","FDC Excluded - Appeal Pending","FDC Excluded - Appeal submitted","FDC Excluded - Claim Pending","FDC Excluded - Claimant Declined FDC Processing","FDC Excluded - Evidence Received After FDC CEST","FDC Excluded - FDC Certification Incomplete","FDC Excluded - FTR to Examination","FDC Excluded - Necessary Form(s) not Submitted","FDC Excluded - Needs Non-Fed Evidence Development","FDC Excluded - requires INDPT VRFCTN of FTI","Fed Record Delay - No Further Dev","Force Majeure","Fully Developed Claim","Gulf War Presumptive","HIV","Hepatitis C","Hospital Adjustment Action Plan FY 18/19","IDES Deferral","JSRRC Request","Local Hearing","Local Mentor Review","Local Quality Review","Local Quality Review IPR","Medical Foster Home","Military Sexual Trauma (MST)","MQAS Separation and Severance Pay Audit","Mustard Gas","National Quality Review","Nehmer AO Peripheral Neuropathy","Nehmer Phase II","Non-ADL Notification Letter","Non-Nehmer AO Peripheral Neuropathy","Non-PTSD Personal Trauma","Potential Under/Overpayment","POW","PTSD - Combat","PTSD - Non-Combat","PTSD - Personal Trauma","RO Special issue 1","RO Special issue 2","RO Special Issue 3","RO Special Issue 4","RO Special Issue 5","RO Special Issue 6","RO Special Issue 7","RO Special Issue 8","RO Special Issue 9","RVSR Examination","Radiation","Radiation Radiogenic Disability Confirmed","Rating Decision Review - Level 1","Rating Decision Review - Level 2","Ready for Exam","Same Station Review","SHAD","Sarcoidosis","Simultaneous Award Adjustment Not Permitted","Specialized Records Request","Stage 1 Development","Stage 2 Development","Stage 3 Development","TBI Exam Review","Temp 100 Convalescence","Temp 100 Hospitalization","Tobacco","Tort Claim","Traumatic Brain Injury","Upfront Verification","VACO Special issue 1","VACO Special issue 2","VACO Special Issue 3","VACO Special Issue 4","VACO Special Issue 5","VACO Special Issue 6","VACO Special Issue 7","VACO Special Issue 8","VACO Special Issue 9","VASRD-Cardiovascular","VASRD-Dental","VASRD-Digestive","VASRD-Endocrine","VASRD-Eye","VASRD-GU","VASRD-GYN","VASRD-Hemic","VASRD-Infectious","VASRD-Mental","VASRD-Musculoskeletal","VASRD-Neurological","VASRD-Respiratory/Auditory","VASRD-Skin","Vendor Exclusion - No Diagnosis","VONAPP Direct Connect","WARTAC","WARTAC Trainee"]},"example":"ALS"},"classificationCode":{"type":"string","example":"249470"},"approximateBeginDate":{"description":"Approximate date disability began.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-03-02"}}}}},"allOf":[{"if":{"properties":{"disabilityActionType":{"enum":["INCREASE"]}}},"then":{"required":["ratedDisabilityId","diagnosticCode"]}},{"if":{"properties":{"disabilityActionType":{"enum":["NONE"]}},"required":["secondaryDisabilities"]},"then":{"required":["diagnosticCode"]}}]}},"treatments":{"description":"Identifies the Service Treatment information of the Veteran.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"startDate":{"description":"Date Veteran started treatment.","type":["null","string"],"pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02, 2018-03, or 2018"},"endDate":{"description":"Date Veteran ended treatment.","type":["null","string"],"pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02, 2018-03, or 2018"},"treatedDisabilityNames":{"description":"Names of any disabilities for which the Veteran was treated.","type":["array","null"],"maxItems":101,"uniqueItems":true,"items":{"description":"Name of Disabilities Veteran was Treated for.","type":"string","example":"PTSD (post traumatic stress disorder)"}},"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","additionalProperties":false,"properties":{"name":{"description":"Name of facility Veteran was treated in.","type":"string","pattern":"([a-zA-Z0-9\"\\/&\\(\\)\\-'.,# ]([a-zA-Z0-9(\\)\\-'.,# ])?)+$","example":"Private Facility 2"},"country":{"description":"Country Veteran was treated in.","minLength":1,"maxLength":50,"type":"string","example":"USA"}}}}}},"servicePay":{"description":"Details about Veteran receiving Service Pay from DoD.","type":"object","additionalProperties":false,"properties":{"waiveVABenefitsToRetainTrainingPay":{"description":"Is Veteran Waiving benefits to retain training pay.","type":"boolean","example":true},"waiveVABenefitsToRetainRetiredPay":{"description":"Is Veteran Waiving benefits to retain Retiree pay.","type":"boolean","example":true},"militaryRetiredPay":{"description":"Retirement Pay information from Military Service.","type":"object","additionalProperties":false,"required":["receiving","payment"],"properties":{"receiving":{"description":"Is Veteran getting Retiree pay?","type":"boolean","example":true},"willReceiveInFuture":{"description":"Will Veteran get Retiree pay in future?  \n If true, then \"futurePayExplanation\" attribute is required.","type":"boolean","default":false,"example":false},"payment":{"description":"Part of DoD paying Retirement Benefits.","type":"object","additionalProperties":false,"required":["serviceBranch"],"properties":{"serviceBranch":{"description":"Branch of Service making payments.","type":"string","enum":["Air Force","Air Force Reserves","Air National Guard","Army","Army National Guard","Army Reserves","Coast Guard","Coast Guard Reserves","Marine Corps","Marine Corps Reserves","National Oceanic &amp; Atmospheric Administration","National Oceanic & Atmospheric Administration","Navy","Navy Reserves","Public Health Service","Air Force Academy","Army Air Corps or Army Air Force","Army Nurse Corps","Coast Guard Academy","Merchant Marine","Naval Academy","Other","US Military Academy","Women's Army Corps","Space Force"],"example":"Air Force"},"amount":{"description":"Amount being received.","type":"number","example":100}}},"futurePayExplanation":{"description":"Explains why future pay will be received.","type":"string","example":"Will be retiring soon."}}},"separationPay":{"description":"Details about separation pay.","type":"object","additionalProperties":false,"required":["received"],"properties":{"received":{"description":"Has separation pay been received?","type":"boolean","example":true,"default":true},"payment":{"description":"Separation pay payment details.","type":"object","additionalProperties":false,"properties":{"serviceBranch":{"description":"Branch of Service making payments.","type":"string","enum":["Air Force","Air Force Reserves","Air National Guard","Army","Army National Guard","Army Reserves","Coast Guard","Coast Guard Reserves","Marine Corps","Marine Corps Reserves","National Oceanic &amp; Atmospheric Administration","National Oceanic & Atmospheric Administration","Navy","Navy Reserves","Public Health Service","Air Force Academy","Army Air Corps or Army Air Force","Army Nurse Corps","Coast Guard Academy","Merchant Marine","Naval Academy","Other","US Military Academy","Women's Army Corps","Space Force"],"example":"Air Force"},"amount":{"description":"Amount being received.","type":"number","example":100}}},"receivedDate":{"description":"Approximate date separation pay was received.","type":"string","pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02, 2018-03, or 2018"}}}}},"directDeposit":{"description":"Financial Direct Deposit information for Veteran.","type":"object","additionalProperties":false,"properties":{"accountType":{"description":"Veteran Account Type (value is case insensitive).","type":"string","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"accountNumber":{"description":"Veteran Bank Account Number.","minLength":4,"maxLength":17,"type":"string","example":"123123123123"},"routingNumber":{"description":"Veteran Bank Routing Number.","type":"string","pattern":"^\\d{9}$","example":"123123123"},"bankName":{"description":"Provide the name of the bank where the Veteran wants the direct deposit.","maxLength":35,"type":"string","example":"Some Bank"}}},"claimantCertification":{"description":"Determines if person submitting the claim is certified to do so.","type":"boolean","example":true},"standardClaim":{"description":"A value of false indicates the claim should be processed as a Fully Developed Claim.","type":"boolean","example":false},"applicationExpirationDate":{"description":"Time stamp of when claim expires.  If not provided, value will be set to 1 year in the future from current day.","type":"string","example":"2018-08-28T19:53:45+00:00"},"autoCestPDFGenerationDisabled":{"description":"Allows you to bypass the auto PDF generation and instead upload the Disability form itself through Support Documents.","type":"boolean","example":false},"claimDate":{"description":"Date (or Timestamp with TimeZone) when claim is being submitted to the VA. Date cannot be in the future. UTC TimeZone is assumed unless otherwise specified.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])(?:T[0-1][0-9]:[0-5][0-9]:[0-5][0-9](?:[-+][0-9]{2}:[0-9]{2}|Z))*$","example":"2018-08-28T19:53:45+00:00"}}}}}}}}},"required":true}}},"/forms/526/{id}":{"put":{"summary":"Upload a 526 document","tags":["Disability"],"operationId":"PUT:/forms/526/{id}","security":[{"productionOauth":["claim.read","claim.write"]},{"sandboxOauth":["claim.read","claim.write"]},{"bearer_token":[]}],"description":"Used to upload a completed, signed 526 PDF to establish an original claim. Use this endpoint only after following the instructions in the POST /forms/526 endpoint to begin the claim submission.\n<br/><br/>\nThis endpoint works by accepting a document binary PDF as part of a multi-part payload (for example, attachment1, attachment2, attachment3). Each attachment should be encoded separately rather than encoding the whole payload together as with the Benefits Intake API.\n<br/><br/>\nFor other attachments, such as medical records, use the /forms/526/{id}/attachments endpoint.\n\n","parameters":[{"name":"id","in":"path","description":"UUID given when Disability Claim was submitted","required":true,"schema":{"type":"string"}},{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"526 Response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000006","type":"claims_api_claim","attributes":{"evss_id":null,"open":true,"waiver_submitted":null,"requested_decision":null,"claim_type":null,"updated_at":"2024-01-01T00:00:00.000Z","date_filed":null,"min_est_date":null,"max_est_date":null,"development_letter_sent":null,"decision_letter_sent":null,"documents_needed":null,"contention_list":null,"events_timeline":[],"va_representative":null,"phase":null,"phase_change_date":null,"ever_phase_back":null,"current_phase_back":null,"token":"00000000-0000-0000-0000-000000000007","status":"pending","flashes":[]}}},"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":"Internal vets-api Claim ID"},"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["open","updated_at","events_timeline","token","status","flashes"],"properties":{"evss_id":{"type":"integer","nullable":true,"description":"EVSS Claim ID"},"date_filed":{"type":"string","nullable":true,"format":"date","description":"Date in YYYY-MM-DD the claim was first filed"},"min_est_date":{"type":"string","nullable":true,"format":"date","description":"Minimum Estimated Claim Completion Date"},"max_est_date":{"type":"string","nullable":true,"format":"date","description":"Maximum Estimated Claim Completion Date"},"phase_change_date":{"type":"string","nullable":true,"format":"date","description":"Date of last phase change"},"open":{"type":"boolean","description":"Has the claim been resolved"},"waiver_submitted":{"type":"boolean","nullable":true,"description":"Requested Decision or Waiver 5103 Submitted"},"documents_needed":{"type":"boolean","nullable":true,"description":"Does the claim require additional documents to be submitted"},"development_letter_sent":{"type":"boolean","nullable":true,"description":"Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim"},"decision_letter_sent":{"type":"boolean","nullable":true,"description":"Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim"},"phase":{"type":"string","nullable":true},"ever_phase_back":{"type":"string","nullable":true},"current_phase_back":{"type":"string","nullable":true},"requested_decision":{"type":"string","nullable":true,"description":"The claim filer has requested a claim decision be made"},"claim_type":{"type":"string","nullable":true,"description":"The type of claim originally submitted"},"updated_at":{"type":"string","format":"date","description":"Time stamp of last change to the claim"},"contention_list":{"type":"array","nullable":true},"va_representative":{"type":"string","nullable":true},"events_timeline":{"type":"array"},"token":{"type":"string"},"status":{"type":"string","enum":["pending"],"description":"Current status of the claim"},"flashes":{"type":"array","items":{"type":"string"}}}}}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"errors":[{"title":"Missing parameter","detail":"Must include attachment","code":"108","status":"400"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"Resource not found","code":"404","status":"404"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":"            Claim submission requires that the \"autoCestPDFGenerationDisabled\" field\n            must be set to \"true\" in order to allow a 526 PDF to be uploaded\n","code":"422","status":"422"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachment":{"type":"file","description":"Attachment contents. Must be provided in binary PDF or [base64 string](https://va.ghe.com/software/vets-api/blob/master/modules/claims_api/spec/fixtures/base64pdf) format and less than 11 in x 11 in.\n"}}}}},"required":true}}},"/forms/526/validate":{"post":{"summary":"Validates a 526 claim form submission.","deprecated":true,"tags":["Disability"],"operationId":"POST:/forms/526/validate","security":[{"productionOauth":["claim.read","claim.write"]},{"sandboxOauth":["claim.read","claim.write"]},{"bearer_token":[]}],"description":"Test to make sure the form submission works with your parameters.\nSubmission validates against the schema returned by the GET /forms/526 endpoint.\n","parameters":[{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"526 Response","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","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":[{"status":422,"detail":"The property / did not contain the required key veteran","source":"/"},{"status":422,"detail":"The property / did not contain the required key serviceInformation","source":"/"},{"status":422,"detail":"The property / did not contain the required key disabilities","source":"/"},{"status":422,"detail":"The property / did not contain the required key standardClaim","source":"/"},{"status":422,"detail":"The property / did not contain the required key autoCestPDFGenerationDisabled","source":"/"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["status","detail","source"],"properties":{"status":{"type":"integer","description":"HTTP error code"},"detail":{"type":"string","description":"HTTP error detail"},"source":{"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"],"example":{"type":"form/526","attributes":{"veteran":{"currentlyVAEmployee":false,"currentMailingAddress":{"city":"Portland","country":"USA","zipFirstFive":"12345","addressLine1":"1234 Couch Street","addressLine2":"Apt. 22","type":"DOMESTIC","zipLastFour":"6789","state":"OR"}},"claimantCertification":true,"disabilities":[{"ratedDisabilityId":"1100583","diagnosticCode":9999,"disabilityActionType":"NEW","name":"PTSD (post traumatic stress disorder)","specialIssues":["Asbestos"],"secondaryDisabilities":[{"name":"PTSD personal trauma","disabilityActionType":"SECONDARY","serviceRelevance":"Caused by a service-connected disability\\nLengthy description"}]}],"standardClaim":false,"autoCestPDFGenerationDisabled":false,"applicationExpirationDate":"2015-08-28T19:53:45+00:00","serviceInformation":{"servicePeriods":[{"activeDutyEndDate":"1990-01-02","serviceBranch":"Air Force","activeDutyBeginDate":"1980-02-05"},{"activeDutyEndDate":"1999-01-01","serviceBranch":"Air Force Reserves","activeDutyBeginDate":"1990-04-05"}]}}},"properties":{"attributes":{"$schema":"http://json-schema.org/draft-07/schema#","description":"Claims API 526 Schema","type":"object","additionalProperties":false,"required":["veteran","serviceInformation","disabilities","standardClaim","autoCestPDFGenerationDisabled"],"properties":{"veteran":{"description":"Veteran Object being submitted in Claim","type":"object","additionalProperties":false,"required":["currentMailingAddress","currentlyVAEmployee"],"properties":{"flashes":{"description":"Attributes that describe special circumstances which apply to a Veteran.","type":"array","items":{"type":"string","enum":["Agent Orange - Vietnam","Amyotrophic Lateral Sclerosis","Blind","Blue Water Navy","Formerly Homeless","GW Undiagnosed Illness","Hardship","Homeless","Medal of Honor","POW","Priority Processing - Veteran over age 85","Purple Heart","Seriously Injured/Very Seriously Injured","Specially Adapted Housing Claimed","Terminally Ill"]},"example":"Hardship"},"currentlyVAEmployee":{"type":"boolean","description":"Flag if Veteran is VA Employee.","example":false},"currentMailingAddress":{"description":"Current Mailing Address Object being submitted.","type":"object","additionalProperties":false,"properties":{"addressLine1":{"description":"Address Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30,"example":"1234 Couch Street"},"addressLine2":{"description":"Additional Address Information Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":10,"example":"Apt. 22"},"addressLine3":{"description":"Additional Address Information Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":10,"example":"Box 123"},"city":{"description":"City Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.#]([-a-zA-Z0-9'.# ])?)+$","maxLength":20,"example":"Portland"},"country":{"description":"Country Veteran resides in.  Value must match the values returned by the \"/countries\" endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"USA"},"zipFirstFive":{"description":"Zipcode (First 5 digits) Veteran resides in.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"Zipcode (Last 4 digits) Veteran resides in.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"internationalPostalCode":{"type":"string"},"type":{"description":"Type of residence Veteran resides in.  \n If value is \"INTERNATIONAL\", then \"addressLine1\", \"city\", \"country\", and \"internationalPostalCode\" are required.  \n If value is \"DOMESTIC\", then \"addressLine1\", \"city\", \"state\", \"country\", and \"zipFirstFive\" are required.  \n If value is \"MILITARY\", then \"addressLine1\", \"country\", \"militaryStateCode\", \"militaryPostOfficeTypeCode\", and \"zipFirstFive\" are required.","type":"string","default":"DOMESTIC","enum":["INTERNATIONAL","MILITARY","DOMESTIC"],"example":"DOMESTIC"},"state":{"description":"State or province Veteran resides in.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"}},"allOf":[{"if":{"properties":{"type":{"const":"INTERNATIONAL"}}},"then":{"required":["addressLine1","city","country","type","internationalPostalCode"]}},{"if":{"properties":{"type":{"const":"DOMESTIC"}}},"then":{"required":["addressLine1","city","country","zipFirstFive","type","state"]}},{"if":{"properties":{"type":{"const":"MILITARY"}}},"then":{"required":["addressLine1","country","zipFirstFive","militaryStateCode","militaryPostOfficeTypeCode","type"]}}]},"changeOfAddress":{"description":"A Change of Address Object being submitted.","type":"object","additionalProperties":false,"required":["country","type","addressLine1","addressChangeType","beginningDate"],"properties":{"beginningDate":{"description":"Date in YYYY-MM-DD the Veteran changed address. Date must be in the future if change is temporary.","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","type":"string","example":"2018-06-04"},"endingDate":{"description":"Date in YYYY-MM-DD the changed address expires, if change is temporary.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-06-04"},"addressChangeType":{"description":"Temporary or Permanent change of address.","type":"string","example":"PERMANENT"},"addressLine1":{"description":"New Address Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30,"example":"1234 Couch Street"},"addressLine2":{"description":"New Additional Address Information Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$","maxLength":30,"example":"Apt. 22"},"city":{"description":"New city Veteran resides in.","type":"string","pattern":"^([-a-zA-Z0-9'.#]([-a-zA-Z0-9'.# ])?)+$","maxLength":20,"example":"Portland"},"country":{"description":"New country Veteran resides in. Value must match the values returned by the \"/countries\" endpoint on the [Benefits Reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"USA"},"zipFirstFive":{"description":"New zipcode (First 5 digits) Veteran resides in.","type":"string","pattern":"^\\d{5}?$","example":"12345"},"zipLastFour":{"description":"New zipcode (Last 4 digits) Veteran resides in.","type":"string","pattern":"^\\d{4}?$","example":"6789"},"internationalPostalCode":{"type":"string"},"type":{"description":"New type of residence Veteran resides in.  \n If value is \"INTERNATIONAL\", then \"city\" and \"internationalPostalCode\" are required.  \n If value is \"DOMESTIC\", then \"city\", \"state\", and \"zipFirstFive\" are required.  \n If value is \"MILITARY\", then \"militaryStateCode\", \"militaryPostOfficeTypeCode\", and \"zipFirstFive\" are required.","type":"string","default":"DOMESTIC","enum":["INTERNATIONAL","MILITARY","DOMESTIC"],"example":"DOMESTIC"},"militaryStateCode":{"type":"string"},"militaryPostOfficeTypeCode":{"type":"string"},"state":{"description":"New state or province Veteran resides in.","type":"string","pattern":"^[a-z,A-Z]{2}$","example":"OR"}},"allOf":[{"if":{"properties":{"type":{"const":"INTERNATIONAL"}}},"then":{"required":["city","internationalPostalCode"]}},{"if":{"properties":{"type":{"const":"DOMESTIC"}}},"then":{"required":["city","zipFirstFive","state"]}},{"if":{"properties":{"type":{"const":"MILITARY"}}},"then":{"required":["zipFirstFive","militaryStateCode","militaryPostOfficeTypeCode"]}}]},"homelessness":{"description":"Object describing Veteran Homelessness if applicable.","type":"object","additionalProperties":false,"properties":{"pointOfContact":{"description":"Object describing Homeless Veteran Point of Contact.","type":"object","additionalProperties":false,"required":["pointOfContactName","primaryPhone"],"properties":{"pointOfContactName":{"description":"Point of contact in direct contact with Veteran.","type":"string","minLength":1,"maxLength":100,"pattern":"^([-a-zA-Z0-9/']+( ?))*$","example":"Jane Doe"},"primaryPhone":{"description":"Phone Number Object for Point of Contact.","type":"object","additionalProperties":false,"required":["areaCode","phoneNumber"],"properties":{"areaCode":{"description":"Area code of Point of Contact.","type":"string","example":"555"},"phoneNumber":{"description":"Primary phone of Point of Contact.","type":"string","example":"5555555"}}}}},"currentlyHomeless":{"type":"object","additionalProperties":false,"required":["homelessSituationType","otherLivingSituation"],"properties":{"homelessSituationType":{"description":"Current state of the veteran's homelessness.","type":"string","default":"other","enum":["fleeing","shelter","notShelter","anotherPerson","other"],"example":"fleeing"},"otherLivingSituation":{"description":"For a 'homelessSituationType' of value 'other', please provide additional comments on the living situation.","type":"string","maxLength":500,"example":"other living situation"}}},"homelessnessRisk":{"type":"object","additionalProperties":false,"required":["homelessnessRiskSituationType","otherLivingSituation"],"properties":{"homelessnessRiskSituationType":{"type":"string","default":"other","enum":["losingHousing","leavingShelter","other"]},"otherLivingSituation":{"description":"For a 'homelessnessRiskSituationType' of value 'other', please provide additional comments on the living situation.","type":"string","maxLength":500,"example":"other living situation"}}}}},"isTerminallyIll":{"type":"boolean"}}},"serviceInformation":{"description":"Overview of Veteran's service history.","type":"object","additionalProperties":false,"required":["servicePeriods"],"properties":{"servicePeriods":{"description":"Identifies the Service dates and Branch the Veteran served in.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["serviceBranch","activeDutyBeginDate","activeDutyEndDate"],"properties":{"serviceBranch":{"description":"Branch of Service during period.","type":"string","example":"Air Force","enum":["Air Force","Air Force Academy","Air Force Reserves","Air Force Civilian","Air National Guard","Army","Army Air Corps","Army Air Corps or Army Air Force","Army National Guard","Army Nurse Corps","Army Reserves","Coast Guard","Coast Guard Academy","Coast Guard Reserves","Commonwealth Army Veteran","Guerrilla Combination Service","Marine","Marine Corps","Marine Corps Reserves","Merchant Marine","National Oceanic & Atmospheric Administration","National Oceanic and Atmospheric Administration","Naval Academy","Navy","Navy Reserves","Other","Public Health Service","Regular Philippine Scout","Regular Scout Service","Space Force","Special Philippine Scout","Unknown","US Military Academy","Woman Air Corps","Women's Army Corps"]},"activeDutyBeginDate":{"description":"Date Started Active Duty. This date must be in the past.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"1980-02-05"},"activeDutyEndDate":{"description":"Date Completed Active Duty. Cannot be more than 180 days in the future, unless past service is also included.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"1990-01-02"},"separationLocationCode":{"description":"Code for the facility the Veteran plans to separate from. Code must match the values returned by the /intake-sites endpoint on the [Benefits reference Data API](https://developer.va.gov/explore/benefits/docs/benefits_reference_data?version=current).","type":"string","example":"98283"}}}},"confinements":{"description":"Used if the Veteran was ever a prisoner of war.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["confinementBeginDate","confinementEndDate"],"properties":{"confinementBeginDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"confinementEndDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"}}}},"reservesNationalGuardService":{"type":"object","additionalProperties":false,"required":["obligationTermOfServiceFromDate","obligationTermOfServiceToDate"],"properties":{"title10Activation":{"description":"Include if the Veteran is currently activated on federal orders within the National Guard or Reserves","type":"object","additionalProperties":false,"required":["anticipatedSeparationDate","title10ActivationDate"],"properties":{"anticipatedSeparationDate":{"description":"Anticipated date of separation. Date must be in the future.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"title10ActivationDate":{"description":"Date cannot be in the future and must be after the earliest servicePeriod.activeDutyBeginDate.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"}}},"obligationTermOfServiceFromDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"obligationTermOfServiceToDate":{"type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$"},"unitName":{"type":"string","pattern":"([a-zA-Z0-9\\-'.,# ][a-zA-Z0-9\\-'.,# ]?)*$"},"unitPhone":{"type":"object","additionalProperties":false,"required":["areaCode","phoneNumber"],"properties":{"areaCode":{"type":"string","example":"555"},"phoneNumber":{"type":"string","example":"5555555"}}},"receivingInactiveDutyTrainingPay":{"type":"boolean"}}},"alternateNames":{"description":"List any other names under which the Veteran served, if applicable.","type":"array","minItems":1,"maxItems":100,"items":{"type":"object","additionalProperties":false,"required":["firstName","lastName"],"properties":{"firstName":{"type":"string","min":1,"max":30,"pattern":"^([-a-zA-Z0-9/']+( ?))+$"},"middleName":{"type":"string","min":1,"max":30,"pattern":"^([-a-zA-Z0-9/']+( ?))+$"},"lastName":{"type":"string","min":1,"max":30,"pattern":"^([-a-zA-Z0-9/']+( ?))+$"}}}}}},"disabilities":{"description":"Any current disabilities or symptoms the Veteran is claiming are related to their military service and/or are service-connected.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["disabilityActionType","name"],"properties":{"specialIssues":{"description":"The special issues related to the disability. Note :: Only add special issues that you are certain about.  Incorrect special issues can lead to processing delays or denials.  [See special issue descriptions.](https://www.knowva.ebenefits.va.gov/system/templates/selfservice/va_ssnew/help/customer/locale/en-US/portal/554400000001018/content/554400000179710/Appendix-E-Index-of-Corporate-Flashes-and-Special-Issues#2b)","type":"array","items":{"type":"string","enum":["ALS","HEPC","PTSD/1","PTSD/2","PTSD/3","PTSD/4","MST","38 USC 1151","ABA Election","Abandoned VDC Claim","AMC NOD Brokering Project","Administrative Decision Review - Level 1","Administrative Decision Review - Level 2","Agent Orange - Vietnam","Agent Orange - outside Vietnam or unknown","AMA SOC/SSOC Opt-In","Amyotrophic Lateral Sclerosis (ALS)","Annual Eligibility Report","Asbestos","AutoEstablish","Automated Drill Pay Adjustment","Automated Return to Active Duty","BDD – Excluded","Brokered - D1BC","Brokered - Internal","Burn Pit Exposure","C-123","COWC","Character of Discharge","Challenge","ChemBio","Claimant Service Verification Accepted","Combat Related Death","Compensation Service Review – AO Outside RVN & Ship","Compensation Service Review - Equitable Relief","Compensation Service Review - Extraschedular","Compensation Service Review – MG/CBRNE/Shad","Compensation Service Review - Opinion","Compensation Service Review - Over $25K","Compensation Service Review - POW","Compensation Service Review - Radiation","Decision Ready Claim","Decision Ready Claim - Deferred","Decision Ready Claim - Partial Deferred","Disability Benefits Questionnaire - Private","Disability Benefits Questionnaire - VA","DRC – Exam Review Complete Approved","DRC – Exam Review Complete Disapproved","DRC – Pending File Scan","DRC – Vendor Exam Recommendation","DTA Error – Exam/MO","DTA Error – Fed Recs","DTA Error – Other Recs","DTA Error – PMRs","Emergency Care – CH17 Determination","Enhanced Disability Severance Pay","Environmental Hazard - Camp Lejeune","Environmental Hazard – Camp Lejeune – Louisville","Environmental Hazard in Gulf War","Extra-Schedular 3.321(b)(1)","Extra-Schedular IU 4.16(b)","FDC Excluded - Additional Claim Submitted","FDC Excluded - All Required Items Not Submitted","FDC Excluded - Appeal Pending","FDC Excluded - Appeal submitted","FDC Excluded - Claim Pending","FDC Excluded - Claimant Declined FDC Processing","FDC Excluded - Evidence Received After FDC CEST","FDC Excluded - FDC Certification Incomplete","FDC Excluded - FTR to Examination","FDC Excluded - Necessary Form(s) not Submitted","FDC Excluded - Needs Non-Fed Evidence Development","FDC Excluded - requires INDPT VRFCTN of FTI","Fed Record Delay - No Further Dev","Force Majeure","Fully Developed Claim","Gulf War Presumptive","HIV","Hepatitis C","Hospital Adjustment Action Plan FY 18/19","IDES Deferral","JSRRC Request","Local Hearing","Local Mentor Review","Local Quality Review","Local Quality Review IPR","Medical Foster Home","Military Sexual Trauma (MST)","MQAS Separation and Severance Pay Audit","Mustard Gas","National Quality Review","Nehmer AO Peripheral Neuropathy","Nehmer Phase II","Non-ADL Notification Letter","Non-Nehmer AO Peripheral Neuropathy","Non-PTSD Personal Trauma","Potential Under/Overpayment","POW","PTSD - Combat","PTSD - Non-Combat","PTSD - Personal Trauma","RO Special issue 1","RO Special issue 2","RO Special Issue 3","RO Special Issue 4","RO Special Issue 5","RO Special Issue 6","RO Special Issue 7","RO Special Issue 8","RO Special Issue 9","RVSR Examination","Radiation","Radiation Radiogenic Disability Confirmed","Rating Decision Review - Level 1","Rating Decision Review - Level 2","Ready for Exam","RRD","Same Station Review","SHAD","Sarcoidosis","Simultaneous Award Adjustment Not Permitted","Specialized Records Request","Stage 1 Development","Stage 2 Development","Stage 3 Development","TBI Exam Review","Temp 100 Convalescence","Temp 100 Hospitalization","Tobacco","Tort Claim","Traumatic Brain Injury","Upfront Verification","VACO Special issue 1","VACO Special issue 2","VACO Special Issue 3","VACO Special Issue 4","VACO Special Issue 5","VACO Special Issue 6","VACO Special Issue 7","VACO Special Issue 8","VACO Special Issue 9","VASRD-Cardiovascular","VASRD-Dental","VASRD-Digestive","VASRD-Endocrine","VASRD-Eye","VASRD-GU","VASRD-GYN","VASRD-Hemic","VASRD-Infectious","VASRD-Mental","VASRD-Musculoskeletal","VASRD-Neurological","VASRD-Respiratory/Auditory","VASRD-Skin","Vendor Exclusion - No Diagnosis","VONAPP Direct Connect","WARTAC","WARTAC Trainee"]},"example":"ALS"},"ratedDisabilityId":{"description":"The Type of Disability.","type":"string","example":"1100583"},"diagnosticCode":{"description":"Specific Diagnostic Code.","type":"integer","example":9999},"disabilityActionType":{"description":"The status of the current disability.  \n If value is \"INCREASE\", then \"ratedDisabilityId\" and \"diagnosticCode\" are required.","type":"string","enum":["NONE","NEW","INCREASE"],"example":"NEW"},"name":{"description":"What the Disability is called.\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},"classificationCode":{"type":"string","example":"249470"},"approximateBeginDate":{"description":"Approximate date disability began. Date must be in the past.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-03-02"},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","example":"Heavy equipment operator in service."},"secondaryDisabilities":{"description":"Identifies the Secondary Service Disability information of the Veteran.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"required":["name","disabilityActionType","serviceRelevance"],"properties":{"name":{"description":"What the Disability is called.","type":"string","pattern":"^[a-zA-Z0-9'\",.#&;:%<>/()\\[\\]\\\\ -]+$","maxLength":255,"example":"PTSD"},"disabilityActionType":{"description":"The status of the secondary disability.","type":"string","enum":["SECONDARY"],"example":"SECONDARY"},"serviceRelevance":{"description":"Explanation of how the disability(ies) relates to the in-service event/exposure/injury.","type":"string","example":"Heavy equipment operator in service."},"specialIssues":{"description":"The special issues related to the disability. Note :: Only add special issues that you are certain about.  Incorrect special issues can lead to processing delays or denials.  [See special issue descriptions.](https://www.knowva.ebenefits.va.gov/system/templates/selfservice/va_ssnew/help/customer/locale/en-US/portal/554400000001018/content/554400000179710/Appendix-E-Index-of-Corporate-Flashes-and-Special-Issues?query=special%20issues#2b)","type":"array","items":{"type":"string","enum":["ALS","HEPC","PTSD/1","PTSD/2","PTSD/3","PTSD/4","MST","38 USC 1151","ABA Election","Abandoned VDC Claim","AMC NOD Brokering Project","Administrative Decision Review - Level 1","Administrative Decision Review - Level 2","Agent Orange - Vietnam","Agent Orange - outside Vietnam or unknown","AMA SOC/SSOC Opt-In","Amyotrophic Lateral Sclerosis (ALS)","Annual Eligibility Report","Asbestos","AutoEstablish","Automated Drill Pay Adjustment","Automated Return to Active Duty","BDD – Excluded","Brokered - D1BC","Brokered - Internal","Burn Pit Exposure","C-123","COWC","Character of Discharge","Challenge","ChemBio","Claimant Service Verification Accepted","Combat Related Death","Compensation Service Review – AO Outside RVN & Ship","Compensation Service Review - Equitable Relief","Compensation Service Review - Extraschedular","Compensation Service Review – MG/CBRNE/Shad","Compensation Service Review - Opinion","Compensation Service Review - Over $25K","Compensation Service Review - POW","Compensation Service Review - Radiation","Decision Ready Claim","Decision Ready Claim - Deferred","Decision Ready Claim - Partial Deferred","Disability Benefits Questionnaire - Private","Disability Benefits Questionnaire - VA","DRC – Exam Review Complete Approved","DRC – Exam Review Complete Disapproved","DRC – Pending File Scan","DRC – Vendor Exam Recommendation","DTA Error – Exam/MO","DTA Error – Fed Recs","DTA Error – Other Recs","DTA Error – PMRs","Emergency Care – CH17 Determination","Enhanced Disability Severance Pay","Environmental Hazard - Camp Lejeune","Environmental Hazard – Camp Lejeune – Louisville","Environmental Hazard in Gulf War","Extra-Schedular 3.321(b)(1)","Extra-Schedular IU 4.16(b)","FDC Excluded - Additional Claim Submitted","FDC Excluded - All Required Items Not Submitted","FDC Excluded - Appeal Pending","FDC Excluded - Appeal submitted","FDC Excluded - Claim Pending","FDC Excluded - Claimant Declined FDC Processing","FDC Excluded - Evidence Received After FDC CEST","FDC Excluded - FDC Certification Incomplete","FDC Excluded - FTR to Examination","FDC Excluded - Necessary Form(s) not Submitted","FDC Excluded - Needs Non-Fed Evidence Development","FDC Excluded - requires INDPT VRFCTN of FTI","Fed Record Delay - No Further Dev","Force Majeure","Fully Developed Claim","Gulf War Presumptive","HIV","Hepatitis C","Hospital Adjustment Action Plan FY 18/19","IDES Deferral","JSRRC Request","Local Hearing","Local Mentor Review","Local Quality Review","Local Quality Review IPR","Medical Foster Home","Military Sexual Trauma (MST)","MQAS Separation and Severance Pay Audit","Mustard Gas","National Quality Review","Nehmer AO Peripheral Neuropathy","Nehmer Phase II","Non-ADL Notification Letter","Non-Nehmer AO Peripheral Neuropathy","Non-PTSD Personal Trauma","Potential Under/Overpayment","POW","PTSD - Combat","PTSD - Non-Combat","PTSD - Personal Trauma","RO Special issue 1","RO Special issue 2","RO Special Issue 3","RO Special Issue 4","RO Special Issue 5","RO Special Issue 6","RO Special Issue 7","RO Special Issue 8","RO Special Issue 9","RVSR Examination","Radiation","Radiation Radiogenic Disability Confirmed","Rating Decision Review - Level 1","Rating Decision Review - Level 2","Ready for Exam","Same Station Review","SHAD","Sarcoidosis","Simultaneous Award Adjustment Not Permitted","Specialized Records Request","Stage 1 Development","Stage 2 Development","Stage 3 Development","TBI Exam Review","Temp 100 Convalescence","Temp 100 Hospitalization","Tobacco","Tort Claim","Traumatic Brain Injury","Upfront Verification","VACO Special issue 1","VACO Special issue 2","VACO Special Issue 3","VACO Special Issue 4","VACO Special Issue 5","VACO Special Issue 6","VACO Special Issue 7","VACO Special Issue 8","VACO Special Issue 9","VASRD-Cardiovascular","VASRD-Dental","VASRD-Digestive","VASRD-Endocrine","VASRD-Eye","VASRD-GU","VASRD-GYN","VASRD-Hemic","VASRD-Infectious","VASRD-Mental","VASRD-Musculoskeletal","VASRD-Neurological","VASRD-Respiratory/Auditory","VASRD-Skin","Vendor Exclusion - No Diagnosis","VONAPP Direct Connect","WARTAC","WARTAC Trainee"]},"example":"ALS"},"classificationCode":{"type":"string","example":"249470"},"approximateBeginDate":{"description":"Approximate date disability began.","type":"string","pattern":"^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$","example":"2018-03-02"}}}}},"allOf":[{"if":{"properties":{"disabilityActionType":{"enum":["INCREASE"]}}},"then":{"required":["ratedDisabilityId","diagnosticCode"]}},{"if":{"properties":{"disabilityActionType":{"enum":["NONE"]}},"required":["secondaryDisabilities"]},"then":{"required":["diagnosticCode"]}}]}},"treatments":{"description":"Identifies the Service Treatment information of the Veteran.","type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","additionalProperties":false,"properties":{"startDate":{"description":"Date Veteran started treatment.","type":["null","string"],"pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02, 2018-03, or 2018"},"endDate":{"description":"Date Veteran ended treatment.","type":["null","string"],"pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02, 2018-03, or 2018"},"treatedDisabilityNames":{"description":"Names of any disabilities for which the Veteran was treated.","type":["array","null"],"maxItems":101,"uniqueItems":true,"items":{"description":"Name of Disabilities Veteran was Treated for.","type":"string","example":"PTSD (post traumatic stress disorder)"}},"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","additionalProperties":false,"properties":{"name":{"description":"Name of facility Veteran was treated in.","type":"string","pattern":"([a-zA-Z0-9\"\\/&\\(\\)\\-'.,# ]([a-zA-Z0-9(\\)\\-'.,# ])?)+$","example":"Private Facility 2"},"country":{"description":"Country Veteran was treated in.","minLength":1,"maxLength":50,"type":"string","example":"USA"}}}}}},"servicePay":{"description":"Details about Veteran receiving Service Pay from DoD.","type":"object","additionalProperties":false,"properties":{"waiveVABenefitsToRetainTrainingPay":{"description":"Is Veteran Waiving benefits to retain training pay.","type":"boolean","example":true},"waiveVABenefitsToRetainRetiredPay":{"description":"Is Veteran Waiving benefits to retain Retiree pay.","type":"boolean","example":true},"militaryRetiredPay":{"description":"Retirement Pay information from Military Service.","type":"object","additionalProperties":false,"required":["receiving","payment"],"properties":{"receiving":{"description":"Is Veteran getting Retiree pay?","type":"boolean","example":true},"willReceiveInFuture":{"description":"Will Veteran get Retiree pay in future?  \n If true, then \"futurePayExplanation\" attribute is required.","type":"boolean","default":false,"example":false},"payment":{"description":"Part of DoD paying Retirement Benefits.","type":"object","additionalProperties":false,"required":["serviceBranch"],"properties":{"serviceBranch":{"description":"Branch of Service making payments.","type":"string","enum":["Air Force","Air Force Reserves","Air National Guard","Army","Army National Guard","Army Reserves","Coast Guard","Coast Guard Reserves","Marine Corps","Marine Corps Reserves","National Oceanic &amp; Atmospheric Administration","National Oceanic & Atmospheric Administration","Navy","Navy Reserves","Public Health Service","Air Force Academy","Army Air Corps or Army Air Force","Army Nurse Corps","Coast Guard Academy","Merchant Marine","Naval Academy","Other","US Military Academy","Women's Army Corps","Space Force"],"example":"Air Force"},"amount":{"description":"Amount being received.","type":"number","example":100}}},"futurePayExplanation":{"description":"Explains why future pay will be received.","type":"string","example":"Will be retiring soon."}}},"separationPay":{"description":"Details about separation pay.","type":"object","additionalProperties":false,"required":["received"],"properties":{"received":{"description":"Has separation pay been received?","type":"boolean","example":true,"default":true},"payment":{"description":"Separation pay payment details.","type":"object","additionalProperties":false,"properties":{"serviceBranch":{"description":"Branch of Service making payments.","type":"string","enum":["Air Force","Air Force Reserves","Air National Guard","Army","Army National Guard","Army Reserves","Coast Guard","Coast Guard Reserves","Marine Corps","Marine Corps Reserves","National Oceanic &amp; Atmospheric Administration","National Oceanic & Atmospheric Administration","Navy","Navy Reserves","Public Health Service","Air Force Academy","Army Air Corps or Army Air Force","Army Nurse Corps","Coast Guard Academy","Merchant Marine","Naval Academy","Other","US Military Academy","Women's Army Corps","Space Force"],"example":"Air Force"},"amount":{"description":"Amount being received.","type":"number","example":100}}},"receivedDate":{"description":"Approximate date separation pay was received.","type":"string","pattern":"^(\\d{4}-(\\d{2}-(\\d{2})?)?|\\d{4}-\\d{2}|\\d{4}|)$","example":"2018-03-02, 2018-03, or 2018"}}}}},"directDeposit":{"description":"Financial Direct Deposit information for Veteran.","type":"object","additionalProperties":false,"properties":{"accountType":{"description":"Veteran Account Type (value is case insensitive).","type":"string","enum":["CHECKING","SAVINGS"],"example":"CHECKING"},"accountNumber":{"description":"Veteran Bank Account Number.","minLength":4,"maxLength":17,"type":"string","example":"123123123123"},"routingNumber":{"description":"Veteran Bank Routing Number.","type":"string","pattern":"^\\d{9}$","example":"123123123"},"bankName":{"description":"Provide the name of the bank where the Veteran wants the direct deposit.","maxLength":35,"type":"string","example":"Some Bank"}}},"claimantCertification":{"description":"Determines if person submitting the claim is certified to do so.","type":"boolean","example":true},"standardClaim":{"description":"A value of false indicates the claim should be processed as a Fully Developed Claim.","type":"boolean","example":false},"applicationExpirationDate":{"description":"Time stamp of when claim expires.  If not provided, value will be set to 1 year in the future from current day.","type":"string","example":"2018-08-28T19:53:45+00:00"},"autoCestPDFGenerationDisabled":{"description":"Allows you to bypass the auto PDF generation and instead upload the Disability form itself through Support Documents.","type":"boolean","example":false},"claimDate":{"description":"Date (or Timestamp with TimeZone) when claim is being submitted to the VA. Date cannot be in the future. UTC TimeZone is assumed unless otherwise specified.","type":"string","pattern":"^(?:[0-9]{4})-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])(?:T[0-1][0-9]:[0-5][0-9]:[0-5][0-9](?:[-+][0-9]{2}:[0-9]{2}|Z))*$","example":"2018-08-28T19:53:45+00:00"}}}}}}}}},"required":true}}},"/forms/526/{id}/attachments":{"post":{"summary":"Upload documents supporting a 526 claim","tags":["Disability"],"operationId":"POST:/forms/526/{id}/attachments","security":[{"productionOauth":["claim.read","claim.write"]},{"sandboxOauth":["claim.read","claim.write"]},{"bearer_token":[]}],"description":"Used to attach supporting documents for a 526 claim. For wet-signature PDFs, use the PUT /forms/526/{id} endpoint.\n\n<br/><br/>\nThis endpoint accepts a document binary PDF as part of a multi-part payload (for example, attachment1, attachment2, attachment3).\n\n","parameters":[{"name":"id","in":"path","description":"UUID given when Disability Claim was submitted","required":true,"schema":{"type":"string"}},{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"upload response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000008","type":"claims_api_claim","attributes":{"evss_id":null,"open":true,"waiver_submitted":null,"requested_decision":null,"claim_type":null,"updated_at":"2024-01-01T00:00:00.000Z","date_filed":null,"min_est_date":null,"max_est_date":null,"development_letter_sent":null,"decision_letter_sent":null,"documents_needed":null,"contention_list":null,"events_timeline":[],"va_representative":null,"status":"pending","supporting_documents":[{"id":"00000000-0000-0000-0000-000000000009","type":"claim_supporting_document","md5":"","header_hash":"","filename":null,"uploaded_at":"2024-01-01T00:00:00.000Z"}]}}},"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":"Internal vets-api Claim ID"},"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["open","updated_at","events_timeline","status","supporting_documents"],"properties":{"evss_id":{"type":"integer","nullable":true,"description":"EVSS Claim ID"},"date_filed":{"type":"string","nullable":true,"format":"date","description":"Date in YYYY-MM-DD the claim was first filed"},"min_est_date":{"type":"string","nullable":true,"format":"date","description":"Minimum Estimated Claim Completion Date"},"max_est_date":{"type":"string","nullable":true,"format":"date","description":"Maximum Estimated Claim Completion Date"},"phase_change_date":{"type":"string","nullable":true,"format":"date","description":"Date of last phase change"},"open":{"type":"boolean","description":"Has the claim been resolved"},"waiver_submitted":{"type":"boolean","nullable":true,"description":"Requested Decision or Waiver 5103 Submitted"},"documents_needed":{"type":"boolean","nullable":true,"description":"Does the claim require additional documents to be submitted"},"development_letter_sent":{"type":"boolean","nullable":true,"description":"Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim"},"decision_letter_sent":{"type":"boolean","nullable":true,"description":"Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim"},"phase":{"type":"string","nullable":true},"ever_phase_back":{"type":"string","nullable":true},"current_phase_back":{"type":"string","nullable":true},"requested_decision":{"type":"string","nullable":true,"description":"The claim filer has requested a claim decision be made"},"claim_type":{"type":"string","nullable":true,"description":"The type of claim originally submitted"},"updated_at":{"type":"string","format":"date","description":"Time stamp of last change to the claim"},"contention_list":{"type":"array","nullable":true},"va_representative":{"type":"string","nullable":true},"events_timeline":{"type":"array"},"status":{"type":"string","enum":["pending","established"],"description":"Current status of the claim"},"supporting_documents":{"type":"array","items":{"properties":{"id":{"type":"string","description":"Unique identifier of document"},"type":{"type":"string"},"md5":{"type":"string","nullable":true,"description":"Hashed representation of document"},"header_hash":{"type":"string","nullable":true,"description":"Hashed representation of document header"},"filename":{"type":"string","nullable":true,"description":"Name of document"},"uploaded_at":{"type":"string","nullable":true,"format":"date","description":"Date and time document was uploaded"}}}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource not found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"Resource not found","code":"404","status":"404"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":{"multipart/form-data":{"schema":{"type":"object","properties":{"attachment1":{"type":"file","description":"Attachment contents. Must be provided in binary PDF or [base64 string](https://va.ghe.com/software/vets-api/blob/master/modules/claims_api/spec/fixtures/base64pdf) format and less than 11 in x 11 in.\n"},"attachment2":{"type":"file","description":"Attachment contents. Must be provided in binary PDF or [base64 string](https://va.ghe.com/software/vets-api/blob/master/modules/claims_api/spec/fixtures/base64pdf) format and less than 11 in x 11 in.\n"}}}}}}}},"/claims":{"get":{"summary":"Find all benefits claims for a VA claimant","tags":["Claims"],"operationId":"GET:/claims","security":[{"productionOauth":["claim.read"]},{"sandboxOauth":["claim.read"]},{"bearer_token":[]}],"description":"Uses the Veteran’s metadata in headers to retrieve all claims for that Veteran. An authenticated Veteran making a request with this endpoint will return their own claims, if any.","parameters":[{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"responses":{"200":{"description":"claim response","content":{"application/json":{"example":{"data":[{"id":"600354175","type":"evss_claims","attributes":{"evss_id":600354175,"open":false,"waiver_submitted":false,"requested_decision":false,"claim_type":"Compensation","date_filed":"2022-12-01","min_est_date":null,"max_est_date":null,"development_letter_sent":false,"decision_letter_sent":false,"documents_needed":false,"status":"Complete"}},{"id":"600354178","type":"evss_claims","attributes":{"evss_id":600354178,"open":false,"waiver_submitted":false,"requested_decision":false,"claim_type":"Compensation","date_filed":"2022-12-01","min_est_date":null,"max_est_date":null,"development_letter_sent":false,"decision_letter_sent":false,"documents_needed":false,"status":"Complete"}},{"id":"600311927","type":"evss_claims","attributes":{"evss_id":600311927,"open":false,"waiver_submitted":false,"requested_decision":false,"claim_type":"Compensation","date_filed":"2022-06-23","min_est_date":null,"max_est_date":null,"development_letter_sent":false,"decision_letter_sent":true,"documents_needed":false,"status":"Complete"}},{"id":"600309680","type":"evss_claims","attributes":{"evss_id":600309680,"open":false,"waiver_submitted":false,"requested_decision":false,"claim_type":"Compensation","date_filed":"2022-06-09","min_est_date":null,"max_est_date":null,"development_letter_sent":false,"decision_letter_sent":true,"documents_needed":false,"status":"Complete"}},{"id":"600308831","type":"evss_claims","attributes":{"evss_id":600308831,"open":false,"waiver_submitted":false,"requested_decision":false,"claim_type":"Compensation","date_filed":"2022-06-06","min_est_date":null,"max_est_date":null,"development_letter_sent":false,"decision_letter_sent":true,"documents_needed":false,"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 with some details for the given Veteran info","properties":{"id":{"type":"string","description":"Claim ID from EVSS","example":"8347210"},"type":{"type":"string","example":"evss_claims"},"attributes":{"type":"object","additionalProperties":false,"required":["evss_id","date_filed","max_est_date","open","waiver_submitted","documents_needed","development_letter_sent","status","requested_decision","claim_type"],"properties":{"evss_id":{"type":"integer","description":"Upstream service identifier"},"date_filed":{"type":"string","format":"date","description":"Date in YYYY-MM-DD the claim was first filed","example":"2018-06-04"},"min_est_date":{"type":["string","null"],"format":"date","description":"Minimum Estimated Claim Completion Date","example":"2019-06-04"},"max_est_date":{"type":["string","null"],"format":"date","description":"Maximum Estimated Claim Completion Date","example":"2019-09-04"},"open":{"type":"boolean","description":"Has the claim been resolved","example":"true"},"waiver_submitted":{"type":"boolean","description":"Requested Decision or Waiver 5103 Submitted","example":"false"},"documents_needed":{"type":"boolean","description":"Does the claim require additional documents to be submitted","example":"false"},"development_letter_sent":{"type":"boolean","description":"Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim","example":"false"},"decision_letter_sent":{"type":"boolean","description":"Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim","example":"false"},"status":{"type":"string","description":"Current status of the claim","enum":["Claim received","Initial review","Evidence gathering, review, and decision","Preparation for notification","Complete"],"example":"Claim received"},"requested_decision":{"type":"boolean","description":"The claim filer has requested a claim decision be made","example":"false"},"claim_type":{"type":"string","description":"The type of claim originally submitted","example":"Compensation"}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Resource Not Found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"The Resource was not found.","code":"404","status":"404"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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"}}}}}}}},"/claims/{id}":{"get":{"summary":"Find Claim by ID","tags":["Claims"],"operationId":"GET:/claims/{id}","security":[{"productionOauth":["claim.read"]},{"sandboxOauth":["claim.read"]},{"bearer_token":[]}],"parameters":[{"name":"id","in":"path","description":"The ID of the claim being requested","required":true,"schema":{"type":"string"}},{"in":"header","name":"X-VA-SSN","required":false,"description":"Claimant SSN if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-First-Name","required":false,"description":"Claimant first name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Last-Name","required":false,"description":"Claimant last name if consumer is representative","schema":{"type":"string"}},{"in":"header","name":"X-VA-Birth-Date","required":false,"description":"Claimant birthdate if consumer is representative, in iso8601 format","schema":{"type":"string"}}],"description":"Returns data such as processing status for a single claim by ID.","responses":{"200":{"description":"claims response","content":{"application/json":{"example":{"data":{"id":"00000000-0000-0000-0000-000000000010","type":"claims_api_claim","attributes":{"evss_id":600118851,"open":false,"waiver_submitted":false,"requested_decision":false,"claim_type":"Compensation","date_filed":"2017-12-08","min_est_date":null,"max_est_date":null,"development_letter_sent":false,"decision_letter_sent":false,"documents_needed":false,"contention_list":[],"events_timeline":[{"type":"phase7","date":"2018-06-12"},{"type":"completed","date":"2018-06-12"},{"type":"filed","date":"2017-12-08"}],"va_representative":"AMERICAN LEGION","status":"Complete","supporting_documents":[{"id":"00000000-0000-0000-0000-000000000011","type":"claim_supporting_document","md5":"84e997702baca501734d4e23dae0f9af","header_hash":"c2714a50560affd76bfc376a90ec4e52d49e1a09d073456b7a1594452fd7ccc7","filename":"custom_file_name.pdf","uploaded_at":"2024-01-01T00:00:00.000Z"}]}}},"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":"Claim ID from EVSS"},"type":{"type":"string"},"attributes":{"type":"object","additionalProperties":false,"required":["date_filed","max_est_date","open","waiver_submitted","documents_needed","development_letter_sent","status","requested_decision","claim_type","contention_list","va_representative","events_timeline","supporting_documents"],"properties":{"evss_id":{"type":"integer","nullable":true,"description":"Upstream service identifier"},"date_filed":{"type":"string","format":"date","description":"Date in YYYY-MM-DD the claim was first filed","example":"2018-06-04"},"min_est_date":{"type":["string","null"],"format":"date","description":"Minimum Estimated Claim Completion Date","example":"2019-06-04"},"max_est_date":{"type":["string","null"],"format":"date","description":"Maximum Estimated Claim Completion Date","example":"2019-09-04"},"open":{"type":"boolean","description":"Has the claim been resolved"},"waiver_submitted":{"type":"boolean","description":"Requested Decision or Waiver 5103 Submitted"},"documents_needed":{"type":"boolean","description":"Does the claim require additional documents to be submitted"},"development_letter_sent":{"type":"boolean","description":"Indicates if a Development Letter has been sent to the Claimant regarding a benefit claim"},"decision_letter_sent":{"type":"boolean","description":"Indicates if a Decision Letter has been sent to the Claimant regarding a benefit claim"},"status":{"type":"string","description":"Current status of the claim","enum":["pending","Claim received","Initial review","Evidence gathering, review, and decision","Preparation for notification","Complete"]},"requested_decision":{"type":"boolean","description":"The claim filer has requested a claim decision be made"},"claim_type":{"type":"string","description":"The type of claim originally submitted"},"contention_list":{"type":"array","items":{"type":"string"}},"va_representative":{"type":"string","description":"Current VA Representative Organization"},"events_timeline":{"type":"array","items":{"anyOf":[{"type":"object","additionalProperties":false,"required":["type","date"],"properties":{"type":{"type":"string","description":"Different types of event statuses"},"date":{"type":"string","format":"date","description":"Date of Event"}}},{"type":"object","additionalProperties":false,"required":["tracked_item_id","file_type","document_type","filename","upload_date","type","date"],"properties":{"tracked_item_id":{"type":["string","null"],"description":"Tracked Item ID given by VBMS"},"file_type":{"type":"string","description":"Type of File being submitted/requested"},"document_type":{"type":"string","description":"Type of document submitted"},"filename":{"type":"string","description":"Name of file submitted"},"upload_date":{"type":"string","format":"date","description":"Date original upload of file occured"},"type":{"type":"string","description":"Type of Tracked Item submitted"},"date":{"type":"string","format":"date","description":"Date of Event"}}}]}},"supporting_documents":{"type":"array","items":{"properties":{"id":{"type":"string","description":"Unique identifier of document"},"type":{"type":"string"},"md5":{"type":"string","description":"Hashed representation of document"},"header_hash":{"type":"string","description":"Hashed representation of document header"},"filename":{"type":"string","description":"Name of document"},"uploaded_at":{"type":"string","format":"date","description":"Date and time document was uploaded"}}}}}}}}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"404":{"description":"Record Not Found","content":{"application/json":{"example":{"errors":[{"title":"Resource not found","detail":"Claim not found","code":"404","status":"404"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":"Unknown EVSS Async Error","code":"422","status":"422"}]},"schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title","detail","code","status"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"status":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"}}}}}}}}}}},"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":"v1"}}},{"url":"https://api.va.gov/services/claims/{version}","description":"Production","variables":{"version":{"default":"v1"}}}]}