Skip to main content
API docs by Redocly

VA Mobile API (0.0.0)

Download OpenAPI specification:Download

License: MIT

The Department of Veterans Affairs mobile API. All paths are relative to https://api.va.gov/mobile.

/

Returns a welcome message.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/

Returns urls for app use based on app build number, environment, and OS

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

App build and environment info

environment
required
string
Enum: "dev" "staging" "prod"
buildNumber
required
string
os
required
string
Enum: "android" "ios"

Responses

Request samples

Content type
application/json
{
  • "environment": "dev",
  • "buildNumber": "10",
  • "os": "android"
}

Response samples

Content type
application/json
{}

/v0/appeal/{id}

Returns info on all user's claims and appeals for mobile overview page. Should be identical to the following docs https://developer.va.gov/explore/api/appeals-status/docs?version=current

Authorizations:
Bearer
path Parameters
id
required
string

Appeal Id

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

/v0/appointments

Given a date range returns a list of upcoming VA, Community Care, and Express Care appointments. If start and end date ranges are not passed in then it defaults to - 1 year and + 1 year from the beginning of today's UTC date. Requesting a page out of bounds will return an empty list.

Authorizations:
Bearer
query Parameters
startDate
string <date-time>
Example: startDate=2020-10-29T07:00:00Z

The start date for the range of appointments in ISO 8601 UTC format

endDate
string <date-time>
Example: endDate=2021-11-29T08:00:00Z

The end date for the range of appointments in ISO 8601 UTC format

page[number]
integer
Example: page[number]=1

The page number requested. Defaults to 1.

page[size]
integer
Example: page[size]=10

The number of records to return per page. Defaults to 10.

useCache
boolean
Example: useCache=true

Whether or not to use this API's cache or fetch records from the upstream service

sort
string
Example: sort=-startDateUtc

Field to sort the appointments list by. Currently only supports startDateUtc. Prefixing - reverses the sort.

include[]
Array of strings
Example: include[]=pending

Field to include pending appointments. Currently only supports value pending. Redundant with field included[] for backwards compatibility but include is the correct one to use when following conventions.

included[]
Array of strings
Example: included[]=pending

Field to include pending appointments. Currently only supports value pending. Redundant with field include[] for backwards compatibility but include is the correct one to use when following conventions.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ],
  • "meta": {
    }
}

/v0/appointments/cancel/{cancelId}

Cancel an appointment by cancelId. Note only VA appointments can be cancelled online and some VA facilities do not support online cancellation. Only appointments that can be cancelled will have a cancelId.

Authorizations:
Bearer
path Parameters
cancelId
required
string

The cancel ID hash from an appointment returned in the GET appointments endpoint.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/appointments/check-in

Check into an appointment.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
appointmentIEN
string
locationId
string

Responses

Request samples

