VA Lighthouse

opencollection: 1.0.0
info:
  name: Veteran Service History and Eligibility API
  version: 2.1.0
items:
- info:
    name: ACA Coverage
    type: folder
  items:
  - info:
      name: Return a Veteran's enrollment status in minimum essential coverage (MEC) as defined by the Affordable Care Act
        (ACA). (restricted access).
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/restricted/aca_coverage
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: "  This endpoint checks a Veteran's enrollment status for minimum essential\n  coverage (MEC), as defined by the\
      \ Affordable Care Act (ACA), for a specified\n  date range.\n\n  The response includes a code for Veteran's health benefits\
      \ status for\n  the request's date range. If the status returned is \"APPLICANT_ENROLLED,\"\n  the response also includes\
      \ the start and end dates of the coverage. If multiple\n  enrollments are found for the requested date range, multiple\
      \ start and end dates are\n  returned (li"
- info:
    name: Disability Rating
    type: folder
  items:
  - info:
      name: Get information about a Veteran's VA disability ratings. Data returned includes individual and combined ratings,
        diagnoses, and eligibility dates for compensation for service-connected conditions.
      type: http
    http:
      method: GET
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/disability_rating
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: This endpoint provides disability ratings and related decisions and dates for a Veteran, based on the ID in the
      bearer token.
  - info:
      name: Search for information about a Veteran's VA disability ratings using demographic data. Data returned includes
        individual and combined ratings, diagnoses, and eligibility dates for compensation for service-connected conditions.
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/disability_rating
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'This endpoint provides a Veteran''s disability ratings and related decisions and dates.


      Required information:

      * First Name

      * Last Name

      * Date of Birth

      * Street Address

      * City

      * State

      * Country

      * Zipcode


      Optional information:

      * Middle Name

      * Gender

      * Mother''s Maiden Name

      * Home Phone Number

      * Birth Place City

      * Birth Place State

      * Birth Place Country


      Tips for finding a match:

      * First and Last Name, Address and DOB are often essential to uniquely identifying

      a Veteran.

      * Home Address is recommen'
  - info:
      name: Search for information about a Veteran's disability rating using Social Security number and demographic data Data
        returned includes individual and combined ratings, diagnoses, and eligibility dates for compensation for service-connected
        conditions.(restricted access).
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/restricted/disability_rating
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'This endpoint provides a Veteran''s combined and individual disability ratings and

      related decisions and dates. It allows searching for a Veteran using Social Security number and demographic information.


      If using Social Security number, the following information is required:

      * Social Security number

      * First name

      * Last name

      * Birth date


      If using demographic data, the following information is required:

      * First Name

      * Last Name

      * Birth date

      * Street Address

      * City

      * State

      * Country

      * Zipcode


      The'
  - info:
      name: Get information about a Veteran's VA disability ratings. Data returned includes individual and combined ratings
        and eligibility dates for compensation for service-connected conditions.
      type: http
    http:
      method: GET
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/summary/disability_rating
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: This endpoint provides disability ratings and related decisions and dates for a Veteran, based on the ID in the
      bearer token.
  - info:
      name: Search for information about a Veteran's VA disability ratings using demographic data. Data returned includes
        individual and combined ratings and eligibility dates for compensation for service-connected conditions.
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/summary/disability_rating
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'This endpoint provides a Veteran''s disability ratings and related decisions and dates.


      Required information:

      * First Name

      * Last Name

      * Date of Birth

      * Street Address

      * City

      * State

      * Country

      * Zipcode


      Optional information:

      * Middle Name

      * Gender

      * Mother''s Maiden Name

      * Home Phone Number

      * Birth Place City

      * Birth Place State

      * Birth Place Country


      Tips for finding a match:

      * First and Last Name, Address and DOB are often essential to uniquely identifying

      a Veteran.

      * Home Address is recommen'
  - info:
      name: Search for information about a Veteran's VA disability ratings using Social Security number and demographic data.
        Data returned includes individual and combined ratings and eligibility dates for compensation for service-connected
        conditions. (restricted access)
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/restricted/summary/disability_rating
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: "This endpoint provides a Veteran's disability ratings and related decisions and dates.   It allows searching for\
      \ a Veteran using Social   Security number and demographic information.\n\n  If using Social Security number, the following\
      \ information is required:\n  * Social Security number\n  * First name\n  * Last name\n  * Birth date\n\n  If using\
      \ demographic data, the following information is required:\n  * First Name\n  * Last Name\n  * Birth date\n  * Street\
      \ Address\n  * City\n  * State\n  * Country\n  * Zipc"
