Veterans Affairs · OAuth Scopes

Veterans Affairs OAuth Scopes

OAuth 2.0 derived

Veterans Affairs publishes 35 OAuth 2.0 scopes via the authorizationCode and clientCredentials flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the Veterans Affairs API on a user’s behalf.

Tokens are issued from https://api.va.gov/oauth2/appeals/v1/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

VeteransGovernmentHealthBenefitsFHIRAppealsFederal

Scopes: 35 Flows: authorizationCode, clientCredentials Method: derived

OAuth endpoints

Authorization URL
https://api.va.gov/oauth2/appeals/v1/authorization https://sandbox-api.va.gov/oauth2/appeals/v1/authorization https://api.va.gov/oauth2/authorization https://sandbox-api.va.gov/oauth2/authorization

Token URL
https://api.va.gov/oauth2/appeals/v1/token To get production access, you must either work for VA or have specific VA agreements in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us). https://sandbox-api.va.gov/oauth2/appeals/v1/token https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token https://api.va.gov/oauth2/token https://sandbox-api.va.gov/oauth2/token

Flows
authorizationCodeclientCredentials

Scopes (35)

Scope	Description	Flows
representative/AppealableIssues.read	Appealable issues info	authorizationCode
representative/AppealsStatus.read	Status of appeals and decision reviews	authorizationCode
representative/HigherLevelReviews.read	Higher-Level Reviews info	authorizationCode
representative/HigherLevelReviews.write	Ability to submit Higher-Level Reviews	authorizationCode
representative/LegacyAppeals.read	Legacy appeals info	authorizationCode
representative/NoticeOfDisagreements.read	Board Appeals info	authorizationCode
representative/NoticeOfDisagreements.write	Ability to submit Board Appeals	authorizationCode
representative/SupplementalClaims.read	Supplemental Claims info	authorizationCode
representative/SupplementalClaims.write	Ability to submit Supplemental Claims	authorizationCode
representative/appeals.read	Appeals info	authorizationCode
representative/appeals.write	Ability to submit appeals	authorizationCode
system/AppealableIssues.read	Appealable issues info	clientCredentials
system/AppealsStatus.read	Status of appeals and decision reviews	clientCredentials
system/HigherLevelReviews.read	Higher-Level Reviews info	clientCredentials
system/HigherLevelReviews.write	Ability to submit Higher-Level Reviews	clientCredentials
system/LegacyAppeals.read	Legacy appeals info	clientCredentials
system/NoticeOfDisagreements.read	Board Appeals info	clientCredentials
system/NoticeOfDisagreements.write	Ability to submit Board Appeals	clientCredentials
system/SupplementalClaims.read	Supplemental Claims info	clientCredentials
system/SupplementalClaims.write	Ability to submit Supplemental Claims	clientCredentials
system/appeals.read	Appeals info	clientCredentials
system/appeals.write	Ability to submit appeals	clientCredentials
system/claim.read	Retrieve claim data	authorizationCode
system/claim.write	Submit claim data	authorizationCode
veteran/AppealableIssues.read	Appealable issues info	authorizationCode
veteran/AppealsStatus.read	Status of appeals and decision reviews	authorizationCode
veteran/HigherLevelReviews.read	Higher-Level Reviews info	authorizationCode
veteran/HigherLevelReviews.write	Ability to submit Higher-Level Reviews	authorizationCode
veteran/LegacyAppeals.read	Legacy appeals info	authorizationCode
veteran/NoticeOfDisagreements.read	Board Appeals info	authorizationCode
veteran/NoticeOfDisagreements.write	Ability to submit Board Appeals	authorizationCode
veteran/SupplementalClaims.read	Supplemental Claims info	authorizationCode
veteran/SupplementalClaims.write	Ability to submit Supplemental Claims	authorizationCode
veteran/appeals.read	Appeals info	authorizationCode
veteran/appeals.write	Ability to submit appeals	authorizationCode

📄 Provider scope reference:

Source

OAuth Scopes