Content type
application/json
{
  • "appointmentIEN": "string",
  • "locationId": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/appointments/check-in/demographics

Retrieves demographics confirmation information which includes a field indicating if insurance verification is needed, patient contact information, emergency contact information and next-of-kin contact information.

Authorizations:
Bearer
query Parameters
location_id
required
string

Unique location identifier

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/appointments/check-in/demographics

Edit demographics confirmations.

Authorizations:
Bearer
Request Body schema: application/json
location_id
string
object

Responses

Request samples

Content type
application/json
{
  • "location_id": "string",
  • "demographicConfirmations": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/appointments/community_care/eligibility/{service_type}

Checks if user is eligible to make an appointment with Community Care for a type of service. Checks if user is registered at a site that is marked as accepting community care requests and community care eligibility api says that they're eligible for the type of care they chose

Authorizations:
Bearer
path Parameters
service_type
required
string

Type of service to check eligibility for. Can only be one of following options primaryCare, nutrition, podiatry, optometry, audiology.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/appointments/facility/eligibility

Checks if a list of facilities if they are eligible to create a appointment request to provide the given type of service at the facility.

Authorizations:
Bearer
path Parameters
serviceType
required
string
Enum: "amputation" "audiology" "covid" "optometry" "outpatientMentalHealth" "moveProgram" "foodAndNutrition" "clinicalPharmacyPrimaryCare" "primaryCare" "homeSleepTesting" "socialWork" "cpap" "ophthalmology"

Type of service to check eligibility for.

FacilityIds[]
required
Array of strings

List of facility ids

type
required
string

type of appointment. Can either be 'request' or 'direct' but only request will be used until direct scheduling functionality is built out

query Parameters
page[number]
integer
Example: page[number]=2

The page number requested. Defaults to 1.

page[size]
integer
Example: page[size]=10

The number of records to return per page. Defaults to 3.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/appointments/facilities/{facility_id}/clinics

Returns all available clinics at a facility for a given type of service.

Authorizations:
Bearer
path Parameters
facility_id
required
string
Example: 436GC

Facility ID

query Parameters
service_type
required
string
Enum: "amputation" "audiology" "covid" "optometry" "outpatientMentalHealth" "moveProgram" "foodAndNutrition" "clinicalPharmacyPrimaryCare" "primaryCare" "homeSleepTesting" "socialWork" "cpap" "ophthalmology"

Service Type

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/appointments/facilities/{facility_id}/clinics/{clinic_id}/slots

Accepts date range for a clinic at a va facility and returns available slots for a a direct schedule appointment.

Authorizations:
Bearer
query Parameters
startDate
string <date-time>
Example: startDate=2020-10-29T07:00:00Z

The start date for the range of appointments slots in ISO 8601 UTC format. If not provided the start date will be considered now.

endDate
string <date-time>
Example: endDate=2021-11-29T08:00:00Z

The end date for the range of appointments slots in ISO 8601 UTC format. If not provided the end date will be 2 months from today's date

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/appointments/facilities/{facility_id}/clinics/{clinic_id}/slots

Accepts date range for a va facility and returns available slots for a a direct schedule appointment.

Authorizations:
Bearer
path Parameters
location_id
required
string

The facility division ID

query Parameters
startDate
string <date-time>
Example: startDate=2020-10-29T07:00:00Z

The start date for the range of appointments slots in ISO 8601 UTC format. If not provided the start date will be considered now.

endDate
string <date-time>
Example: endDate=2021-11-29T08:00:00Z

The end date for the range of appointments slots in ISO 8601 UTC format. If not provided the end date will be 2 months from today's date

clinic_id
string

The clinic IEN. Required if clinical_service not provided.

clinical_service
string

The clinical service (type of care) to find appointment slots for. Required if clinic_id not provided.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/appointments/va/eligibility

Lists types of service. For each type of service, lists users registered facilities that support request and direct appointments.

Authorizations:
Bearer
query Parameters
FacilityIds[]
required
Array of arrays

Array of facilities to be checked for service eligibility

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/appointment

Creates a new appointment or appointment request.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
One of
kind
required
string (AppointmentKind)
Enum: "clinic" "cc" "telehealth" "phone"

The kind of appointment:

  • clinic - A clinic (in-person) appointment
  • cc - A community-care appointment
  • telehealth - A virtual appointment
status
required
string
Value: "proposed"

Always 'proposed' for requests

serviceType
required
string
Enum: "amputation" "audiology-hearing aid support" "audiology-routine exam" "covid" "optometry" "outpatientMentalHealth" "moveProgram" "foodAndNutrition" "clinicalPharmacyPrimaryCare" "podiatry" "primaryCare" "homeSleepTesting" "socialWork" "cpap" "ophthalmology"

The care type for the appointment

Array of objects (Practitioner)

practitioners

locationId
required
string

The sta6aid for the VAfacility where the appointment is registered.

required
Array of objects (Period)

A list of requested periods for appointment.

required
object (PatientContact)

Patient contact information

preferredTimesForPhoneCall
required
Array of strings
Items Enum: "Morning" "Afternoon" "Evening"

A list of times the patient prefers to be contacted by phone.

required
object (PreferredLocation)

The location that the veteran requested the appointment to be scheduled in.

comment
required
string

Free-form comment section to provide additional information about an appointment request.

preferredLanguage
required
string

Preferred Language

Responses

Request samples

Content type
application/json
Example
{
  • "kind": "clinic",
  • "status": "proposed",
  • "serviceType": "optometry",
  • "practitioners": [
    ],
  • "locationId": "983GC",
  • "requestedPeriods": [
    ],
  • "contact": {
    },
  • "preferredTimesForPhoneCall": [
    ],
  • "preferredLocation": {
    },
  • "comment": "free form comment here",
  • "preferredLanguage": "English"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/awards

Get current awards overview

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/claim/{id}

Returns info on all user's claims and appeals for mobile overview page

Authorizations:
Bearer
path Parameters
id
required
string

Claim Id

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/claim/{id}/documents

Post tracked item document for upload, returns jobId for upload process

Authorizations:
Bearer
path Parameters
id
required
string

Claim Id

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: multipart/form-data
documentType
string
file
string <binary>
string or null
trackedItemId
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/claim/{id}/documents/multi-image

Post multiple images to be combined into one pdf for upload, returns jobId for upload process

Authorizations:
Bearer
path Parameters
id
required
string

Claim Id

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
files
required
Array of strings

base64 strings of images to upload together

trackedItemId
required
string

item id from claim eventsTimeline

documentType
required
string

Responses

Request samples

Content type
application/json
{
  • "files": [
    ],
  • "trackedItemId": "string",
  • "documentType": "L827"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/claim/{id}/request-decision

Request decision on a given claim, returns job id

Authorizations:
Bearer
path Parameters
id
required
string

Claim Id

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/claims/decision-letters

Returns the list of claim decision letters for given user

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/claims/decision-letters/{document_id}/download

Downloads a decision letter

Authorizations:
Bearer
path Parameters
document_id
required
any

id of the document being downloaded

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/claims/pre-need-burial

Submits a new Preneeds Burial application.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
object
required
object
required
object
required
object
hasCurrentlyBuried
required
string
Enum: "1" "2" "3"
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "application": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/claims/pre-need-burial/cemeteries

Returns info on all cemeteries for preneed burial

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/claims-and-appeals-overview

Returns info on all user's claims and appeals for mobile overview page

Authorizations:
Bearer
query Parameters
startDate
string <date-time>
Example: startDate=2020-10-29T07:00:00Z

The start date for the range of appointments in ISO 8601 UTC format. If not provided the start date will be considered Jan. 1st 1700.

endDate
string <date-time>
Example: endDate=2021-11-29T08:00:00Z

The end date for the range of appointments in ISO 8601 UTC format. If not provided the end date will be 1 year from today's date

page[number]
integer
Example: page[number]=2

The page number requested. Defaults to 1.

page[size]
integer
Example: page[size]=10

The number of records to return per page. Defaults to 10.

showCompleted
boolean
Example: showCompleted=true

true will return only completed records, false will show only open records, not including the parameter will return all records regardless of completed status

useCache
boolean
Example: useCache=true

Whether or not to use this API's cache or fetch records from the upstream service

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
Example
{
  • "data": [
    ],
  • "meta": {
    }
}

/v0/community-care-providers

Returns a list of community care providers who provide the requested medical specialty within a certain radius of the user (default) or facility (if facility id is provided in query params).

Authorizations:
Bearer
query Parameters
serviceType
required
string
Example: serviceType=primaryCare

The medical specialty the user is searching for formatted in camel case. Must be one of primaryCare, foodAndNutrition, podiatry, optometry, audiologyRoutineExam, audiologyHearingAidSupport.

facilityId
string
Example: facilityId=978

Optional facility id. When provided, we search for CC providers near the facility. When omitted, we search for CC providers near the user's home address.

page[number]
integer
Example: page[number]=1

The page number requested. Defaults to 1.

page[size]
integer
Example: page[size]=10

The number of records to return per page. Defaults to 10.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v0/debts

Returns a list of user's debts.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v0/debts/{id}

Returns a users debt by id.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

/v0/dependents

Returns a list of user's dependents. Dependent SSN is also available but is removed to limit PII exposure.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/dependents

Submit a supplemental claim for compensation (21-686C & 21-674).

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
optionSelection
object
object
object
object
object
object
object
object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "optionSelection": { },
  • "veteranInformation": {
    },
  • "addChild": {
    },
  • "addSpouse": {
    },
  • "reportDivorce": {
    },
  • "deceasedDependents": {
    },
  • "reportChildMarriage": {
    },
  • "reportChildStoppedAttendingSchool": {
    },
  • "reportStepchildNotInHousehold": {
    },
  • "report674": {
    },
  • "householdIncome": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/dependents/request-decisions

Returns the list of dependents verifications and diaries

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/disability-rating

Returns the list of disability ratings for given user

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/efolder/documents

Returns the user's list of documents in efolder

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/efolder/documents/{documentId}/download

returns requested document

Authorizations:
Bearer
path Parameters
document_id
required
string
Example: {93631483-E9F9-44AA-BB55-3552376400D8}

ID of the document to be returned.

query Parameters
file_name
required
string

File name of the document to be returned.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/enrollment-status

Returns the user's VA enrollment status.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/facilities-info

Retrieves facilities info for a user's va treatment facilities

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/facilities-info/{sort_method}

Retrieves facilities info for all facilities a given user has the ability to schedule appointments at

Authorizations:
Bearer
path Parameters
sort_method
required
string
Enum: "current" "home" "alphabetical" "appointments"

Sort method (Closest to home or current location, alphabetical, or by most recent appointment location) Note - When most recent appointment is selected any facility that doesn't appear in the user's appointments will be sorted alphabetically after those that do appear in the appointments list

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

Lat Long for user's current location. Only required if sort method is current, but can be supplied anyway

lat
number

lat for user's current location

long
number

long for user's current location

Responses

Request samples

Content type
application/json
{
  • "lat": 34.5968,
  • "long": 10.5796
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/financial-status-reports/download

Returns financial status report PDF

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/health/immunizations

Returns the list of immunization records for given user

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/health/allergy-intolerances

Retrieves a list of the user's known allergies related to medication, food, or other substances

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{}

/v0/health/labs-and-tests

List patient labs and tests. Each report contains a list of which tests were a part of the report, along with links to get the results for those tests.

query Parameters
category
string

The category classifies the clinical discipline, department, or diagnostic service that created the report

code
string

A code that indicates the type of information contained within the diagnostic report. Supported values are from the LOINC diagnostic report codes.

date
datetime

A date or range of dates (maximum of 2) that describe the date that the diagnostic report was recorded. Supported formats are: YYYY, YYYY-MM, YYYY-MM-DD, YYYY-MM-DD'T'HH:MM:SSZ

status
datetime

The status of the report.

lastUpdated
datetime

The date when the record was last updated. Supported formats are: YYYY, YYYY-MM, YYYY-MM-DD, YYYY-MM-DD'T'HH:MM:SSZ

page
integer

The page number being requested.

count
integer

The number of resources that should be returned in a single page. The maximum count size is 100. Defaults to 30.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{}

/v0/health/observations/{id}

Gets an observation from a user's diagnostic report

path Parameters
id
required
string

id of observation

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{}

/v0/health/locations/{id}

Returns location info based on location id from vaccine record

Authorizations:
Bearer
path Parameters
id
required
string

location id from immunization info

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/health/rx/prescriptions

Returns the users prescriptions.

Authorizations:
Bearer
query Parameters
sort
string

what field to sort array of prescriptions by. fields that can be sorted: prescription_id, refill_status, refill_submit_date, refill_date, facility_name, ordered_date, prescription_name, dispensed_date. date fields sort by DESC by default while all others default to ASC. To get the opposite sort direction negate the field with a '-'. EX: -prescription_id

filter
string

filter by field values. Syntax: ?filter[refill_status][eq]=refillinprocess. fields that can be filtered: prescription_id, refill_status, refill_submit_date, facility_name. eq can be switched out with not_eq. to filter by multiple values of the same field, deliminate the parameter value with commas. Syntax: ?filter[refill_status][eq]=refillinprocess,active

page[number]
integer
Example: page[number]=1

The page number requested. Defaults to 1.

page[size]
integer
Example: page[size]=10

The number of records to return per page. Defaults to 10.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v0/health/rx/prescriptions/refill

Requests refill for prescriptions.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

array of prescription ids to request refill

ids
required
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "6260ab13-177f-583d-b2dc-1b350404abb7",
  • "type": "PrescriptionRefills",
  • "attributes": {
    }
}

/v0/health/rx/prescriptions/{id}/tracking

Requests list of tracking data for a prescription id

Authorizations:
Bearer
path Parameters
id
required
object
Example: 13650545

id of the prescription tracking data is being requested for

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/letters

Returns the list of letter names and types for the given user

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/letters/beneficiary

Returns benefit info and options for the given user with or without a dependent

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/letters/{type}/download

Returns requested letter for download. Downloads as either PDF or JSON, dependent upon format param. Defaults to PDF when format is not specified.

Authorizations:
Bearer
path Parameters
type
required
string
Enum: "benefit_summary" "benefit_summary_dependent" "benefit_verification" "certificate_of_eligibility" "civil_service" "commissary" "medicare_partd" "minimum_essential_coverage" "proof_of_service" "service_verification"

letter type

query Parameters
format
string
Enum: "pdf" "json"

format

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
militaryService
required
boolean
serviceConnectedDisabilities
required
boolean
serviceConnectedEvaluation
required
boolean
nonServiceConnectedPension
required
boolean
monthlyAward
required
boolean
unemployable
required
boolean
specialMonthlyCompensation
required
boolean
adaptedHousing
required
boolean
chapter35Eligibility
required
boolean
deathResultOfDisability
required
boolean
survivorsAward
required
boolean

Responses

Request samples

Content type
application/json
{
  • "militaryService": true,
  • "serviceConnectedDisabilities": true,
  • "serviceConnectedEvaluation": true,
  • "nonServiceConnectedPension": true,
  • "monthlyAward": true,
  • "unemployable": true,
  • "specialMonthlyCompensation": true,
  • "adaptedHousing": true,
  • "chapter35Eligibility": true,
  • "deathResultOfDisability": true,
  • "survivorsAward": true
}

Response samples

Content type
No sample

/v0/maintenance_windows

List maintenance windows

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/messaging/health/folders

List available secure messaging folders

Authorizations:
Bearer
query Parameters
page
integer
Example: page=1

The page number requested

perPage
integer
Example: perPage=10

The number of records to return per page. Defaults to 100

useCache
boolean
Example: useCache=true

Whether or not to use this API's cache or fetch records from the upstream service. Defaults to true.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "meta": {
    }
}

/v0/messaging/health/folder

Create a new secure messaging folder

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
required
object
name
required
string

Responses

Request samples

Content type
application/json
{
  • "folder": {
    }
}

Response samples

Content type
application/json
{}

/v0/messaging/health/folders/{id}

Get a secure messaging folder

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{}

/v0/messaging/health/folders/{id}/messages

List messages in a secure messaging folder.

When listing messages, the response for each message will include most but not all of the message attributes. Specifically, the message body and attachment information is not included. Those attributes can be obtained by getting the specific message resource.

Authorizations:
Bearer
query Parameters
sort
string

what field to sort array of messages by. fields that can be sorted: sent_date, subject, sender_name, recipient_name. The date field sorts by descending order by default while all others default to ASC. To get the opposite sort direction negate the field with a '-'. EX: -recipient_name. Default sort field is sent_date.

filter
string

filter by field values. Syntax: ?filter[sender_name][eq]=JOHN DEER. fields that can be filtered: sent_date, subject, sender_name, recipient_name. Available operators include 'eq' and 'not_eq'. Date fields can use operators 'lteq' and 'gteq' (less/greater than or equal). string fields can use 'match' operator for partial matching. String fields can also be filtered by multiple values of the same field, deliminate the parameter value with commas. Syntax: ?filter[sender_name][eq]=John Deer,John Smith

page
integer
Example: page=1

The page number requested

perPage
integer
Example: perPage=10

The number of records to return per page. Defaults to 100

useCache
boolean
Example: useCache=true

Whether or not to use this API's cache or fetch records from the upstream service. Defaults to true.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v0/messaging/health/folders/{id}/threads

List of threads in a secure messaging folder

Authorizations:
Bearer
path Parameters
folderId
required
string

The id of the folder that threads are being retrieved from

query Parameters
pageSize,
string

The size of the pagination you want. Defaults to 10

page,
string

The page number to get based on your page size

sortField,
string
Enum: "SENDER_NAME" "RECIPIENT_NAME" "SENT_DATE" "DRAFT_DATE"

The field to sort the results by

sortOrder,
string
Enum: "ASC" "DESC"

The order to sort the results by

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

/v0/messaging/health/message_drafts

Save a new draft message

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
recipient_id
required
integer

The message recipient. This must be a valid recipient id that is assigned to the user. The list of valid recipients for a user can be obtained from the 

/v0/messaging/health/recipients
endpoint.

category
required
string

Message category. This must be one of the values returned by the 

/v0/messaging/health/messages/categories
endpoint.
body
required
string
subject
string
draft_id
integer

Specifies draft message ID to send. Draft message is deleted once sent. Note that the recipient_id, category, body, and subject included with this post will overwrite any of original values of the draft.

Responses

Request samples

Content type
application/json
{
  • "recipient_id": 1763526,
  • "category": "OTHER",
  • "body": "What is the proper dosage and how long should I take this medication?",
  • "subject": "Question about my medication",
  • "draft_id": 0
}

Response samples

Content type
application/json
{
  • "recipient_id": 1763526,
  • "category": "OTHER",
  • "body": "What is the proper dosage and how long should I take this medication?",
  • "subject": "Question about my medication",
  • "draft_id": 0
}

/v0/messaging/health/message_drafts/{id}

Update an existing draft message

Authorizations:
Bearer
path Parameters
id
required
string

The id of the draft that is to be updated

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "body": "the updated message"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/messaging/health/message_drafts/{reply_id}/replydraft

Save a new draft message as a reply to an existing message

Authorizations:
Bearer
path Parameters
reply_id
required
string

The id of the message that will be replied to

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
recipient_id
required
integer

The message recipient. This must be a valid recipient id that is assigned to the user. The list of valid recipients for a user can be obtained from the 

/v0/messaging/health/recipients
endpoint.

category
required
string

Message category. This must be one of the values returned by the 

/v0/messaging/health/messages/categories
endpoint.
body
required
string
subject
string
draft_id
integer

Specifies draft message ID to send. Draft message is deleted once sent. Note that the recipient_id, category, body, and subject included with this post will overwrite any of original values of the draft.

Responses

Request samples

Content type
application/json
{
  • "recipient_id": 1763526,
  • "category": "OTHER",
  • "body": "What is the proper dosage and how long should I take this medication?",
  • "subject": "Question about my medication",
  • "draft_id": 0
}

Response samples

Content type
application/json
{
  • "recipient_id": 1763526,
  • "category": "OTHER",
  • "body": "What is the proper dosage and how long should I take this medication?",
  • "subject": "Question about my medication",
  • "draft_id": 0
}

/v0/messaging/health/message_drafts/{reply_id}/replydraft/{draft_id}

Edit a draft message that was a reply to an existing message

Authorizations:
Bearer
path Parameters
reply_id
required
string

The id of the message that will be replied to

draft_id
required
string

The id of the draft that is to be updated

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "body": "the updated message"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/messaging/health/messages

Send a new secure message

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema:

New message body.

NOTES:

  • If a subject isn't included, default subject will be "{{Category}} Inquiry" (e.g. Medication Inquiry)
  • Messages can only be replied to for 120 days. After that, the message is considered "expired"
  • If sending a draft, include the draft's ID in the request body as `draft_id`. Draft will be deleted once sent. Any fields included in request body will overwrite original draft contents.
  • If including file attachments, this request must be sent as multipart/form-data
  • File attachment restrictions (as imposed by MHV):
    • User may attach up to 4 files
    • Accepted formats: doc, docx, jpg, pdf, png, rtf, txt, xls, xlsx
    • Single attachment cannot exceed 3 MB
    • Total attachment cannot exceed 6 MB
recipient_id
required
integer

The message recipient. This must be a valid recipient id that is assigned to the user. The list of valid recipients for a user can be obtained from the 

/v0/messaging/health/recipients
endpoint.

category
required
string

Message category. This must be one of the values returned by the 

/v0/messaging/health/messages/categories
endpoint.
body
required
string
subject
string
draft_id
integer

Specifies draft message ID to send. Draft message is deleted once sent. Note that the recipient_id, category, body, and subject included with this post will overwrite any of original values of the draft.

Responses

Request samples

Content type
{
  • "recipient_id": 1763526,
  • "category": "OTHER",
  • "body": "What is the proper dosage and how long should I take this medication?",
  • "subject": "Question about my medication",
  • "draft_id": 0
}

Response samples

Content type
application/json
{
  • "type": "messages",
  • "id": "123789",
  • "attributes": {
    },
  • "relationships": {
    },
  • "links": {},
  • "included": []
}

/v0/messaging/health/messages/categories

List available message categories

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/messaging/health/messages/signature

Gets user message signature preferences

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/messaging/health/messages/{id}

Moves a secure message to the "Deleted" folder

Authorizations:
Bearer
path Parameters
id
required
string

The id of the message that is to be deleted

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/messaging/health/messages/{id}

Get a secure message and mark the message as read.

NOTES:

  • Unlike listing messages in a folder, the message resource returned from this operation will include the message body and attachment information.
  • This GET operation is not fully idempotent and will set readReceipt field as 'READ'
  • If message has an attachment included, attachmentSize is displayed in bytes
Authorizations:
Bearer
query Parameters
useCache
boolean
Example: useCache=true

Whether or not to use this API's cache or fetch records from upstream when getting triage team information to determine if user is in triage team. See meta field 'user_in_triage_team'.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "type": "messages",
  • "id": "123789",
  • "attributes": {
    },
  • "relationships": {
    },
  • "links": {},
  • "included": [],
  • "meta": {
    }
}

/v0/messaging/health/messages/{id}/move

Moves a secure message to a specified folder

Authorizations:
Bearer
path Parameters
id
required
string

The id of the message that is to be moved

query Parameters
folder_id,
required
string

The id of the folder that the message is to be moved to

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/messaging/health/messages/{id}/attachments/{attachment_id}

Get a secure message attachment content as a direct binary download. Secure messaging supports the following file types/extensions: doc, docx, gif, jpg, pdf, png, rtf, txt, xls, xlsx.

Authorizations:
Bearer
path Parameters
id
required
integer

ID of the message that we are retrieving attachments of

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/messaging/health/messages/{id}/reply

Send reply to a secure message

NOTE: If including file attachments, this request must be sent as multipart/form-data

File attachment restrictions (as imposed by MHV):

  • User may attach up to 4 files
  • Accepted formats: doc, docx, jpg, pdf, png, rtf, txt, xls, xlsx
  • Single attachment cannot exceed 3 MB
  • Total attachment cannot exceed 6 MB
Authorizations:
Bearer
path Parameters
id
required
integer

ID of the message that is being replied to

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema:

Reply message body

recipient_id
required
integer
category
required
string
subject
required
string <= 50 characters
body
required
string
draft_id
integer

Specifies draft message ID to send. Draft message is deleted once sent. Note that body included with this post will overwrite any of original values of the draft.

Responses

Request samples

Content type
{
  • "recipient_id": 1112233,
  • "category": "TEST",
  • "subject": "My Test Results",
  • "body": "Dear provider, please clarify my test results. Thank you.",
  • "draft_id": 0
}

Response samples

Content type
application/json
{
  • "type": "messages",
  • "id": "123789",
  • "attributes": {
    },
  • "relationships": {
    },
  • "links": {},
  • "included": []
}

/v0/messaging/health/messages/{id}/thread

Gets a list of message summaries that are related to the message of the passed id and older than the message of the id provided. Does not include the message of the passed id itself.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v1/messaging/health/messages/{id}/thread

Gets a list of message summaries that are related to the message of the passed id regardless of their age in relation to the message of the id provided. Unless specified in the query parameters, this does include the message of the passed id itself.

Authorizations:
Bearer
query Parameters
excludeProvidedMessage
boolean

Excludes the message with the provided message id

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v0/messaging/health/recipients

List available recipients to which messages may be sent

Authorizations:
Bearer
query Parameters
useCache
boolean
Example: useCache=true

Whether or not to use this API's cache or fetch records from the upstream service. Defaults to true.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v0/military-service-history

Returns user's service history

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/payment-history

Returns user's payment history

Authorizations:
Bearer
query Parameters
startDate
string <date-time>
Example: startDate=2020-10-29T07:00:00Z

The start date for the range of payments in ISO 8601 UTC format. Defaults to the beginning of the year of the most recent payment.

endDate
string <date-time>
Example: endDate=2021-11-29T08:00:00Z

The end date for the range of appointments in ISO 8601 UTC format. Defaults to the end of the year of the most recent payment.

page[number]
integer
Example: page[number]=1

The page number requested. Defaults to 1.

page[size]
integer
Example: page[size]=10

The number of records to return per page. Defaults to 10.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v0/payment-information/benefits

Returns direct deposit payment info

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "type": "paymentInformation",
  • "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
  • "attributes": {
    }
}