- info:
    name: Enrolled Benefits
    type: folder
  items:
  - info:
      name: Get enrolled benefits information.
      type: http
    http:
      method: GET
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/enrolled_benefits
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'This endpoint returns select enrolled benefits for a Veteran.

      If the Veteran is enrolled, the codes and names for benefits they are

      receiving will be returned for the following benefit types:


      * Compensation (Code C)

      * 306 Pension (Code 306P)

      * Old Law Pension (Code OLP)

      * Improved Pension (Code IP)

      '
  - info:
      name: Get enrolled benefits information using demographics to search for the Veteran.
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/enrolled_benefits
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'This endpoint returns select enrolled benefits for a Veteran.

      If the Veteran is enrolled, the codes and names for benefits they are

      receiving will be returned for the following benefit types:


      * Compensation (Code C)

      * 306 Pension (Code 306P)

      * Old Law Pension (Code OLP)

      * Improved Pension (Code IP)


      Required information:

      * First Name

      * Last Name

      * Date of Birth

      * Street Address

      * City

      * State

      * Country

      * Zipcode


      Optional information:

      * Middle Name

      * Gender


      Tips for finding a match:


      * First a'
- info:
    name: Flashes
    type: folder
  items:
  - info:
      name: Retrieve certain benefit flashes associated with a Veteran.
      type: http
    http:
      method: GET
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/flashes
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'A flash is an attribute on a Veteran''s profile that describes special

      circumstances which can apply to a Veteran. Flashes can aid in

      properly routing claims or determining eligibility for some VA

      benefits.


      This endpoint currently shares the following flashes

      if they have been assigned to the Veteran.


      * Agent Orange (AO) Exposure Verified

      * Gulf War Veteran PACT Eligibility Verified


      If neither of these flashes exist for the Veteran, then a 200 response

      with an empty dataset will be returned.


      '
  - info:
      name: Retrieve certain benefit flashes associated with a Veteran using demographics to search for the Veteran.
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/flashes
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'A flash is an attribute on a Veteran''s profile that describes special

      circumstances which can apply to a Veteran. Flashes can aid in

      properly routing claims or determining eligibility for some VA

      benefits.


      This endpoint currently shares the following flashes

      if they have been assigned to the Veteran.


      * Agent Orange (AO) Exposure Verified

      * Gulf War Veteran PACT Eligibility Verified


      If you have a use case for additional flashes, please

      contact us with the details.


      Required information:

      * Firs'