generated: '2026-07-11'
method: derived
source: openapi/va-appealable-issues-openapi.json, openapi/va-appeals-status-openapi.json, openapi/va-claims-api-openapi.json,
  openapi/va-higher-level-reviews-openapi.json, openapi/va-legacy-appeals-openapi.json, openapi/va-notice-of-disagreements-openapi.json,
  openapi/va-supplemental-claims-openapi.json
schemes:
- name: productionOauth
  source: openapi/va-appealable-issues-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: To get production access, you must either work for VA or have specific VA agreements
      in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).
  description: 'The authentication model for the Appealable Issues API uses OAuth 2.0/OpenID
    Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials).'
- name: sandboxOauth
  source: openapi/va-appealable-issues-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token
  description: 'The authentication model for the Appealable Issues API uses OAuth 2.0/OpenID
    Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appealable-issues/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appealable-issues/client-credentials).'
- name: productionOauth
  source: openapi/va-appeals-status-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: To get production access, you must either work for VA or have specific VA agreements
      in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).
  description: 'The authentication model for the Appeals Status API uses OAuth 2.0/OpenID Connect.
    The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appeals-status/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appeals-status/client-credentials).'
- name: sandboxOauth
  source: openapi/va-appeals-status-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token
  description: 'The authentication model for the Appeals Status API uses OAuth 2.0/OpenID Connect.
    The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/appeals-status/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/appeals-status/client-credentials).'
- name: productionOauth
  source: openapi/va-claims-api-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://api.va.gov/oauth2/authorization
    tokenUrl: https://api.va.gov/oauth2/token
  description: This API uses OAuth 2 with the client credential grant flow. [More info](https://developer.va.gov/explore/api/benefits-claims/client-credentials)
- name: sandboxOauth
  source: openapi/va-claims-api-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://sandbox-api.va.gov/oauth2/authorization
    tokenUrl: https://sandbox-api.va.gov/oauth2/token
  description: This API uses OAuth 2 with the client credential grant flow. [More info](https://developer.va.gov/explore/api/benefits-claims/client-credentials)
- name: productionOauth
  source: openapi/va-higher-level-reviews-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: To get production access, you must either work for VA or have specific VA agreements
      in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).
  description: 'The authentication model for the Higher-Level Reviews API uses OAuth 2.0/OpenID
    Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/higher-level-reviews/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/higher-level-reviews/client-credentials).'
- name: sandboxOauth
  source: openapi/va-higher-level-reviews-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token
  description: 'The authentication model for the Higher-Level Reviews API uses OAuth 2.0/OpenID
    Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/higher-level-reviews/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/higher-level-reviews/client-credentials).'
- name: productionOauth
  source: openapi/va-legacy-appeals-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: To get production access, you must either work for VA or have specific VA agreements
      in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).
  description: 'The authentication model for the Legacy Appeals API uses OAuth 2.0/OpenID Connect.
    The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/legacy-appeals/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/legacy-appeals/client-credentials).'
- name: sandboxOauth
  source: openapi/va-legacy-appeals-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token
  description: 'The authentication model for the Legacy Appeals API uses OAuth 2.0/OpenID Connect.
    The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/legacy-appeals/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/legacy-appeals/client-credentials).'
- name: productionOauth
  source: openapi/va-notice-of-disagreements-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: To get production access, you must either work for VA or have specific VA agreements
      in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).
  description: 'The authentication model for the Notice of Disagreements API uses OAuth 2.0/OpenID
    Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/notice-of-disagreements/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/notice-of-disagreements/client-credentials).'
- name: sandboxOauth
  source: openapi/va-notice-of-disagreements-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token
  description: 'The authentication model for the Notice of Disagreements API uses OAuth 2.0/OpenID
    Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/notice-of-disagreements/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/notice-of-disagreements/client-credentials).'
- name: productionOauth
  source: openapi/va-supplemental-claims-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: To get production access, you must either work for VA or have specific VA agreements
      in place. If you have questions, [contact us](https://developer.va.gov/support/contact-us).
  description: 'The authentication model for the Supplemental Claims API uses OAuth 2.0/OpenID
    Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/supplemental-claims/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/supplemental-claims/client-credentials).'