/v0/payment-information/benefits

Returns updated direct deposit payment info

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

New direct deposit info

accountNumber
required
string
accountType
required
string
Enum: "Savings" "Checking"
financialInstitutionName
required
string
financialInstitutionRoutingNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "accountNumber": "12345678901",
  • "accountType": "Savings",
  • "financialInstitutionName": "PACIFIC PREMIER BANK",
  • "financialInstitutionRoutingNumber": "021000021"
}

Response samples

Content type
application/json
{
  • "type": "paymentInformation",
  • "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
  • "attributes": {
    }
}

/v0/pensions

Get current pensions overview

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/push/prefs/{endpointSid}

Get the user's push notification preferences

Authorizations:
Bearer
path Parameters
endpointSid
required
string

device endpointSid provided by the register endpoint

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/push/prefs/{endpointSid}

Set the user's push notification preferences

Authorizations:
Bearer
path Parameters
endpointSid
required
string

device endpointSid provided by the register endpoint

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

Push notification preferences

preference
required
string
Enum: "appointment_reminders" "secure_message_alerts"
enabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "preference": "appointment_reminders",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/push/register

Allows a new app install to register to receive push notifications

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

Device information

deviceToken
required
string
osName
required
string
Enum: "ios" "android"
deviceName
string
appName
required
string
debug
boolean

