Mock sample for your project: Veteran Confirmation API

Integrate with "Veteran Confirmation API" from va.gov in no time with Mockoon's ready to use mock sample

Veteran Confirmation

va.gov

Version: 0.0.1


Use this API in your project

Start working with "Veteran Confirmation API" right away by using this ready-to-use mock sample. API mocking can greatly speed up your application development by removing all the tedious tasks or issues: API key provisioning, account creation, unplanned downtime, etc.
It also helps reduce your dependency on third-party APIs and improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.

Description

The Veteran Confirmation API allows you to confirm Veteran status for a given person. This can be useful for offering Veterans discounts or other benefits.
The API will only return “Confirmed” or “Not Confirmed”.
Quickstart Guide
1. Get Access Credentials
Get started by filling out the form on the Apply for VA Lighthouse Developer Access page.
After submitting a request, you will receive your credentials for using the API in the Development environment, which allows you to try it out with mock data before moving to the Production environment.
2. Test the API
In the endpoint documentation below, we've provided a curl command builder for trying out the API before implementation with your app.
Use Test User attributes to populate the request body.
3. Build your app
The base URI for the Veteran Confirmation API in the Sandbox environment is:
https://sandbox-api.va.gov/services/veteran_confirmation/v0
In this environment, use attributes from the list of Test Users. Only Test Users can return a "confirmed" response.
Check out some of our sample apps. Please visit our VA Lighthouse Support portal should you need further assistance.
4. Show us a demo and get access to the Production environment
After building your app, we ask that you give us a demo before we set you up with production credentials. Please see the Path to Production page for more details.
Authorization
This API requires an API key in combination with identifiable information for the person being confirmed listed below. API requests are authorized through a symmetric API token provided in an HTTP header with name apikey. Including more information has a better chance of making a match and returning a Confirmed status.
Required information:
First Name
Last Name
Date of Birth
Social Security Number
Optional information:
Middle Name
Gender
Reference
Sandbox vs. Production Data
APIs accessed via the Sandbox environment are using the same underlying logic as VA’s production APIs; only the underlying data store is different.
Master Veteran Index (MVI)
The Master Veteran Index confirms a user's identity. In Production, several factors are considered to confirm identity. These include: a user’s first name, last name, date of birth and Social Security number. The MVI is mocked in the Sandbox environment. In this environment, the only factor used to confirm identity is the Social Security number.
Rate Limiting
We implemented basic rate limiting of 60 requests per minute. If you exceed this quota, your request will return a 429 status code. You may petition for increased rate limits by emailing and requests will be decided on a case by case basis.
Raw Open API Spec
https://api.va.gov/services/veteran_confirmation/docs/v0/api

Other APIs by va.gov

Benefits Intake