- name: sandboxOauth
  source: openapi/va-supplemental-claims-openapi.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/authorization
    tokenUrl: https://sandbox-api.va.gov/oauth2/appeals/v1/token
  - flow: clientCredentials
    tokenUrl: https://deptva-eval.okta.com/oauth2/auskff5o6xsoQVngk2p7/v1/token
  description: 'The authentication model for the Supplemental Claims API uses OAuth 2.0/OpenID
    Connect. The following authorization models are supported: [Authorization code flow](https://developer.va.gov/explore/api/supplemental-claims/authorization-code)
    and [Client Credentials Grant (CCG)](https://developer.va.gov/explore/api/supplemental-claims/client-credentials).'
scopes:
- scope: representative/AppealableIssues.read
  description: Appealable issues info
  flows:
  - authorizationCode
  sources:
  - openapi/va-appealable-issues-openapi.json
- scope: representative/AppealsStatus.read
  description: Status of appeals and decision reviews
  flows:
  - authorizationCode
  sources:
  - openapi/va-appeals-status-openapi.json
- scope: representative/HigherLevelReviews.read
  description: Higher-Level Reviews info
  flows:
  - authorizationCode
  sources:
  - openapi/va-higher-level-reviews-openapi.json
- scope: representative/HigherLevelReviews.write
  description: Ability to submit Higher-Level Reviews
  flows:
  - authorizationCode
  sources:
  - openapi/va-higher-level-reviews-openapi.json
- scope: representative/LegacyAppeals.read
  description: Legacy appeals info
  flows:
  - authorizationCode
  sources:
  - openapi/va-legacy-appeals-openapi.json
- scope: representative/NoticeOfDisagreements.read
  description: Board Appeals info
  flows:
  - authorizationCode
  sources:
  - openapi/va-notice-of-disagreements-openapi.json
- scope: representative/NoticeOfDisagreements.write
  description: Ability to submit Board Appeals
  flows:
  - authorizationCode
  sources:
  - openapi/va-notice-of-disagreements-openapi.json
- scope: representative/SupplementalClaims.read
  description: Supplemental Claims info
  flows:
  - authorizationCode
  sources:
  - openapi/va-supplemental-claims-openapi.json
- scope: representative/SupplementalClaims.write
  description: Ability to submit Supplemental Claims
  flows:
  - authorizationCode
  sources:
  - openapi/va-supplemental-claims-openapi.json
- scope: representative/appeals.read
  description: Appeals info
  flows:
  - authorizationCode
  sources:
  - openapi/va-appealable-issues-openapi.json
  - openapi/va-appeals-status-openapi.json
  - openapi/va-higher-level-reviews-openapi.json
  - openapi/va-legacy-appeals-openapi.json
  - openapi/va-notice-of-disagreements-openapi.json
  - openapi/va-supplemental-claims-openapi.json
- scope: representative/appeals.write
  description: Ability to submit appeals
  flows:
  - authorizationCode
  sources:
  - openapi/va-higher-level-reviews-openapi.json
  - openapi/va-notice-of-disagreements-openapi.json
  - openapi/va-supplemental-claims-openapi.json
- scope: system/AppealableIssues.read
  description: Appealable issues info
  flows:
  - clientCredentials
  sources:
  - openapi/va-appealable-issues-openapi.json
- scope: system/AppealsStatus.read
  description: Status of appeals and decision reviews
  flows:
  - clientCredentials
  sources:
  - openapi/va-appeals-status-openapi.json
- scope: system/HigherLevelReviews.read
  description: Higher-Level Reviews info
  flows:
  - clientCredentials
  sources:
  - openapi/va-higher-level-reviews-openapi.json
- scope: system/HigherLevelReviews.write
  description: Ability to submit Higher-Level Reviews
  flows:
  - clientCredentials
  sources:
  - openapi/va-higher-level-reviews-openapi.json
- scope: system/LegacyAppeals.read
  description: Legacy appeals info
  flows:
  - clientCredentials
  sources:
  - openapi/va-legacy-appeals-openapi.json
- scope: system/NoticeOfDisagreements.read
  description: Board Appeals info
  flows:
  - clientCredentials
  sources:
  - openapi/va-notice-of-disagreements-openapi.json
- scope: system/NoticeOfDisagreements.write
  description: Ability to submit Board Appeals
  flows:
  - clientCredentials
  sources:
  - openapi/va-notice-of-disagreements-openapi.json
- scope: system/SupplementalClaims.read
  description: Supplemental Claims info
  flows:
  - clientCredentials
  sources:
  - openapi/va-supplemental-claims-openapi.json
- scope: system/SupplementalClaims.write
  description: Ability to submit Supplemental Claims
  flows:
  - clientCredentials
  sources:
  - openapi/va-supplemental-claims-openapi.json
- scope: system/appeals.read
  description: Appeals info
  flows:
  - clientCredentials
  sources:
  - openapi/va-appealable-issues-openapi.json
  - openapi/va-appeals-status-openapi.json
  - openapi/va-higher-level-reviews-openapi.json
  - openapi/va-legacy-appeals-openapi.json
  - openapi/va-notice-of-disagreements-openapi.json
  - openapi/va-supplemental-claims-openapi.json
- scope: system/appeals.write
  description: Ability to submit appeals
  flows:
  - clientCredentials
  sources:
  - openapi/va-higher-level-reviews-openapi.json
  - openapi/va-notice-of-disagreements-openapi.json
  - openapi/va-supplemental-claims-openapi.json
- scope: system/claim.read
  description: Retrieve claim data
  flows:
  - authorizationCode
  sources:
  - openapi/va-claims-api-openapi.json
- scope: system/claim.write
  description: Submit claim data
  flows:
  - authorizationCode
  sources:
  - openapi/va-claims-api-openapi.json
- scope: veteran/AppealableIssues.read
  description: Appealable issues info
  flows:
  - authorizationCode
  sources:
  - openapi/va-appealable-issues-openapi.json
- scope: veteran/AppealsStatus.read
  description: Status of appeals and decision reviews
  flows:
  - authorizationCode
  sources:
  - openapi/va-appeals-status-openapi.json
- scope: veteran/HigherLevelReviews.read
  description: Higher-Level Reviews info
  flows:
  - authorizationCode
  sources:
  - openapi/va-higher-level-reviews-openapi.json
- scope: veteran/HigherLevelReviews.write
  description: Ability to submit Higher-Level Reviews
  flows:
  - authorizationCode
  sources:
  - openapi/va-higher-level-reviews-openapi.json
- scope: veteran/LegacyAppeals.read
  description: Legacy appeals info
  flows:
  - authorizationCode
  sources:
  - openapi/va-legacy-appeals-openapi.json
- scope: veteran/NoticeOfDisagreements.read
  description: Board Appeals info
  flows:
  - authorizationCode
  sources:
  - openapi/va-notice-of-disagreements-openapi.json
- scope: veteran/NoticeOfDisagreements.write
  description: Ability to submit Board Appeals
  flows:
  - authorizationCode
  sources:
  - openapi/va-notice-of-disagreements-openapi.json
- scope: veteran/SupplementalClaims.read
  description: Supplemental Claims info
  flows:
  - authorizationCode
  sources:
  - openapi/va-supplemental-claims-openapi.json
- scope: veteran/SupplementalClaims.write
  description: Ability to submit Supplemental Claims
  flows:
  - authorizationCode
  sources:
  - openapi/va-supplemental-claims-openapi.json
- scope: veteran/appeals.read
  description: Appeals info
  flows:
  - authorizationCode
  sources:
  - openapi/va-appealable-issues-openapi.json
  - openapi/va-appeals-status-openapi.json
  - openapi/va-higher-level-reviews-openapi.json
  - openapi/va-legacy-appeals-openapi.json
  - openapi/va-notice-of-disagreements-openapi.json
  - openapi/va-supplemental-claims-openapi.json
- scope: veteran/appeals.write
  description: Ability to submit appeals
  flows:
  - authorizationCode
  sources:
  - openapi/va-higher-level-reviews-openapi.json
  - openapi/va-notice-of-disagreements-openapi.json
  - openapi/va-supplemental-claims-openapi.json