- info:
    name: Permanent And Total Disability
    type: folder
  items:
  - info:
      name: Get information about a Veteran's P&T disability and IU disability statuses and effective dates.
      type: http
    http:
      method: GET
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/permanent_and_total_disability
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: This endpoint provides a Veteran's permanent and total (P&T) disability and total disability based on Individual
      Unemployability (IU) statuses and effective dates, based on the ID in the bearer token.
  - info:
      name: Search for information about a Veteran's P&T disability and IU disability statuses and effective dates, based
        on demographic data.
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/permanent_and_total_disability
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: " This endpoint returns a Veteran's information about permanent and total (P&T) disability and total disability\
      \ based on Individual Unemployability (IU) statuses and effective dates.\n\n  Required information:\n\n  * First name\n\
      \  * Last name\n  * Date of birth\n  * Street address\n  * City\n  * State\n  * Country\n  * ZIP code\n\n  Optional\
      \ information:\n\n  * Middle name\n  * Gender\n  * Mother's maiden name\n  * Home phone number\n  * Birthplace city\n\
      \  * Birthplace state\n  * Birthplace country\n\n  Tips for findin"
  - info:
      name: Search for information about a Veteran's P&T disability and IU disability statuses and effective dates (restricted
        access).
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/restricted/permanent_and_total_disability
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: "This endpoint returns a Veteran's information about permanent and total (P&T) disability and total disability based\
      \ on Individual Unemployability (IU) statuses and effective dates. It allows searching for a Veteran using a Social\
      \ Security number and demographic information.\n\n If using a Social Security number,  the following information is\
      \ required:\n\n * Social Security number\n * First name\n * Last name\n * Date of birth\n\n If using demographic data,\
      \  the following information is required:\n\n * Firs"
- info:
    name: Service History
    type: folder
  items:
  - info:
      name: Retrieve the service history of a Veteran.
      type: http
    http:
      method: GET
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/service_history
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: This endpoint provides a Veteran's detailed service history, including all military service episodes with the first
      and last name of the Veteran, the branch of service, start and end dates, paygrade, discharge status, and separation
      reason. It also provides start and end dates and locations for each deployment within each episode of service.
  - info:
      name: Retrieve the service history of a Veteran using demographics to search for the Veteran.
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/service_history
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'This endpoint provides a Veteran''s detailed service history including all military

      service episodes with the first and last name of the Veteran, the branch of service,

      start and end dates, paygrade, discharge status, and separation reason. It also

      provides start and end dates and locations for each deployment within each episode

      of service.


      Required information:

      * First Name

      * Last Name

      * Date of Birth

      * Street Address

      * City

      * State

      * Country

      * Zipcode


      Optional information:

      * Middle Name

      * Ge'
- info:
    name: Status
    type: folder
  items:
  - info:
      name: Confirm whether an individual is a Title 38 Veteran.
      type: http
    http:
      method: GET
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/status
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: " Indicates whether an individual is \"Confirmed\" or \"Not Confirmed\" as a\n [Title 38 Veteran](https://www.ecfr.gov/current/title-38)\
      \ according to VA.\n  ```\"not confirmed\"``` can mean several different things, depending on\n the following not_confirmed_reason\
      \ values:\n- ```PERSON_NOT_FOUND```: The person was not found in VA source systems\n with the provided information.\
      \ Including more demographic data\n for a Veteran increases the likelihood of finding their records\n in VA source systems.\n\
      \ - ```NOT_TI"
  - info:
      name: Confirm whether an individual is a Title 38 Veteran using demographics
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/status
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'Confirm an individual''s Title 38 Veteran status according to VA.

      This endpoint accepts demographic information for the person to

      be confirmed and matches it against VA records. If there are

      differences between the data entered and the data on file, a

      match to a person may not be found. If a successful match is

      identified, Title 38 Veteran status is checked.


      - ```"confirmed"``` indicates Title 38 Veteran status.

      - ```"not confirmed"``` can mean several different things, depending on

      the followin'
  - info:
      name: Confirm whether an individual is a Title 38 veteran using Social Security number and demographics.
      type: http
    http:
      method: POST
      url: https://sandbox-api.va.gov/services/veteran_verification/{version}/restricted/status
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: client_credentials
        accessTokenUrl: https://api.va.gov/oauth2/veteran-verification/system/v1/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: 'Confirm an individual''s Title 38 Veteran status according to VA.

      This endpoint accepts a Social Security number and/or demographic

      information for the person to be confirmed and matches it against

      VA records. If there are differences between the data entered and

      the data on file, a match to a person may not be found. If a

      successful match is identified, Title 38 Veteran status is checked.


      - ```"confirmed"``` indicates Title 38 Veteran status.

      - ```"not confirmed"``` can mean several different t'
bundled: true