va.gov
The Benefits Intake API allows authorized third-party systems used by Veteran Service Organizations (VSOs), agencies, and Veterans to digitally submit VA benefits claim documents directly to the Veterans Benefits Administration's (VBA) claims intake process. This API handles documents related to the following benefit claim types:
Compensation
Pension/Survivors Benefits
Education
Fiduciary
Insurance
Veteran Readiness & Employment (VRE)
Board of Veteran Appeals (BVA)
This API also provides submission status updates until documents are successfully established for VBA claim processing, eliminating the need for users to switch between systems to manually check whether documents have been successfully uploaded.
Background
This API provides a secure, efficient, and tracked alternative to mail or fax for VA benefit claim document submissions. Documents are uploaded directly to the VBA so they can be processed as quickly as possible.
Technical overview
The Benefits Intake API first provides an upload location and unique submission identifier, and then accepts a payload consisting of a document in PDF format, zero or more optional attachments in PDF format, and some JSON metadata.
The metadata describes the document and attachments, and identifies the person for whom it is being submitted. This payload is encoded as binary multipart/form-data (not base64). The unique identifier supplied with the payload can subsequently be used to request the processing status of the uploaded document package.
To avoid errors and processing delays, API consumers are encouraged to validate the zipcode,fileNumber, veteranFirstName, veteranLastName and businessLine fields before submission according to their description in the DocumentUploadMetadata model and use the 'businessLine' attribute for the most efficient processing. Additionally, please ensure no PDF user or owner passwords are used in submitted PDFs.
Attachment & file size limits
There is no limit on the number of files a payload can contain, but size limits do apply.
Uploaded documents cannot be larger than 21" x 21"
The entire payload cannot exceed 5 GB
No single file in a payload can exceed 100 MB
Date of receipt
The date that documents are successfully submitted through the Benefits Intake API is used as the official VA date of receipt. However, note that until a document status of received, processing, success, or vbms is returned, a client cannot consider the document received by VA.
A status of received means that the document package has been transmitted, but may not be validated. Any errors with the document package, such as unreadable PDFs or a Veteran not found, will cause the status to change to error.
If the document status is error, VA has not received the submission and cannot honor the submission date as the date of receipt.
Authentication and Authorization
API requests are authorized through a symmetric API token, provided in an HTTP header with name 'apikey'. Request an API key.
Testing in the sandbox environment
In the sandbox environment, the final status of a submission is received and submissions do not actually progress to the central mail repository or VBMS.
Progress beyond the received status can be simulated for testing. We allow passing in a Status-Override header on the /uploads/{id} endpoint so that you can change the status of your submission to simulate the various scenarios.
The available statuses are pending, uploaded, received, processing, success, vbms, and error. The meaning of the various statuses is listed below in Models under DocumentUploadStatusAttributes.
Test data
We use mock test data in the sandbox environment. Data is not sent upstream and it is not necessary to align submitted test data with any other systems' data.
Upload operation
Allows a client to upload a multi-part document package (form + attachments + metadata).
Client Request: POST https://sandbox-api.va.gov/services/vba_documents/v1/
No request body or parameters required
Service Response: A JSON API object with the following attributes:
guid: An identifier used for subsequent status requests
location: A URL to which the actual document package payload can be submitted in the next step. The URL is specific to this upload request, and should not be re-used for subsequent uploads. The URL is valid for 900 seconds (15 minutes) from the time of this response. If the location is not used within 15 minutes, the GUID will expire. Once expired, status checks on the GUID will return a status of expired.
Note: If, after you've submitted a document, the status hasn't changed to uploaded before 15 minutes has elapsed, we recommend retrying the upload in order to make sure the document properly reaches our servers. If the upload continues to fail, try encoding the payload as Base64 (See below).
Client Request: PUT to the location URL returned in Step 2.
Request body should be encoded as binary multipart/form-data (base64 also available - see details below), equivalent to that generated by an HTML form submission or using “curl -F…”. The format is described in more detail below.
No apikey authorization header is required for this request, as authorization is embedded in the signed location URL.
Service Response: The HTTP status indicates whether the upload was successful.
Additionally, the response includes an ETag header containing an MD5 hash of the submitted payload. This can be compared to the submitted payload to ensure data integrity of the upload.
Status caching
Due to current system limitations, data for the /uploads/report endpoint is cached for one hour.
A request to the /uploads/{id} endpoint will return a real-time status for that GUID, and update its status in /uploads/report.
The updated_at field indicates the last time the status for a given GUID was updated.
Optional Base64 encoding
Base64 is an encoding scheme that converts binary data into text format, so that encoded textual data can be easily transported over networks uncorrupted and without data loss.
Base64 can be used to encode binary multipart/form-data it in its entirety. Note that the whole payload must be encoded, not individual parts/attachments.
After encoding your payload, you'll be required to preface your base64 string with data:multipart/form-data;base64, in order to allow our system to distinguish the file type. Your final string payload would look something like data:multipart/form-data;base64,(encryption string)== and close with the standard == marker. Note that the multipart boundaries i.e. -----WebKitFormBoundaryVfOwzCyvug0JmWYo and ending ------WebKitFormBoundaryVfOwzCyvug0JmWYo- must also be included.
Consumer onboarding process
When you're ready to move to production, request a production API key.

VA Facilities