Flag to switch between sandbox and non-sandbox app sid. Lower envs only

Responses

Request samples

Content type
application/json
{
  • "deviceToken": "740f4707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bb78ad",
  • "osName": "ios",
  • "deviceName": "Galaxy 8",
  • "appName": "va_mobile_app",
  • "debug": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/push/send

Allows client to trigger specified push notification to be sent to specified endpoint

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

Template id, endpoint sid, and personalization for template

appName
required
string
templateId
required
string
required
object
debug
boolean

Flag to switch between sandbox and non-sandbox app sid. Lower envs only

Responses

Request samples

Content type
application/json
{
  • "appName": "va_mobile_app",
  • "templateId": "0EF7C8C9390847D7B3B521426EFF5814",
  • "personalization": {
    },
  • "debug": true
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/translations/download

Downloads translations file.

query Parameters
current_version
string

When this endpoint responds with a 200, it includes a Content-Version header. The frontend is expected to store that value and include it as the current_version query param. When the current_version is omited or does not match the server's current version, the server responds with a 200 status, the newest version of the translations file, and the header including the newest version id. If the current_version matches the server's current version, the server responds with 204 and no content.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
"string"

/v0/user

Returns the user profile, including the user's addresses and the services the user has the requisite ids to access. Meta data for this endpoint returns all the services available in the API.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

/v0/user/authorized-services

Returns a hash of all available services, and a boolean value of whether the user has access to that service.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/contact-info

Returns the user contact info. If the user does not have a vet360 id, the contact info will be null.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v1/user

Returns the user profile, including the user's addresses and the services the user has the requisite ids to access. Meta data for this endpoint returns all the services available in the API. v1 includes LOGINGOV as login type.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

/v2/user

Returns basic user information

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/addresses

Deletes a user's address

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

A domestic, internation, or military address

id
required
integer
addressLine1
required
string
addressLine2
required
string or null
addressLine3
required
string or null
addressPou
required
string
Enum: "RESIDENCE/CHOICE" "CORRESPONDENCE"
addressType
required
string
Enum: "DOMESTIC" "INTERNATIONAL" "MILITARY"
city
required
string
countryCode
required
string
internationalPostalCode
required
string or null
province
required
string or null
stateCode
required
string
zipCode
required
string
zipCodeSuffix
required
string or null

Responses

Request samples

Content type
application/json
{
  • "id": 157032,
  • "addressLine1": "1493 Martin Luther King Rd",
  • "addressLine2": "string",
  • "addressLine3": "string",
  • "addressPou": "RESIDENCE/CHOICE",
  • "addressType": "DOMESTIC",
  • "city": "Fulton",
  • "countryCode": "US",
  • "internationalPostalCode": null,
  • "province": null,
  • "stateCode": "NY",
  • "zipCode": "97062",
  • "zipCodeSuffix": "1234"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/addresses

Creates a new residential or mailing address for a user. Calling this endpoint is the second step in adding a new address for a user. The first step is to call the address validation endpoint to check if an address is valid. If it is valid you'll receive a 'addressMetaData' object back with the addresses confidence score. This object should then be included along with the new address in the request body. If the user wishes to continue with an 'invalid' address then the 'validationKey' should be passed along with the new address in the request body. This lets the underlying service know that an invalid address be passed through.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

A domestic, internation, or military address

required
object
object
addressLine1
required
string
addressLine2
string or null
addressLine3
string or null
addressPou
required
string
Enum: "RESIDENCE/CHOICE" "CORRESPONDENCE"
addressType
required
string
Enum: "DOMESTIC" "INTERNATIONAL" "MILITARY"
city
required
string
countryCodeIso3
required
string
internationalPostalCode
string or null
province
string or null
stateCode
string or null
zipCode
string or null
zipCodeSuffix
string or null

Responses

Request samples

Content type
application/json
Example
{
  • "addressLine1": "1493 Martin Luther King Rd",
  • "addressPou": "RESIDENCE/CHOICE",
  • "addressType": "DOMESTIC",
  • "city": "Fulton",
  • "countryCodeIso3": "USA",
  • "countryName": "United States",
  • "stateCode": "MS",
  • "validationKey": -1206619807,
  • "zipCode": "38843"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/addresses

Updates a user's residential or mailing address. Calling this endpoint is the second step in adding a new address for a user. The first step is to call the address validation endpoint to check if an address is valid. If it is valid you'll receive a 'addressMetaData' object back with the addresses confidence score. This object should then be included along with the new address in the request body. If the user wishes to continue with an 'invalid' address then the 'validationKey' should be passed along with the new address in the request body. This lets the underlying service know that an invalid address be passed through.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

A domestic, internation, or military address

id
required
string
object
validationKey
integer
addressLine1
required
string
addressLine2
string or null
addressLine3
string or null
addressPou
required
string
Enum: "RESIDENCE/CHOICE" "CORRESPONDENCE"
addressType
required
string
Enum: "DOMESTIC" "INTERNATIONAL" "MILITARY"
city
required
string
countryCode
required
string
internationalPostalCode
string or null
province
string or null
stateCode
string
zipCode
string
zipCodeSuffix
string or null

Responses

Request samples

Content type
application/json
Example
{
  • "addressLine1": "1493 Martin Luther King Rd",
  • "addressPou": "RESIDENCE/CHOICE",
  • "addressType": "DOMESTIC",
  • "city": "Fulton",
  • "countryCodeIso3": "USA",
  • "countryName": "United States",
  • "id": 181513,
  • "stateCode": "MS",
  • "validationKey": -1206619807,
  • "zipCode": "38843"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/addresses/validate

Validates a residential or mailing address for a user. Calling this endpoint is the first step in adding a new address for a user. If the address is valid you'll receive a 'addressMetaData' object back with the addresses confidence score. This object should then be included along with the new address in the request body. If the user wishes to continue with an 'invalid' address then the 'validationKey' should be passed along with the new address in the request body. This lets the underlying service know that an invalid address be passed through.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

A domestic, internation, or military address

id
required
integer
addressLine1
required
string
addressLine2
required
string or null
addressLine3
required
string or null
addressPou
required
string
Enum: "RESIDENCE/CHOICE" "CORRESPONDENCE"
addressType
required
string
Enum: "DOMESTIC" "INTERNATIONAL" "MILITARY"
city
required
string
countryCode
required
string
internationalPostalCode
required
string or null
province
required
string or null
stateCode
required
string
zipCode
required
string
zipCodeSuffix
required
string or null

Responses

Request samples

Content type
application/json
{
  • "addressLine1": "51 W Weber Rd",
  • "addressPou": "CORRESPONDENCE",
  • "addressType": "DOMESTIC",
  • "city": "Columbus",
  • "countryCodeIso3": "USA",
  • "countryName": "United States",
  • "stateCode": "OH",
  • "type": "DOMESTIC",
  • "zipCode": "43202"
}

Response samples

Content type
application/json
Example
{
  • "data": [
    ]
}

/v0/user/demographics

Returns the users demographics info

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/emails

Deletes a user's email address

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

The email address to delete

id
required
integer
emailAddress
required
string

Responses

Request samples

Content type
application/json
{
  • "emailAddress": "person42@example.com",
  • "id": "42,"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/emails

Creates a new email address

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

The new email address

emailAddress
required
string

Responses

Request samples

Content type
application/json
{
  • "emailAddress": "person42@example.com"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/emails

Updates a user's email address

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

The new email address

id
required
integer
emailAddress
required
string

Responses

Request samples

Content type
application/json
{
  • "emailAddress": "person42@example.com",
  • "id": "42,"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/gender_identity

Updates a user's gender identity. Only users with id.me or login.gov accounts may use this

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

The new gender identity key

code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "B"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/user/gender_identity/edit

Retrieves a list of valid gender identity keys. Note that this endpoint does not use the camel case key inflection header like most other mobile endpoints to keep the keys upcase.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/logout

Logs the user out by revoking their access token from the IAM SSOe OAuth service and destroying the IAM user, user identity, and session objects from Redis.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/user/logged-in

Called by the mobile app after successful login to perform any actions needed to start a session.

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/user/preferred_name

Updates a user's preferred name. Only users with id.me or login.gov accounts may use this

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

The new preferred name

text
required
string

Responses

Request samples

Content type
application/json
{
  • "text": "New Preferred Name"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

/v0/user/phones

Deletes one of a user's phone numbers

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

The phone number to delete

id
required
integer
areaCode
required
string
countryCode
required
string
phoneNumber
required
string
phoneType
required
string
Enum: "HOME" "FAX" "MOBILE" "WORK"
extension
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 157032,
  • "areaCode": "704",
  • "countryCode": "1",
  • "phoneNumber": "7749069",
  • "phoneType": "HOME",
  • "extension": "4567"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/phones

Creates a phone number for a user

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

The new phone number

id
integer
areaCode
required
string
countryCode
required
string
phoneNumber
required
string
phoneType
required
string
Enum: "HOME" "FAX" "MOBILE" "WORK"
extension
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 157032,
  • "areaCode": "704",
  • "countryCode": "1",
  • "phoneNumber": "7749069",
  • "phoneType": "HOME",
  • "extension": "4567"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v0/user/phones

Updates a user's phone number

Authorizations:
Bearer
header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Request Body schema: application/json

The new phone number

id
required
integer
areaCode
required
string
countryCode
required
string
phoneNumber
required
string
phoneType
required
string
Enum: "HOME" "FAX" "MOBILE" "WORK"
extension
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 157032,
  • "areaCode": "704",
  • "countryCode": "1",
  • "phoneNumber": "7749069",
  • "phoneType": "HOME",
  • "extension": "4567"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

/v1/health/immunizations

Returns a paginated list of immunization records for given user

Authorizations:
Bearer
query Parameters
page[number]
integer
Example: page[number]=1

The page number requested. Defaults to 1.

page[size]
integer
Example: page[size]=10

The number of records to return per page. Defaults to 10.

useCache
boolean
Example: useCache=true

Whether or not to use this API's cache or fetch records from the upstream service. Defaults to true.

header Parameters
X-Key-Inflection
string
Default: snake
Enum: "camel" "snake"

Allows the API to return camelCase keys rather than snake_case

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}