{"openapi":"3.0.0","info":{"title":"Appeals Status","version":"v1","contact":{"name":"developer.va.gov"},"description":"The Appeals Status API provides read-only access to the statuses of all decision review types for a claimant, including those under the Appeals Modernization Act (AMA) and legacy benefit appeals.\n\nTo retrieve a list of a claimant's active appealable issues or legacy appeals, use one of these APIs:\n\n* [Appealable Issues API](/explore/api/appealable-issues/docs)\n* [Legacy Appeals API](/explore/api/legacy-appeals/docs)\n\n## Technical overview\n\n### Authentication and Authorization\n\nThe authorization model for the Appeals Status API uses OAuth 2.0/OpenID Connect. The following models are supported:\n\n* [Authorization Code Grant (ACG)](/explore/api/appeals-status/authorization-code)\n* [Client Credentials Grant (CCG)](/explore/api/appeals-status/client-credentials)\n\n**Important:** To get production access using client credentials grant, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](/support/contact-us).\n\n### Test data\n\nOur sandbox environment is populated with [claimant test data](/explore/api/appeals-status/test-users) that can be used to test various response scenarios. This sandbox data contains no PII or PHI, but mimics real claimant account information.\n"},"tags":[{"name":"Appeals Status"}],"paths":{"/appeals":{"get":{"summary":"Get appeal statuses for the claimant associated with the provided ICN.","tags":["Appeals Status"],"operationId":"GET:/appeals","description":"Returns a list of all appeals for the claimant, including each appeal's current status, priority, and update history.","security":[{"productionOauth":["veteran/AppealsStatus.read","representative/AppealsStatus.read","system/AppealsStatus.read"]},{"sandboxOauth":["veteran/AppealsStatus.read","representative/AppealsStatus.read","system/AppealsStatus.read"]}],"parameters":[{"name":"icn","description":"Claimant's Integration Control Number (ICN). Optional when using a veteran-scoped token. Required when using a representative- or system-scoped token.","example":"1012832025V743496","schema":{"type":"string","pattern":"^[0-9]{10}V[0-9]{6}$"},"in":"query","required":false}],"responses":{"200":{"description":"Claimant's appeals statuses successfully retrieved","content":{"application/json":{"examples":{"with a veteran-scoped token (no 'icn' parameter necessary)":{"value":{"data":[{"id":"HLR101","type":"appealStatus","attributes":{"appealType":"HIGHER_LEVEL_REVIEW","appealIds":["HLR101"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"VBA","programArea":"COMPENSATION","description":"Severance of service connection, hypothyroidism, and 1 other","subtype":null,"isAdvancedOnDocket":false,"location":"AGENCY_OF_ORIGINAL_JURISDICTION","updateDate":"2019-08-29T23:38:48Z","status":{"type":"HLR_DECISION","details":{"issues":[{"description":"Service connection, sciatic nerve paralysis","disposition":"denied"},{"description":"Severance of service connection, hypothyroidism","disposition":"allowed"}]}},"docket":null,"issues":[{"isActive":false,"description":"Service connection, sciatic nerve paralysis","diagnosticCode":"8520","lastAction":"DENIED","decisionDate":"2019-08-05"},{"isActive":false,"description":"Severance of service connection, hypothyroidism","diagnosticCode":"7903","lastAction":"ALLOWED","decisionDate":"2019-08-05"}],"alerts":[{"type":"AMA_POST_DECISION","details":{"decisionDate":"2019-08-05","availableOptions":["supplemental_claim","higher_level_review","board_appeal"],"dueDate":"2020-08-04","cavcDueDate":"2019-12-02"}}],"events":[{"type":"HLR_REQUEST","date":"2019-02-19"},{"type":"HLR_DTA_ERROR","date":"2019-06-01"},{"type":"HLR_DECISION","date":"2019-08-05"}]}},{"id":"SC105","type":"appealStatus","attributes":{"appealType":"SUPPLEMENTAL_CLAIM","appealIds":["SC105"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"VHA","programArea":"MEDICAL","description":"Eligibility for dental treatment","subtype":null,"isAdvancedOnDocket":false,"location":"AGENCY_OF_ORIGINAL_JURISDICTION","updateDate":"2019-05-29T23:38:48Z","status":{"type":"SC_RECEIVED","details":{}},"docket":null,"issues":[{"isActive":true,"description":"Eligibility for dental treatment","diagnosticCode":null,"lastAction":null,"decisionDate":null}],"alerts":[],"events":[{"type":"SC_REQUEST","date":"2019-02-19"}]}},{"id":"A107","type":"appealStatus","attributes":{"appealType":"NOTICE_OF_DISAGREEMENT","appealIds":["A107"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"NCA","programArea":"BURIAL","description":"Non-qualifying service","subtype":null,"isAdvancedOnDocket":false,"location":"BVA","updateDate":"2020-02-29T23:38:46Z","status":{"type":"AMA_REMAND","details":{"issues":[{"description":"Non-qualifying service","disposition":"remand"}]}},"docket":{"type":"DIRECT_REVIEW","month":"2019-04-01","docketMonth":null,"atFront":false,"total":null,"ahead":null,"ready":null,"isEligibleToSwitch":true,"switchDueDate":"2020-03-20"},"issues":[{"isActive":true,"description":"Non-qualifying service","diagnosticCode":null,"lastAction":"REMAND","decisionDate":"2020-02-20"}],"alerts":[{"type":"AMA_POST_DECISION","details":{"decisionDate":"2020-02-20","availableOptions":["supplemental_claim","cavc"],"dueDate":"2021-02-19","cavcDueDate":"2020-06-19"}}],"events":[{"type":"AMA_NOD","date":"2019-04-10"},{"type":"BVA_DECISION","date":"2020-02-20"}]}},{"id":"1196201","type":"appealStatus","attributes":{"appealType":"LEGACY_APPEAL","appealIds":["1196201"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"VBA","programArea":"COMPENSATION","description":"Service connection, sleep apnea","subtype":"ORIGINAL","isAdvancedOnDocket":false,"location":"AGENCY_OF_ORIGINAL_JURISDICTION","updateDate":"2018-05-29T23:38:40Z","status":{"type":"PENDING_FORM9","details":{"lastSocDate":"2018-05-15","certificationTimeliness":[2,12],"ssocTimeliness":[7,20]}},"docket":null,"issues":[{"isActive":true,"description":"Service connection, sleep apnea","diagnosticCode":"6847","lastAction":null,"decisionDate":null}],"alerts":[{"type":"FORM9_NEEDED","details":{"dueDate":"2018-07-31"}}],"events":[{"type":"CLAIM_DECISION","date":"2017-07-31"},{"type":"NOD","date":"2017-08-10"},{"type":"SOC","date":"2018-05-15"}]}}]}},"with a representative-scoped token ('icn' parameter is necessary)":{"value":{"data":[{"id":"HLR101","type":"appealStatus","attributes":{"appealType":"HIGHER_LEVEL_REVIEW","appealIds":["HLR101"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"VBA","programArea":"COMPENSATION","description":"Severance of service connection, hypothyroidism, and 1 other","subtype":null,"isAdvancedOnDocket":false,"location":"AGENCY_OF_ORIGINAL_JURISDICTION","updateDate":"2019-08-29T23:38:48Z","status":{"type":"HLR_DECISION","details":{"issues":[{"description":"Service connection, sciatic nerve paralysis","disposition":"denied"},{"description":"Severance of service connection, hypothyroidism","disposition":"allowed"}]}},"docket":null,"issues":[{"isActive":false,"description":"Service connection, sciatic nerve paralysis","diagnosticCode":"8520","lastAction":"DENIED","decisionDate":"2019-08-05"},{"isActive":false,"description":"Severance of service connection, hypothyroidism","diagnosticCode":"7903","lastAction":"ALLOWED","decisionDate":"2019-08-05"}],"alerts":[{"type":"AMA_POST_DECISION","details":{"decisionDate":"2019-08-05","availableOptions":["supplemental_claim","higher_level_review","board_appeal"],"dueDate":"2020-08-04","cavcDueDate":"2019-12-02"}}],"events":[{"type":"HLR_REQUEST","date":"2019-02-19"},{"type":"HLR_DTA_ERROR","date":"2019-06-01"},{"type":"HLR_DECISION","date":"2019-08-05"}]}},{"id":"SC105","type":"appealStatus","attributes":{"appealType":"SUPPLEMENTAL_CLAIM","appealIds":["SC105"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"VHA","programArea":"MEDICAL","description":"Eligibility for dental treatment","subtype":null,"isAdvancedOnDocket":false,"location":"AGENCY_OF_ORIGINAL_JURISDICTION","updateDate":"2019-05-29T23:38:48Z","status":{"type":"SC_RECEIVED","details":{}},"docket":null,"issues":[{"isActive":true,"description":"Eligibility for dental treatment","diagnosticCode":null,"lastAction":null,"decisionDate":null}],"alerts":[],"events":[{"type":"SC_REQUEST","date":"2019-02-19"}]}},{"id":"A107","type":"appealStatus","attributes":{"appealType":"NOTICE_OF_DISAGREEMENT","appealIds":["A107"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"NCA","programArea":"BURIAL","description":"Non-qualifying service","subtype":null,"isAdvancedOnDocket":false,"location":"BVA","updateDate":"2020-02-29T23:38:46Z","status":{"type":"AMA_REMAND","details":{"issues":[{"description":"Non-qualifying service","disposition":"remand"}]}},"docket":{"type":"DIRECT_REVIEW","month":"2019-04-01","docketMonth":null,"atFront":false,"total":null,"ahead":null,"ready":null,"isEligibleToSwitch":true,"switchDueDate":"2020-03-20"},"issues":[{"isActive":true,"description":"Non-qualifying service","diagnosticCode":null,"lastAction":"REMAND","decisionDate":"2020-02-20"}],"alerts":[{"type":"AMA_POST_DECISION","details":{"decisionDate":"2020-02-20","availableOptions":["supplemental_claim","cavc"],"dueDate":"2021-02-19","cavcDueDate":"2020-06-19"}}],"events":[{"type":"AMA_NOD","date":"2019-04-10"},{"type":"BVA_DECISION","date":"2020-02-20"}]}},{"id":"1196201","type":"appealStatus","attributes":{"appealType":"LEGACY_APPEAL","appealIds":["1196201"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"VBA","programArea":"COMPENSATION","description":"Service connection, sleep apnea","subtype":"ORIGINAL","isAdvancedOnDocket":false,"location":"AGENCY_OF_ORIGINAL_JURISDICTION","updateDate":"2018-05-29T23:38:40Z","status":{"type":"PENDING_FORM9","details":{"lastSocDate":"2018-05-15","certificationTimeliness":[2,12],"ssocTimeliness":[7,20]}},"docket":null,"issues":[{"isActive":true,"description":"Service connection, sleep apnea","diagnosticCode":"6847","lastAction":null,"decisionDate":null}],"alerts":[{"type":"FORM9_NEEDED","details":{"dueDate":"2018-07-31"}}],"events":[{"type":"CLAIM_DECISION","date":"2017-07-31"},{"type":"NOD","date":"2017-08-10"},{"type":"SOC","date":"2018-05-15"}]}}]}},"with a system-scoped token ('icn' parameter is necessary)":{"value":{"data":[{"id":"HLR101","type":"appealStatus","attributes":{"appealType":"HIGHER_LEVEL_REVIEW","appealIds":["HLR101"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"VBA","programArea":"COMPENSATION","description":"Severance of service connection, hypothyroidism, and 1 other","subtype":null,"isAdvancedOnDocket":false,"location":"AGENCY_OF_ORIGINAL_JURISDICTION","updateDate":"2019-08-29T23:38:48Z","status":{"type":"HLR_DECISION","details":{"issues":[{"description":"Service connection, sciatic nerve paralysis","disposition":"denied"},{"description":"Severance of service connection, hypothyroidism","disposition":"allowed"}]}},"docket":null,"issues":[{"isActive":false,"description":"Service connection, sciatic nerve paralysis","diagnosticCode":"8520","lastAction":"DENIED","decisionDate":"2019-08-05"},{"isActive":false,"description":"Severance of service connection, hypothyroidism","diagnosticCode":"7903","lastAction":"ALLOWED","decisionDate":"2019-08-05"}],"alerts":[{"type":"AMA_POST_DECISION","details":{"decisionDate":"2019-08-05","availableOptions":["supplemental_claim","higher_level_review","board_appeal"],"dueDate":"2020-08-04","cavcDueDate":"2019-12-02"}}],"events":[{"type":"HLR_REQUEST","date":"2019-02-19"},{"type":"HLR_DTA_ERROR","date":"2019-06-01"},{"type":"HLR_DECISION","date":"2019-08-05"}]}},{"id":"SC105","type":"appealStatus","attributes":{"appealType":"SUPPLEMENTAL_CLAIM","appealIds":["SC105"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"VHA","programArea":"MEDICAL","description":"Eligibility for dental treatment","subtype":null,"isAdvancedOnDocket":false,"location":"AGENCY_OF_ORIGINAL_JURISDICTION","updateDate":"2019-05-29T23:38:48Z","status":{"type":"SC_RECEIVED","details":{}},"docket":null,"issues":[{"isActive":true,"description":"Eligibility for dental treatment","diagnosticCode":null,"lastAction":null,"decisionDate":null}],"alerts":[],"events":[{"type":"SC_REQUEST","date":"2019-02-19"}]}},{"id":"A107","type":"appealStatus","attributes":{"appealType":"NOTICE_OF_DISAGREEMENT","appealIds":["A107"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"NCA","programArea":"BURIAL","description":"Non-qualifying service","subtype":null,"isAdvancedOnDocket":false,"location":"BVA","updateDate":"2020-02-29T23:38:46Z","status":{"type":"AMA_REMAND","details":{"issues":[{"description":"Non-qualifying service","disposition":"remand"}]}},"docket":{"type":"DIRECT_REVIEW","month":"2019-04-01","docketMonth":null,"atFront":false,"total":null,"ahead":null,"ready":null,"isEligibleToSwitch":true,"switchDueDate":"2020-03-20"},"issues":[{"isActive":true,"description":"Non-qualifying service","diagnosticCode":null,"lastAction":"REMAND","decisionDate":"2020-02-20"}],"alerts":[{"type":"AMA_POST_DECISION","details":{"decisionDate":"2020-02-20","availableOptions":["supplemental_claim","cavc"],"dueDate":"2021-02-19","cavcDueDate":"2020-06-19"}}],"events":[{"type":"AMA_NOD","date":"2019-04-10"},{"type":"BVA_DECISION","date":"2020-02-20"}]}},{"id":"1196201","type":"appealStatus","attributes":{"appealType":"LEGACY_APPEAL","appealIds":["1196201"],"isActive":true,"hasIncompleteHistory":false,"agencyOfOriginalJurisdiction":"VBA","programArea":"COMPENSATION","description":"Service connection, sleep apnea","subtype":"ORIGINAL","isAdvancedOnDocket":false,"location":"AGENCY_OF_ORIGINAL_JURISDICTION","updateDate":"2018-05-29T23:38:40Z","status":{"type":"PENDING_FORM9","details":{"lastSocDate":"2018-05-15","certificationTimeliness":[2,12],"ssocTimeliness":[7,20]}},"docket":null,"issues":[{"isActive":true,"description":"Service connection, sleep apnea","diagnosticCode":"6847","lastAction":null,"decisionDate":null}],"alerts":[{"type":"FORM9_NEEDED","details":{"dueDate":"2018-07-31"}}],"events":[{"type":"CLAIM_DECISION","date":"2017-07-31"},{"type":"NOD","date":"2017-08-10"},{"type":"SOC","date":"2018-05-15"}]}}]}}},"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/appeals"}},"required":["data"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"example":{"errors":[{"title":"Not authorized","detail":"Not authorized","code":"401","status":"401"}]},"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"examples":{"with a veteran-scoped token and an optional 'icn' parameter that does not match the Veteran's ICN":{"value":{"errors":[{"title":"Forbidden","detail":"Invalid 'icn' parameter: claimants may access only their own records.","code":"403","status":"403"}]}}},"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"Not Found":{"value":{"errors":[{"title":"Resource not found","detail":"A matching claimant was not found in our systems.","code":"404","status":"404"}]}}},"schema":{"$ref":"#/components/schemas/errorModel"}}}},"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","content":{"application/json":{"examples":{"Invalid icn parameter":{"value":{"errors":[{"title":"Invalid pattern","detail":"'1234567890' did not match the defined pattern.","code":"143","source":{"parameter":"icn"},"status":"422","meta":{"regex":"^[0-9]{10}V[0-9]{6}$"}}]}},"Missing icn parameter with a representative-scoped token":{"value":{"errors":[{"title":"Missing required fields","detail":"One or more expected fields were not found.","code":"145","source":{"parameter":""},"status":"422","meta":{"missingFields":["icn"]}}]}},"Missing icn parameter with a system-scoped token":{"value":{"errors":[{"title":"Missing required fields","detail":"One or more expected fields were not found.","code":"145","source":{"parameter":""},"status":"422","meta":{"missingFields":["icn"]}}]}}},"schema":{"$ref":"#/components/schemas/errorModel"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"API rate limit exceeded"}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"example":{"errors":[{"title":"Internal server error","detail":"Internal server error","code":"500","status":"500"}]},"schema":{"$ref":"#/components/schemas/errorModel"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"example":{"errors":[{"title":"Service Unavailable","detail":"Received an unusable response from upstream service.","code":"503","status":"503"}]},"schema":{"$ref":"#/components/schemas/errorModel"}}}},"504":{"description":"Gateway Timeout","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"example":{"message":"The server took too long to respond"}}}}}}}}},"components":{"securitySchemes":{"productionOauth":{"type":"oauth2","description":"The authorization model for the Appeals Status API uses OAuth 2.0/OpenID Connect. The following models are supported: [Authorization Code Grant (ACG)](/explore/api/appeals-status/authorization-code) and [Client Credentials Grant (CCG)](/explore/api/appeals-status/client-credentials).","flows":{"authorizationCode":{"authorizationUrl":"https://api.va.gov/oauth2/appeals/v1/authorization","tokenUrl":"https://api.va.gov/oauth2/appeals/v1/token","scopes":{"veteran/AppealsStatus.read":"Status of appeals and decision reviews","representative/AppealsStatus.read":"Status of appeals and decision reviews"}},"clientCredentials":{"tokenUrl":"https://api.va.gov/oauth2/appeals/system/v1/token","scopes":{"system/AppealsStatus.read":"Status of appeals and decision reviews"}}}},"sandboxOauth":{"type":"oauth2","description":"The authorization model for the Appeals Status API uses OAuth 2.0/OpenID Connect. The following models are supported: [Authorization Code Grant (ACG)](/explore/api/appeals-status/authorization-code) and [Client Credentials Grant (CCG)](/explore/api/appeals-status/client-credentials).","flows":{"authorizationCode":{"authorizationUrl":"https://sandbox-api.va.gov/oauth2/appeals/v1/authorization","tokenUrl":"https://sandbox-api.va.gov/oauth2/appeals/v1/token","scopes":{"veteran/AppealsStatus.read":"Status of appeals and decision reviews","representative/AppealsStatus.read":"Status of appeals and decision reviews"}},"clientCredentials":{"tokenUrl":"https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token","scopes":{"system/AppealsStatus.read":"Status of appeals and decision reviews"}}}}},"schemas":{"alert":{"type":"object","description":"Notification of a request for more information or of a change in the appeal status that requires action","properties":{"type":{"type":"string","description":"Notification type. Acronyms used include CAVC (Court of Appeals for Veteran Claims), VSO (Veteran Service Organization), and DRO (Decision Review Officer).","example":"AMA_POST_DECISION","enum":["AMA_POST_DECISION","BLOCKED_BY_VSO","CAVC_OPTION","DECISION_SOON","DRO_HEARING_NO_SHOW","EVIDENTIARY_PERIOD","FORM9_NEEDED","HEARING_NO_SHOW","HELD_FOR_EVIDENCE","RAMP_ELIGIBLE","RAMP_INELIGIBLE","SCHEDULED_DRO_HEARING","SCHEDULED_HEARING"]},"details":{"type":"object","description":"Further information about the alert"}}},"appeal":{"type":"object","properties":{"id":{"type":"string","description":"ID from VACOLS (Veteran Appeals Control and Locator Service) or Caseflow","example":"HLR101"},"type":{"type":"string","description":"JSON API type specification","example":"appealStatus"},"attributes":{"type":"object","properties":{"appealType":{"type":"string","description":"The decision review option chosen by the appellant","example":"HIGHER_LEVEL_REVIEW","enum":["HIGHER_LEVEL_REVIEW","LEGACY_APPEAL","NOTICE_OF_DISAGREEMENT","SUPPLEMENTAL_CLAIM"]},"appealIds":{"type":"array","description":"An array of the individual IDs that are combined into this appeal","items":{"type":"string","example":"HLR101"}},"isActive":{"type":"boolean","description":"Indicates whether the appeal is ongoing or closed","example":true},"hasIncompleteHistory":{"type":"boolean","description":"Indicates whether this response contains a complete history of this appeal","example":false},"agencyOfOriginalJurisdiction":{"nullable":true,"type":"string","description":"VBA is Veterans Benefits Administration, VHA is Veterans Health Administration, and NCA is National Cemetery Administration","example":"VBA","enum":["NCA","OTHER","VBA","VHA",null]},"programArea":{"nullable":true,"type":"string","description":"Indicates the VA program most relevant to the appeal","example":"COMPENSATION","enum":["BURIAL","BVA","COMPENSATION","EDUCATION","FIDUCIARY","INSURANCE","LOAN_GUARANTY","MEDICAL","MULTIPLE","NCA","NCA_BURIAL","OTHER","PENSION","VBA_BURIAL","VHA","VOC_REHAB","VRE",null]},"description":{"type":"string","description":"Description of the appeal","example":"Severance of service connection, hypothyroidism, and 1 other"},"subtype":{"nullable":true,"type":"string","description":"Indicates the subtype of the appeal. CAVC is the Court of Appeals for Veterans Claims.","example":"ORIGINAL","enum":["COURT_REMAND","CUE","DE_NOVO","ORIGINAL","OTHER","POST_CAVC_REMAND","POST_REMAND","RECONSIDERATION","VACATE",null]},"isAdvancedOnDocket":{"type":"boolean","description":"Indicates whether this appeal was prioritized due to appellant demonstrating unusual hardship such as serious illness, severe financial hardship, or other sufficient cause","example":false},"location":{"type":"string","example":"AGENCY_OF_ORIGINAL_JURISDICTION","description":"Indicates who currently has the appeal: Agency of Original Jurisdiction (AOJ) or BVA (Board of Veterans Appeals)","enum":["AGENCY_OF_ORIGINAL_JURISDICTION","BVA"]},"updateDate":{"type":"string","format":"date-time","description":"The timestamp for the last refresh of the data","example":"2018-05-29T23:38:40Z"},"status":{"type":"object","description":"This appeal's position in the appeal process","properties":{"type":{"type":"string","description":"Indicates the current position in the appeal process","example":"HLR_DECISION","enum":["AMA_REMAND","AT_VSA","AT_VSO","BVA_DECISION","BVA_DECISION_EFFECTUATION","BVA_DEVELOPMENT","CAVC","DEATH","DECISION_IN_PROGRESS","EVIDENTIARY_PERIOD","FIELD_GRANT","FTR","HLR_CLOSED","HLR_DECISION","HLR_DTA_ERROR","HLR_RECEIVED","MERGED","MOTION","ON_DOCKET","OTHER_CLOSE","PENDING_CERTIFICATION","PENDING_CERTIFICATION_SSOC","PENDING_FORM9","PENDING_HEARING_SCHEDULING","PENDING_SOC","POST_BVA_DTA_DECISION","PRE_DOCKETED","RAMP","RECONSIDERATION","REMAND","REMAND_SSOC","SCHEDULED_HEARING","SC_CLOSED","SC_DECISION","SC_RECEIVED","STATUTORY_OPT_IN","STAYED","WITHDRAWN"]},"details":{"type":"object","description":"Further information about appeal's timeline"}}},"docket":{"nullable":true,"type":"object","description":"Represents the appeal's position in line for a decision and the expected timing of the decision","properties":{"type":{"nullable":true,"type":"string","description":"Indicates the docket of the appeal","example":"DIRECT_REVIEW","enum":["DIRECT_REVIEW","EVIDENCE_SUBMISSION","HEARING_REQUEST","LEGACY",null]},"month":{"nullable":true,"type":"string","format":"date","example":"2019-04-01"},"docketMonth":{"nullable":true,"type":"string","format":"date","example":"2019-02-01"},"atFront":{"type":"boolean","example":false},"total":{"nullable":true,"type":"integer","example":206900},"ahead":{"nullable":true,"type":"integer","example":109203},"ready":{"nullable":true,"type":"integer","example":22109},"isEligibleToSwitch":{"type":"boolean","example":true},"switchDueDate":{"nullable":true,"type":"string","format":"date","example":"2020-03-20"}}},"issues":{"type":"array","items":{"$ref":"#/components/schemas/issue"}},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/alert"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/event"}}}}}},"appeals":{"type":"array","items":{"$ref":"#/components/schemas/appeal"}},"errorModel":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","description":"HTTP error title"},"detail":{"type":"string","description":"HTTP error detail"},"code":{"type":"string","description":"HTTP error code"},"source":{"type":"object","additionalProperties":false,"description":"Source of error","properties":{"pointer":{"type":"string","description":"Pointer to source of error"},"parameter":{"type":"string","description":"Invalid request parameter"},"header":{"type":"string","description":"Invalid header"}}},"status":{"type":"string","description":"HTTP error code"},"meta":{"type":"object","description":"Meta information","properties":{"missingFields":{"type":"array","items":{"type":"string"},"description":"List of missing fields"}}}}}}}},"event":{"type":"object","description":"Event during the appeals process","properties":{"type":{"type":"string","description":"Event type. Acronyms used include NOD (Notice of Disagreement), SOC (Statement of Case), SSOC (Supplemental Statement of Case), FTR (Failed to Report), BVA (Board of Veteran Appeals), CAVC (Court of Appeals for Veteran Claims), and DRO (Decision Review Officer).","example":"HLR_REQUEST","enum":["AMA_NOD","BVA_DECISION","BVA_DECISION_EFFECTUATION","CAVC_DECISION","CERTIFIED","CLAIM_DECISION","DEATH","DISTRIBUTED_TO_VLJ","DOCKET_CHANGE","DTA_DECISION","FIELD_GRANT","FORM9","FTR","HEARING_HELD","HEARING_NO_SHOW","HLR_DECISION","HLR_DTA_ERROR","HLR_OTHER_CLOSE","HLR_REQUEST","MERGED","NOD","OTHER_CLOSE","RAMP","RAMP_NOTICE","RECONSIDERATION","RECORD_DESIGNATION","REMAND_RETURN","SC_DECISION","SC_OTHER_CLOSE","SC_REQUEST","SOC","SSOC","STATUTORY_OPT_IN","TRANSCRIPT","VACATED","WITHDRAWN"]},"date":{"type":"string","format":"date","description":"Date the event occurred","example":"2019-02-19"}}},"issue":{"type":"object","description":"Issue on appeal","properties":{"isActive":{"type":"boolean","description":"Whether the issue is presently under contention","example":false},"description":{"type":"string","description":"Description of the issue","example":"Service connection, sciatic nerve paralysis"},"diagnosticCode":{"nullable":true,"type":"string","description":"The CFR (Code of Federal Regulations) diagnostic code for the issue, if applicable","example":"8520"},"lastAction":{"nullable":true,"type":"string","description":"Most recent decision made on this issue","example":"DENIED","enum":["ALLOWED","CAVC_REMAND","DEFERRED","DENIED","DISMISSED","DISMISSED_DEATH","DISMISSED_MATTER_OF_LAW","DTA_ERROR","FIELD_GRANT","GRANTED","REMAND","STAYED","VACATED","WITHDRAWN",null]},"decisionDate":{"nullable":true,"type":"string","format":"date","description":"The date of the most recent decision on the issue","example":"2019-08-05"}}}}},"servers":[{"url":"https://sandbox-api.va.gov/services/appeals/appeals-status/{version}","description":"Sandbox","variables":{"version":{"default":"v1"}}},{"url":"https://api.va.gov/services/appeals/appeals-status/{version}","description":"Production","variables":{"version":{"default":"v1"}}}]}