va.gov
Background
This RESTful API provides information about physical VA facilities. Information available includes
geographic location, address, phone, hours of operation, and available services.
VA operates several different types of facilities, the types represented in this API include:
Health Facilities (vha)
Benefits Facilities (vba)
Cemeteries (nca)
Vet Centers (vc)
To read an FAQ on how wait times are calculated, click the "For more information" link on this page.
Getting Started
Base URLs
The base URLs for the VA Facilities API in the various environments are:
Sandbox: https://sandbox-api.va.gov/services/va_facilities/v0
Production: https://api.va.gov/services/va_facilities/v0
Authorization
API requests are authorized through a symmetric API token, provided in an HTTP header with name apikey.
Response Formats
Clients may request several response formats by setting the Accept header.
application/json - The default JSON response format complies with JSON API. This media type is not available for bulk requests using the /facilities/all endpoint. It will return 406 Not Acceptable.
application/geo+json - GeoJSON-compliant format, representing each facility as a feature with a point geometry.
application/vnd.geo+json - Deprecated. Prefer application/geo+json.
text/csv - Available for the bulk download operation only. Some structured fields are omitted from the CSV response.
Response Elements
Some data elements within the response are only present for facilities of a given type:
The patient satisfaction scores contained in the satisfaction element are only applicable
to VA health facilities.
The patient wait time values contained in the wait_times element are only applicable to
VA health facilities.
The list of available services in the services element is only applicable to VA health and
benefits facilities.
The operational hours special instructions contained in the operationalhoursspecial_instructions element is only applicable to VA health and Vet Center facilities.
Facility ID Formats and Constraints
A facility ID has the format prefix_stationNumber. The prefix is one of nca, vc, vba, or vha. Cemeteries may be national (VA) or non-national; non-national cemeteries have the station number prefixed with an s. There are no other constraints on the format. Examples:
Health: vha_402GA
Benefits: vba_539GB
National cemetery: nca_063
Non-national cemetery: nca_s1082
Vet center: vc_0872MVC
Mobile Facilities
The mobile health facilities move regularly within a region. If a facility comes back from this API with "mobile": "true", the latitude/longitude and address could be inaccurate. To get the exact current location, please call the number listed.
Deprecations
activestatus field is deprecated and replaced with operatingstatus.
application/vnd.geo+json media type is deprecated and replaced by application/geo+json
Reference
Raw VA Facilities Open API Spec
GeoJSON Format
JSON API Format

VA Forms

va.gov
Use the VA Forms API to search for VA forms, get the form's PDF link and metadata, and check for new versions.
Visit our VA Lighthouse Contact Us page for further assistance.
Background
This API offers an efficient way to stay up-to-date with the latest VA forms and information. The forms information listed on VA.gov matches the information returned by this API.
Search by form number, keyword, or title
Get a link to the form in PDF format
Get detailed form metadata including the number of pages, related forms, benefit categories, language, and more
Retrieve the latest date of PDF changes and the SHA256 checksum
Identify when a form is deleted by the VA
Technical summary
The VA Forms API collects form data from the official VA Form Repository on a nightly basis. The Index endpoint can return all available forms or, if an optional query parameter is passed, will return only forms that may relate to the query value. When a valid form name is passed to the Show endpoint, it will return a single form with additional metadata and full revision history. A JSON response is given with the PDF link (if published) and the corresponding form metadata.
Authentication and authorization
The form information shared by this API is publicly available. API requests are authorized through a symmetric API token, provided in an HTTP header with name apikey. Get a sandbox API Key.
Testing in sandbox environment
Form data in the sandbox environment is for testing your API only, and is not guaranteed to be up-to-date. This API also has a reduced API rate limit. When you're ready to move to production, be sure to request a production API key.
SHA256 revision history
Each form is checked nightly for recent file changes. A corresponding SHA256 checksum is calculated, which provides a record of when the PDF changed and the SHA256 hash that was calculated. This allows end users to know that they have the most recent version and can verify the integrity of a previously downloaded PDF.
Valid PDF link
Additionally, during the nightly refresh process, the link to the form PDF is verified and the valid_pdf metadata is updated accordingly. If marked true, the link is valid and is a current form. If marked false, the link is either broken or the form has been removed.
Deleted forms
If the deleted_at metadata is set, that means the VA has removed this form from the repository and it is no longer to be used.

Other APIs in the same category

CORE API v2

core.ac.uk
You can use the CORE API to access the
resources harvested and enriched by CORE. If you encounter any problems with the API, please report them to us.
Overview
The API is organised by resource type. The resources are articles,
journals and repositories and are represented using JSON data format. Furthermore,
each resource has a list of methods. The API also provides two global methods for accessing all resources at once.
Response format
Response for each query contains two fields: status and data.
In case of an error status, the data field is empty. The data field contains a single object
in case the request is for a specific identifier (e.g. CORE ID, CORE repository ID, etc.), or
contains a list of objects, for example for search queries. In case of batch requests, the response
is an array of objects, each of which contains its own status and data fields.
For search queries the response contains an additional field totalHits, which is the
total number of items which match the search criteria.
Search query syntax
Complex search queries can be used in all of the API search methods.
The query can be a simple string or it can be built using terms and operators described in Elasticsearch
documentation.
The usable field names are title, description, fullText,
authors, publisher, repositories.id, repositories.name,
doi, oai, identifiers (which is a list of article identifiers including OAI, URL, etc.), language.name
and year. Some example queries:
title:psychology and language.name:English
repositories.id:86 AND year:2014
identifiers:"oai:aura.abdn.ac.uk:2164/3837" OR identifiers:"oai:aura.abdn.ac.uk:2164/3843"
doi:"10.1186/1471-2458-6-309"
Retrieving the latest Articles
You can retrieve the harvested items since specific dates using the following queries:
repositoryDocument.metadataUpdated:>2017-02-10
repositoryDocument.metadataUpdated:>2017-03-01 AND repositoryDocument.metadataUpdated:
Sort order
For search queries, the results are ordered by relevance score. For batch
requests, the results are retrieved in the order of the requests.
Parameters
The API methods allow different parameters to be passed. Additionally, there is an API key parameter which is common to all API methods. For all API methods
the API key can be provided either as a query parameter or in the request header. If the API key
is not provided, the API will return HTTP 401 error. You can register for an API key here.
API methods

Transport Department, Assam

apisetu.gov.in
Driving License (DL) and Vehicle Registration Certificate (RC) of the State, as available on Parivahan Sewa (http://parivahan.co.in/) of Ministry of Road Transport and Highways, are available on DigiLocker. Citizens can pull these documents into their DigiLocker accounts.

Future Generali Total Insurance Solutions

apisetu.gov.in
Two Wheeler, Car, Commercial Vehicle, Home and Travel Insurance policies issued by Future Generali are available on DigiLocker and can be pulled by citizens in their account.

Directorate of Information Technology, Government of Tripura, Tripura

apisetu.gov.in
eDistrict Tripura (http://edistrict.tripura.gov.in/) is the online service delivery portal for TripuraState Govt. Certain documents issued by it (e.g. Income, Caste Certificates etc) can be pulled into citizens' DigiLocker accounts.

Department of Food, Public Distribution & Consumer Affairs (PDS), Jharkhand

apisetu.gov.in
Public distribution system (PDS) is an Indian food security system. Established by the Government of India under Ministry of Consumer Affairs, Food, and Public Distribution and managed jointly with state governments in India. Jharkhand PDS Ration Card Certificates is available in Digilocker for Citizen.

Gauhati University

apisetu.gov.in
GAUHATI UNIVERSITY (https://www.gauhati.ac.in/) has made available Registration Certificate in DigiLocker, which can be pulled by students into their accounts.

eDistrict Uttar Pradesh, Uttar Pradesh

apisetu.gov.in
eDistrict UP (http://edistrict.up.nic.in/) is the online service delivery portal for UP State Govt. Certain documents issued by it (e.g. Birth, Income, Caste Certificates etc) can be pulled into citizens' DigiLocker accounts.

Haryana State Board of School Education, Haryana

apisetu.gov.in
Board of School Education, Haryana (http://www.bseh.org.in/home/) has made available 2016-2019 Class XII & Class X results in DigiLocker, which can be pulled by students into their accounts.

Chitkara University

apisetu.gov.in
Degree Certificates of various courses issued by Chitkara University can be downloaded in citizen's DigiLocker account.

APIs.guru

Wikipedia for Web APIs. Repository of API specs in OpenAPI 3.0 format.
Warning: If you want to be notified about changes in advance please join our Slack channel.
Client sample: [Demo] [Repo]

eDistrict Andaman & Nicobar Islands, Andaman & Nicobar

apisetu.gov.in
eDistrict Andaman (https://edistrict.andaman.gov.in/) is the online service delivery portal for Andaman & Nicobar Islands. Certain documents issued by it (e.g. Local Certificate,Income Certificate,OBC Certificate,Resident Certificate etc) can be pulled into citizens' DigiLocker accounts.

Pramerica Life Insurance Ltd.

apisetu.gov.in
APIs provided by Pramerica Life Insurance Ltd..