VA Mobile API (0.0.0)
Download OpenAPI specification:Download
The Department of Veterans Affairs mobile API. All paths are relative to https://api.va.gov/mobile.
/
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
- Payload
{- "environment": "dev",
- "buildNumber": "10",
- "os": "android"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "1.0",
- "type": "discovery",
- "attributes": {
- "endpoints": {
- "appointments": {
- "url": "/v0/appointments",
- "method": "GET"
}, - "uploadClaimDocuments": {
- "url": "/claim/:id/documents",
- "method": "POST"
}, - "createUserPhone": {
- "url": "/user/phones",
- "method": "POST"
}, - "updateUserPhone": {
- "url": "/user/phones",
- "method": "PUT"
}
}, - "webviews": {
}, - "appAccess": true,
- "displayMessage": "Please update the app to continue"
}
}
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "appeal",
- "id": "3294289",
- "attributes": {
- "appealIds": [
- "3294289"
], - "active": true,
- "alerts": [
- {
- "type": "form9_needed",
- "details": "object"
}
], - "aod": null,
- "aoj": "vba",
- "description": "1 insurance issue",
- "docket": {
- "month": "2015-10-01",
- "docketMonth": "2014-11-01",
- "front": false,
- "total": 212814,
- "ahead": 81703,
- "ready": 17071,
- "eta": {
- "directReview": "2020-02-01",
- "evidenceSubmission": "2024-04-01",
- "hearingRequest": "2024-04-01"
}
}, - "events": [
- {
- "type": "sc_request",
- "date": "2023-02-02"
}
], - "evidence": null,
- "incompleteHistory": true,
- "issues": [
- {
- "active": true,
- "lastAction": null,
- "description": "Bronicial asthma",
- "diagnosticCode": "6602"
}
], - "location": "aoj",
- "programArea": "insurance",
- "status": {
- "details": "object",
- "type": "pending_certification_ssoc"
}, - "type": "legacyAppeal",
- "updated": "2018-01-19T10:20:42-05:00"
}
}
}
/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:
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 |
include[] | Array of strings Example: include[]=pending Field to include pending appointments. Currently only supports value |
included[] | Array of strings Example: included[]=pending Field to include pending appointments. Currently only supports value |
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
- 200
- 207
- 401
- 403
- 404
- 408
- 418
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "appointment",
- "id": "68254",
- "attributes": {
- "appointmentType": "COMMUNITY_CARE",
- "appointmentIen": null,
- "cancelId": null,
- "comment": "Please arrive 20 minutes before the start of your appointment",
- "healthcareProvider": "John Smith",
- "healthcareService": null,
- "location": {
- "name": "Kaiser Shoreline Treatment Center",
- "address": {
- "street": "191 Argonne Ave, Ste 3",
- "city": "Long Beach",
- "state": "CA",
- "zipCode": "90803"
}, - "lat": 33.7700504,
- "long": -118.1937395,
- "phone": {
- "areaCode": "562",
- "number": "434-6008",
- "extension": null
}, - "url": null,
- "code": null
}, - "physicalLocation": null,
- "minutesDuration": 60,
- "phoneOnly": false,
- "startDateLocal": "2019-04-20T14:15:00.000-04:00",
- "startDateUtc": "2019-04-20T18:15:00.000Z",
- "status": "CANCELLED",
- "statusDetail": null,
- "timeZone": "America/Los_Angeles",
- "vetextId": null,
- "reason": "Follow-up/Routine: Reason 1",
- "is_covid_vaccine": false,
- "is_pending": false,
- "proposed_times": null,
- "type_of_care": null,
- "patient_phone_number": null,
- "patient_email": null,
- "best_time_to_call": null,
- "friendly_location_name": null
}
}
], - "meta": {
- "upcomingAppointmentsCount": 1,
- "upcomingDaysLimit": 30
}
}
/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:
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
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/appointments/check-in
Check into an appointment.
Authorizations:
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
- Payload
{- "appointmentIEN": "string",
- "locationId": "string"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "check_in",
- "id": "75db6a5c-84ae-4ca4-bba2-ef4c41d563ab",
- "attributes": {
- "id": "75db6a5c-84ae-4ca4-bba2-ef4c41d563ab",
- "code": "check-in-success",
- "message": "Check-In successful"
}
}
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "checkInDemographics",
- "id": "75db6a5c-84ae-4ca4-bba2-ef4c41d563ab",
- "attributes": {
- "insuranceVerificationNeeded": true,
- "needsConfirmation": true,
- "mailingAddress": {
- "street1": "string",
- "street2": "string",
- "street3": "string",
- "city": "string",
- "county": "string",
- "state": "string",
- "zip": "string",
- "zip4": "string",
- "country": "string"
}, - "residentialAddress": {
- "street1": "string",
- "street2": "string",
- "street3": "string",
- "city": "string",
- "county": "string",
- "state": "string",
- "zip": "string",
- "zip4": "string",
- "country": "string"
}, - "homePhone": "string",
- "officePhone": "string",
- "cellPhone": "string",
- "email": "string",
- "emergencyContact": {
- "needsConfirmation": true,
- "name": "string",
- "relationship": "string",
- "phone": "string",
- "workPhone": "string",
- "address": {
- "street1": "string",
- "street2": "string",
- "street3": "string",
- "city": "string",
- "county": "string",
- "state": "string",
- "zip": "string",
- "zip4": "string",
- "country": "string"
}
}, - "nextOfKin": {
- "needsConfirmation": true,
- "name": "string",
- "relationship": "string",
- "phone": "string",
- "workPhone": "string",
- "address": {
- "street1": "string",
- "street2": "string",
- "street3": "string",
- "city": "string",
- "county": "string",
- "state": "string",
- "zip": "string",
- "zip4": "string",
- "country": "string"
}
}
}
}
}
/v0/appointments/check-in/demographics
Edit demographics confirmations.
Authorizations:
Request Body schema: application/json
location_id | string |
object |
Responses
Request samples
- Payload
{- "location_id": "string",
- "demographicConfirmations": {
- "contactNeedsUpdate": false,
- "emergencyContactNeedsUpdate": false,
- "nextOfKinNeedsUpdate": false
}
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "demographicConfirmations",
- "id": "5",
- "attributes": {
- "contactNeedsUpdate": false,
- "emergencyContactNeedsUpdate": false,
- "nextOfKinNeedsUpdate": false
}
}
}
/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:
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
- 200
- 400
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "community_care_eligibility",
- "id": "PrimaryCare",
- "attributes": {
- "eligible": true
}
}
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "facility_eligibility",
- "id": "100",
- "attributes": {
- "facilityId": "100",
- "eligible": false,
- "reason": "Non-primary facility with no visit within 12-24 months"
}
}
]
}
/v0/appointments/facilities/{facility_id}/clinics
Returns all available clinics at a facility for a given type of service.
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "facility_clinic",
- "id": "12345",
- "attributes": {
- "name": "C&P Optometry"
}
}
]
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "clinic_slot",
- "id": "3230323230383032313833303A323032323038303231393030",
- "attributes": {
- "start_date": "2022-08-05T12:00:00Z",
- "end_date": "2022-08-5T12:30:00Z",
- "locationId": "757GC",
- "practitionerName": "Doe, John D, MD",
- "clinicIen": "32216049"
}
}
]
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "clinic_slot",
- "id": "3230323230383032313833303A323032323038303231393030",
- "attributes": {
- "start_date": "2022-08-05T12:00:00Z",
- "end_date": "2022-08-5T12:30:00Z",
- "locationId": "757GC",
- "practitionerName": "Doe, John D, MD",
- "clinicIen": "32216049"
}
}
]
}
/v0/appointments/va/eligibility
Lists types of service. For each type of service, lists users registered facilities that support request and direct appointments.
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "va_eligibility",
- "id": "6260ab13-177f-583d-b2dc-1b350404abb7",
- "attributes": {
- "ccSupported": [
- "942"
], - "services": [
- {
- "name": "amputation",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "audiology",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "covid",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "optometry",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "outpatientMentalHealth",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "moveProgram",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "foodAndNutrition",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "clinicalPharmacyPrimaryCare",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "podiatry",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "primaryCare",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "homeSleepTesting",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "socialWork",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "cpap",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}, - {
- "name": "ophthalmology",
- "requestEligibleFacilities": [
- "942",
- "123"
], - "directEligibleFacilities": [
- "945",
- "342"
]
}
]
}
}
}
/v0/appointment
Creates a new appointment or appointment request.
Authorizations:
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
kind required | string (AppointmentKind) Enum: "clinic" "cc" "telehealth" "phone" The kind of 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
- Payload
{- "kind": "clinic",
- "status": "proposed",
- "serviceType": "optometry",
- "practitioners": [
- {
- "address": {
- "type": "postal",
- "line": [
- "38143 Martha Ave"
], - "city": "Fremont",
- "state": "CA",
- "postal_code": 94536,
- "country": "USA",
- "text": "test"
}
}
], - "locationId": "983GC",
- "requestedPeriods": [
- {
- "start": "2022-03-17T00:00:00Z",
- "end": "2022-03-17T11:59:00Z"
}
], - "contact": {
- "telecom": [
- {
- "type": "phone",
- "value": "7036753607"
}
]
}, - "preferredTimesForPhoneCall": [
- "Morning"
], - "preferredLocation": {
- "city": "Helena",
- "state": "MT"
}, - "comment": "free form comment here",
- "preferredLanguage": "English"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "string",
- "type": "string",
- "attributes": {
- "id": "string",
- "identifier": [
- {
- "system": "string",
- "value": "string"
}
], - "kind": "clinic",
- "status": "proposed",
- "serviceType": "string",
- "reasonCode": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
], - "text": "string"
}, - "priority": 0,
- "patientIcn": "string",
- "locationId": "string",
- "clinic": "string",
- "clinicName": "string",
- "practitioners": [
- {
- "address": {
- "type": "postal",
- "line": [
- "38143 Martha Ave"
], - "city": "Fremont",
- "state": "CA",
- "postal_code": 94536,
- "country": "USA",
- "text": "test"
}
}
], - "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "minutesDuration": 0,
- "slot": {
- "id": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}, - "created": "2019-08-24T14:15:22Z",
- "preferredLocation": {
- "city": "Helena",
- "state": "MT"
}, - "requestedPeriods": [
- {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}
], - "contact": {
- "telecom": [
- {
- "type": "phone",
- "value": "7036753607"
}
]
}, - "preferredTimesForPhoneCall": [
- "Morning"
], - "cancelationReason": {
- "coding": [
- {
- "system": "string",
- "code": "string",
- "display": "string"
}
], - "text": "string"
}, - "description": "string",
- "comment": "string",
- "preferredLanguage": "string",
- "cancellable": true,
- "patientInstruction": "string",
- "telehealth": {
- "url": "string",
- "atlas": {
- "siteCode": "string",
- "confirmationCode": "string",
- "address": {
- "streetAddress": "string",
- "city": "string",
- "state": "string",
- "zipCode": "string",
- "country": "string",
- "latitutde": 0,
- "longitude": 0,
- "additionalDetails": "string"
}
}
}, - "extension": {
- "desiredDate": "2019-08-24T14:15:22Z",
- "ccLocation": {
- "practiceName": "string",
- "address": {
- "type": "postal",
- "line": [
- "string"
], - "city": "string",
- "state": "string",
- "postalCode": "string",
- "country": "string",
- "text": "string"
}
}, - "ccRequestedCancellation": true
}
}
}
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "awards",
- "id": "f26bc1f0-c389-4f3c-86e0-7712fb08fbe6",
- "attributes": {
- "id": "f26bc1f0-c389-4f3c-86e0-7712fb08fbe6",
- "aportnRecipId": "2810777",
- "awardAmt": 541.83,
- "awardCmpsitId": "10976",
- "awardCurntStatusCd": "A",
- "awardEventId": "13724",
- "awardLineReportId": "37898",
- "awardLineTypeCd": "C",
- "awardStnNbr": "317",
- "awardTypeCd": "CPL",
- "combndDegreePct": "30",
- "depHlplsThisNbr": "0",
- "depHlplsTotalNbr": "0",
- "depSchoolThisNbr": "0",
- "depSchoolTotalNbr": "0",
- "depThisNbr": "12",
- "depTotalNbr": "12",
- "efctvDt": "2020-08-01T00:00:00.000-05:00",
- "entlmtTypeCd": "41",
- "fileNbr": "796121200",
- "futureEfctvDt": "2021-07-15T00:00:00.000-05:00",
- "grossAdjsmtAmt": 0,
- "grossAmt": 541.83,
- "ivapAmt": 0,
- "jrnDt": "2020-08-03T18:15:02.000-05:00",
- "jrnLctnId": "281",
- "jrnObjId": "AWARD COMPOSITE",
- "jrnStatusTypeCd": "I",
- "jrnUserId": "BATCH",
- "netAmt": 541.83,
- "payeeTypeCd": "00",
- "priorEfctvDt": "2020-07-01T00:00:00.000",
- "ptcpntBeneId": "2810777",
- "ptcpntVetId": "2810777",
- "reasonOneTxt": "21",
- "spouseTxt": "Spouse"
}
}
}
/v0/claim/{id}
Returns info on all user's claims and appeals for mobile overview page
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "claim",
- "id": "600117255",
- "attributes": {
- "dateFiled": "2017-12-08",
- "minEstDate": "2017-12-08",
- "maxEstDate": "2017-12-08",
- "open": true,
- "waiverSubmitted": true,
- "requestedDecision": true,
- "contentionList": [
- "Abdominal pain, etiology unknown (New)"
], - "eventsTimeline": [
- {
- "type": "received_from_you_list",
- "tracked_item_id": 360052,
- "description": "The information provided concerning your prior marital history is inconsistent. In order to resolve these inconsistencies you should submit certified copies of the public record of the termination (death, divorce or annulment) for each of your prior marriages.",
- "display_name": "Claimant marital history inconsistent - need proof",
- "overdue": true,
- "status": "NEEDED",
- "uploaded": true,
- "uploads_allowed": true,
- "opened_date": "2022-09-30",
- "requested_date": "2022-09-30",
- "received_date": "2023-10-30",
- "closed_date": "2023-11-30",
- "suspense_date": "2023-05-30",
- "documents": [
- {
- "tracked_item_id": 360052,
- "file_type": "Civilian Police Reports",
- "document_type": null,
- "filename": "7B434B58-477C-4379-816F-05E6D3A10487.pdf",
- "upload_date": "2023-03-01",
- "document_id": "{6A6DFA79-4EC9-4E58-9653-25BDCFB06A03}"
}
], - "upload_date": "2023-05-30",
- "date": "2023-05-30",
- "file_type": "Civilian Police Reports",
- "document_type": null,
- "filename": "7B434B58-477C-4379-816F-05E6D3A10487.pdf",
- "document_id": "{6A6DFA79-4EC9-4E58-9653-25BDCFB06A03}"
}
], - "phaseChangeDate": "2017-12-08",
- "vaRepresentative": "DALE M BOETTCHER",
- "documentsNeeded": true,
- "developmentLetterSent": true,
- "decisionLetterSent": true,
- "updatedAt": "2017-12-13T03:28:23+00:00",
- "phase": 2,
- "claimType": "Compensation",
- "everPhaseBack": true,
- "currentPhaseBack": true,
- "claimTypeCode": "020NEW"
}
}
}
/v0/claim/{id}/documents
Post tracked item document for upload, returns jobId for upload process
Authorizations:
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
- 202
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "jobId": "success"
}
}
/v0/claim/{id}/documents/multi-image
Post multiple images to be combined into one pdf for upload, returns jobId for upload process
Authorizations:
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
- Payload
{- "files": [
- "string"
], - "trackedItemId": "string",
- "documentType": "L827"
}
Response samples
- 202
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "jobId": "success"
}
}
/v0/claim/{id}/request-decision
Request decision on a given claim, returns job id
Authorizations:
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
- 202
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "jobId": "success"
}
}
/v0/claims/decision-letters
Returns the list of claim decision letters for given user
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "{87B6DE5D-CD79-4D15-B6DC-A5F9A324DC3E}",
- "type": "decisionLetter",
- "attributes": {
- "seriesId": "{EC1B5F0C-E3FB-4A41-B93F-E1A88D549CDF}",
- "version": "1",
- "typeDescription": "Notification Letter (e.g. VA 20-8993, VA 21-0290, PCGL)",
- "typeId": "184",
- "docType": "184",
- "subject": null,
- "receivedAt": "2022-09-22",
- "source": "VBMS",
- "mimeType": "application/pdf",
- "altDocTypes": "",
- "restricted": false,
- "uploadDate": "2022-09-23"
}
}
]
}
/v0/claims/decision-letters/{document_id}/download
Downloads a decision letter
Authorizations:
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
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/claims/pre-need-burial
Submits a new Preneeds Burial application.
Authorizations:
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
- Payload
{- "application": {
- "applicant": {
- "applicantEmail": "user@example.com",
- "applicantPhoneNumber": "stringstri",
- "applicantRelationshipToClaimant": "Self",
- "completingReason": "string",
- "mailingAddress": {
- "street": "string",
- "street2": "string",
- "city": "string",
- "country": "CAN",
- "state": "AB",
- "postalCode": "string"
}, - "name": {
- "first": "string",
- "middle": "string",
- "last": "string",
- "suffix": "Jr."
}
}, - "claimant": {
- "address": {
- "street": "string",
- "street2": "string",
- "city": "string",
- "country": "CAN",
- "state": "AB",
- "postalCode": "string"
}, - "dateOfBirth": "2019-08-24",
- "desiredCemetery": "string",
- "email": "user@example.com",
- "name": {
- "first": "string",
- "middle": "string",
- "last": "string",
- "suffix": "Jr.",
- "maiden": "string"
}, - "phoneNumber": "stringstri",
- "relationshipToVet": "1",
- "ssn": "string"
}, - "veteran": {
- "address": {
- "street": "string",
- "street2": "string",
- "city": "string",
- "country": "CAN",
- "state": "AB",
- "postalCode": "string"
}, - "currentName": {
- "first": "string",
- "middle": "string",
- "last": "string",
- "suffix": "Jr.",
- "maiden": "string"
}, - "dateOfBirth": "2019-08-24",
- "dateOfDeath": "2019-08-24",
- "gender": "Female",
- "race": {
- "isAmericanIndianOrAlaskanNative": true,
- "isAsian": true,
- "isBlackOrAfricanAmerican": true,
- "isSpanishHispanicLatino": true,
- "notSpanishHispanicLatino": true,
- "isNativeHawaiianOrOtherPacificIslander": true,
- "isWhite": true
}, - "isDeceased": "yes",
- "maritalStatus": "Single",
- "militaryServiceNumber": "string",
- "militaryStatus": "A",
- "placeOfBirth": "string",
- "serviceName": {
- "first": "string",
- "middle": "string",
- "last": "string",
- "suffix": "Jr."
}, - "serviceRecords": [
- {
- "dateRange": {
- "from": "2019-08-24",
- "to": "2019-08-24"
}, - "serviceBranch": "AL",
- "dischargeType": "1",
- "highestRank": "string",
- "nationalGuardState": "AL"
}
], - "ssn": "string",
- "vaClaimNumber": "string"
}, - "hasCurrentlyBuried": "1",
- "currentlyBuriedPersons": [
- {
- "name": {
- "first": "string",
- "middle": "string",
- "last": "string",
- "suffix": "Jr."
}, - "cemeteryNumber": "string"
}
], - "preneedAttachments": [
- {
- "name": "string",
- "size": 0,
- "confirmationCode": "string",
- "attachmentId": "1"
}
]
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "9E68GA6Q3NBTx8mxT3VG",
- "type": "preneeds_receive_applications",
- "attributes": {
- "receiveApplicationId": "9E68GA6Q3NBTx8mxT3VG",
- "trackingNumber": "9E68GA6Q3NBTx8mxT3VG",
- "returnCode": 0,
- "applicationUuid": "29d0af3b-4929-418a-89c8-fa1d696a3886",
- "returnDescription": "PreNeed Application Received Successfully.",
- "submittedAt": "2023-11-09T17:43:19.534Z"
}
}
]
}
/v0/claims/pre-need-burial/cemeteries
Returns info on all cemeteries for preneed burial
Authorizations:
Responses
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "915",
- "type": "cemetery",
- "attributes": {
- "name": "ABRAHAM LINCOLN NATIONAL CEMETERY",
- "type": "N"
}
}
]
}
/v0/claims-and-appeals-overview
Returns info on all user's claims and appeals for mobile overview page
Authorizations:
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
- 200
- 207
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "appeal",
- "id": "1196201",
- "attributes": {
- "subtype": "legacyAppeal",
- "completed": true,
- "dateFiled": "2003-01-06",
- "updatedAt": "2003-09-30",
- "displayTitle": "disability compensation appeal",
- "decisionLetterSent": false,
- "phase": null,
- "documentsNeeded": null,
- "developmentLetterSent": null,
- "claimTypeCode": null
}
}
], - "meta": {
- "errors": [ ],
- "pagination": {
- "currentPage": 1,
- "perPage": 60,
- "totalPages": 1,
- "totalEntries": 11
}, - "activeClaimsCount": 7
}
}
/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:
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
- 200
- 400
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "community_care_provider",
- "id": "23fe358d-6e82-4541-804c-ce7562ba28f4",
- "attributes": {
- "name": "Dr. Smith",
- "address": {
- "street": "2360 East Pershing Boulevard",
- "city": "Columbus",
- "state": "OH",
- "zipCode": "82001-5356"
}, - "distance": 1.234
}
}
]
}
/v0/debts
Returns a list of user's debts.
Authorizations:
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
- 200
- 400
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "fe1776a8-3908-4efe-8e20-8dd31440ccb9",
- "type": "debts",
- "attributes": {
- "fileNumber": "796043735",
- "payeeNumber": "00",
- "personEntitled": null,
- "deductionCode": "30",
- "benefitType": "Comp & Pen",
- "diaryCode": "914",
- "diaryCodeDescription": "Paid In Full",
- "amountOverpaid": 123.34,
- "amountWithheld": 50,
- "originalAr": 1177,
- "currentAr": 123.34,
- "debtHistory": [
- {
- "date": "09/12/1998",
- "letterCode": "123",
- "description": "Third Demand Letter - Potential Treasury Referral"
}
]
}
}
], - "meta": {
- "hasDependentDebts": false
}
}
/v0/debts/{id}
Returns a users debt by id.
Authorizations:
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
- 200
- 400
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "fe1776a8-3908-4efe-8e20-8dd31440ccb9",
- "type": "debts",
- "attributes": {
- "fileNumber": "796043735",
- "payeeNumber": "00",
- "personEntitled": null,
- "deductionCode": "30",
- "benefitType": "Comp & Pen",
- "diaryCode": "914",
- "diaryCodeDescription": "Paid In Full",
- "amountOverpaid": 123.34,
- "amountWithheld": 50,
- "originalAr": 1177,
- "currentAr": 123.34,
- "debtHistory": [
- {
- "date": "09/12/1998",
- "letterCode": "123",
- "description": "Third Demand Letter - Potential Treasury Referral"
}
]
}
}, - "meta": {
- "hasDependentDebts": false
}
}
/v0/dependents
Returns a list of user's dependents. Dependent SSN is also available but is removed to limit PII exposure.
Authorizations:
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
- 200
- 400
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "dependent",
- "id": "23fe358d-6e82-4541-804c-ce7562ba28f4",
- "attributes": {
- "awardIndicator": "N",
- "dateOfBirth": "01/02/1960",
- "emailAddress": "emailAddress",
- "firstName": "JANE",
- "lastName": "WEBB",
- "middleName": "M",
- "proofOfDependency": "N",
- "ptcpntId": "600280661",
- "relatedToVet": "Y",
- "relationship": "Spouse",
- "veteranIndicator": "N"
}
}
]
}
/v0/dependents
Submit a supplemental claim for compensation (21-686C & 21-674).
Authorizations:
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
- Payload
{- "optionSelection": { },
- "veteranInformation": {
- "veteranInformation": { },
- "veteranAddress": {
- "veteranAddress": {
- "view:editMailingAddressSubheader": { },
- "view:livesOnMilitaryBase": true,
- "view:livesOnMilitaryBaseInfo": { },
- "countryName": "USA",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "string",
- "stateCode": "AL",
- "province": "string",
- "zipCode": "string",
- "internationalPostalCode": "string"
}, - "phoneNumber": "stringstri",
- "emailAddress": "user@example.com"
}
}, - "addChild": {
- "addChildInformation": {
- "childrenToAdd": [
- {
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "ssn": "string",
- "birthDate": "string"
}
]
}, - "addChildPlaceOfBirth": {
- "childrenToAdd": [
- {
- "placeOfBirth": {
- "isOutsideUs": false,
- "country": "AFG",
- "state": "AL",
- "city": "string"
}, - "childStatus": {
- "biological": true,
- "adopted": true,
- "stepchild": true,
- "biologicalStepchild": true,
- "dateBecameDependent": "string",
- "stepchildParent": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "ssn": "string",
- "birthDate": "string"
}, - "view:childStatusInformation": { },
- "notSelfSufficient": true,
- "view:notSelfSufficientDescription": { },
- "previouslyMarried": "Yes",
- "previousMarriageDetails": {
- "dateMarriageEnded": "string",
- "reasonMarriageEnded": "Divorce",
- "otherReasonMarriageEnded": "string"
}, - "childIncome": true
}
]
}, - "addChildAdditionalInformation": {
- "childrenToAdd": [
- {
- "doesChildLiveWithYou": true,
- "childAddressInfo": {
- "personChildLivesWith": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "address": {
- "view:editMailingAddressSubheader": { },
- "view:livesOnMilitaryBase": true,
- "view:livesOnMilitaryBaseInfo": { },
- "countryName": "USA",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "string",
- "stateCode": "AL",
- "province": "string",
- "zipCode": "string",
- "internationalPostalCode": "string"
}
}
}
]
}, - "childAdditionalEvidence": {
- "view:additionalEvidenceDescription": { },
- "childEvidenceDocumentType": "13",
- "childSupportingDocuments": [
- {
- "name": "string",
- "size": 0,
- "confirmationCode": "string"
}
]
}
}, - "addSpouse": {
- "spouseNameInformation": {
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "ssn": "string",
- "birthDate": "string",
- "isVeteran": true,
- "vaFileNumber": "string",
- "serviceNumber": "string"
}, - "currentMarriageInformation": {
- "date": "string",
- "location": {
- "isOutsideUs": false,
- "country": "AFG",
- "state": "AL",
- "city": "string"
}, - "type": "CEREMONIAL",
- "typeOther": "string",
- "view:marriageTypeInformation": { }
}, - "doesLiveWithSpouse": {
- "spouseDoesLiveWithVeteran": true,
- "currentSpouseReasonForSeparation": "Death",
- "address": {
- "view:editMailingAddressSubheader": { },
- "view:livesOnMilitaryBase": true,
- "view:livesOnMilitaryBaseInfo": { },
- "countryName": "USA",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "string",
- "stateCode": "AL",
- "province": "string",
- "zipCode": "string",
- "internationalPostalCode": "string"
}, - "spouseIncome": true
}, - "spouseMarriageHistory": {
- "spouseWasMarriedBefore": true,
- "spouseMarriageHistory": [
- {
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}
}
]
}, - "spouseMarriageHistoryDetails": {
- "spouseMarriageHistory": [
- {
- "startDate": "string",
- "startLocation": {
- "isOutsideUs": false,
- "country": "AFG",
- "state": "AL",
- "city": "string"
}, - "reasonMarriageEnded": "Divorce",
- "reasonMarriageEndedOther": "string",
- "endDate": "string",
- "endLocation": {
- "isOutsideUs": false,
- "country": "AFG",
- "state": "AL",
- "city": "string"
}
}
]
}, - "veteranMarriageHistory": {
- "veteranWasMarriedBefore": true,
- "veteranMarriageHistory": [
- {
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}
}
]
}, - "veteranMarriageHistoryDetails": {
- "veteranMarriageHistory": [
- {
- "startDate": "string",
- "startLocation": {
- "isOutsideUs": false,
- "country": "AFG",
- "state": "AL",
- "city": "string"
}, - "reasonMarriageEnded": "Divorce",
- "reasonMarriageEndedOther": "string",
- "endDate": "string",
- "endLocation": {
- "isOutsideUs": false,
- "country": "AFG",
- "state": "AL",
- "city": "string"
}
}
]
}, - "marriageAdditionalEvidence": {
- "view:additionalEvidenceDescription": { },
- "spouseEvidenceDocumentType": "14",
- "spouseSupportingDocuments": [
- {
- "name": "string",
- "size": 0,
- "confirmationCode": "string"
}
]
}
}, - "reportDivorce": {
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "ssn": "string",
- "birthDate": "string",
- "date": "string",
- "location": {
- "isOutsideUs": false,
- "country": "AFG",
- "state": "AL",
- "city": "string"
}, - "reasonMarriageEnded": "Divorce",
- "explanationOfOther": "string",
- "spouseIncome": true
}, - "deceasedDependents": {
- "dependentInformation": {
- "deaths": [
- {
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "ssn": "string",
- "birthDate": "string",
- "dependentType": "SPOUSE",
- "childStatus": {
- "childUnder18": true,
- "stepChild": true,
- "adopted": true,
- "disabled": true,
- "childOver18InSchool": true
}
}
]
}, - "dependentAdditionalInformation": {
- "deaths": [
- {
- "date": "string",
- "location": {
- "isOutsideUs": false,
- "country": "AFG",
- "state": "AL",
- "city": "string"
}, - "dependentIncome": true
}
]
}
}, - "reportChildMarriage": {
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "ssn": "string",
- "birthDate": "string",
- "dateMarried": "string",
- "dependentIncome": true
}, - "reportChildStoppedAttendingSchool": {
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "ssn": "string",
- "birthDate": "string",
- "dateChildLeftSchool": "string",
- "dependentIncome": true
}, - "reportStepchildNotInHousehold": {
- "stepchildren": {
- "stepChildren": [
- {
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "ssn": "string",
- "birthDate": "string"
}
]
}, - "stepchildInformation": {
- "stepChildren": [
- {
- "supportingStepchild": true,
- "livingExpensesPaid": "More than half",
- "whoDoesTheStepchildLiveWith": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "address": {
- "view:editMailingAddressSubheader": { },
- "view:livesOnMilitaryBase": true,
- "view:livesOnMilitaryBaseInfo": { },
- "countryName": "USA",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "string",
- "stateCode": "AL",
- "province": "string",
- "zipCode": "string",
- "internationalPostalCode": "string"
}
}
]
}
}, - "report674": {
- "studentNameAndSsn": {
- "view:674Information": { },
- "fullName": {
- "first": "string",
- "middle": "string",
- "last": "string"
}, - "ssn": "string",
- "birthDate": "string",
- "isParent": true,
- "dependentIncome": true
}, - "studentAddressMarriageTuition": {
- "address": {
- "view:editMailingAddressSubheader": { },
- "view:livesOnMilitaryBase": true,
- "view:livesOnMilitaryBaseInfo": { },
- "countryName": "USA",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "string",
- "stateCode": "AL",
- "province": "string",
- "zipCode": "string",
- "internationalPostalCode": "string"
}, - "wasMarried": true,
- "marriageDate": "string",
- "tuitionIsPaidByGovAgency": true,
- "agencyName": "string",
- "datePaymentsBegan": "string"
}, - "studentSchoolAddress": {
- "schoolInformation": {
- "name": "string",
- "schoolType": "HighSch",
- "trainingProgram": "string",
- "address": {
- "view:editMailingAddressSubheader": { },
- "view:livesOnMilitaryBase": true,
- "view:livesOnMilitaryBaseInfo": { },
- "countryName": "USA",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "string",
- "stateCode": "AL",
- "province": "string",
- "zipCode": "string",
- "internationalPostalCode": "string"
}
}
}, - "studentTermDates": {
- "currentTermDates": {
- "officialSchoolStartDate": "string",
- "expectedStudentStartDate": "string",
- "expectedGraduationDate": "string"
}, - "programInformation": {
- "studentIsEnrolledFullTime": true,
- "courseOfStudy": "string",
- "classesPerWeek": 0,
- "hoursPerWeek": 0
}
}, - "studentLastTerm": {
- "studentDidAttendSchoolLastTerm": true,
- "lastTermSchoolInformation": {
- "name": "string",
- "address": {
- "view:editMailingAddressSubheader": { },
- "view:livesOnMilitaryBase": true,
- "view:livesOnMilitaryBaseInfo": { },
- "countryName": "USA",
- "addressLine1": "string",
- "addressLine2": "string",
- "addressLine3": "string",
- "city": "string",
- "stateCode": "AL",
- "province": "string",
- "zipCode": "string",
- "internationalPostalCode": "string"
}, - "termBegin": "string",
- "dateTermEnded": "string",
- "classesPerWeek": 0,
- "hoursPerWeek": 0
}
}, - "studentIncomeInformation": {
- "studentDoesEarnIncome": true,
- "studentEarningsFromSchoolYear": {
- "earningsFromAllEmployment": "string",
- "annualSocialSecurityPayments": "string",
- "otherAnnuitiesIncome": "string",
- "allOtherIncome": "string"
}, - "studentWillEarnIncomeNextYear": true,
- "studentExpectedEarningsNextYear": {
- "earningsFromAllEmployment": "string",
- "annualSocialSecurityPayments": "string",
- "otherAnnuitiesIncome": "string",
- "allOtherIncome": "string"
}
}, - "studentNetworthInformation": {
- "studentDoesHaveNetworth": true,
- "studentNetworthInformation": {
- "savings": "string",
- "securities": "string",
- "realEstate": "string",
- "otherAssets": "string",
- "remarks": "string"
}
}
}, - "householdIncome": {
- "householdIncome": true
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "bf01349c-585d-480f-8afc-7a2f88697a1a",
- "type": "dependents",
- "attributes": {
- "submitFormJobId": "908550d787e8dbfb0bf3df85"
}
}
}
/v0/dependents/request-decisions
Returns the list of dependents verifications and diaries
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "type": "dependency_request_decisions",
- "attributes": {
- "dependencyVerifications": [
- {
- "awardEffectiveDate": "2000-06-01T00:00:00.000-05:00",
- "awardEventId": "60300",
- "awardType": "CPL",
- "beginAwardEventId": "25326",
- "beneficiaryId": "13014883",
- "birthdayDate": "2000-05-05T00:00:00.000-05:00",
- "decisionDate": "2006-05-02T09:46:06.000-05:00",
- "decisionId": "24678",
- "dependencyDecisionId": "14599",
- "dependencyDecisionType": "DEPEST",
- "dependencyDecisionTypeDescription": "Dependency Established",
- "dependencyStatusType": "SP",
- "dependencyStatusTypeDescription": "Spouse",
- "eventDate": "2000-05-05T00:00:00.000-05:00",
- "firstName": "lauren",
- "fullName": "lauren jakes",
- "lastName": "jakes",
- "modifiedAction": "U",
- "modifiedBy": "IA",
- "modifiedDate": "2008-04-21T14:14:20.000-05:00",
- "modifiedLocation": "101",
- "modifiedProcess": "106072 Backfill",
- "personId": "13018361",
- "relationshipTypeDescription": "Spouse",
- "sortDate": "2006-05-02T09:46:06.000-05:00",
- "sortOrderNumber": "0",
- "veteranId": "13014883"
}
], - "diaries": [
- {
- "awardDiaryId": "3322",
- "awardType": "CPL",
- "beneficaryId": "13014883",
- "diaryDueDate": "2014-05-01T00:00:00.000-05:00",
- "diaryLcStatusType": "PEND",
- "diaryLcStatusTypeDescription": "Pending",
- "diaryReasonType": "24",
- "diaryReasonTypeDescription": "Issue Dependency Verification Form",
- "fileNumber": "546212222",
- "firstNm": "Ray",
- "lastName": "Jakes",
- "modifiedAction": "I",
- "modifiedBy": "CAPSBRAN",
- "modifiedDate": "2006-05-02T07:52:11.000-05:00",
- "modifiedLocation": "317",
- "modifiedProcess": "cp_diary_pkg.do_create",
- "ptcpntDiaryId": "13018359",
- "statusDate": "2006-05-02T07:52:11.000-05:00",
- "veteranId": "13014883"
}
], - "promptRenewal": false
}
}
}
/v0/disability-rating
Returns the list of disability ratings for given user
Authorizations:
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
- 200
- 400
- 401
- 403
- 404
- 405
- 408
- 413
- 429
- 500
- 502
- 503
- 504
{- "data": {
- "type": "disabilityRating",
- "id": "0",
- "attributes": {
- "combinedDisabilityRating": 100,
- "individualRatings": [
- {
- "decision": "Service Connected",
- "effectiveDate": "2005-01-01T00:00:00.000+00:00",
- "ratingPercentage": 10,
- "diagnosticText": "Hearing Loss"
}
]
}
}
}
/v0/efolder/documents
Returns the user's list of documents in efolder
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "{23fe358d-6e82-4541-804c-ce7562ba28f4}",
- "type": "efolder_document",
- "attributes": {
- "doc_type": 1215,
- "type_description": "DMC - Debt Increase Letter",
- "received_at": "2020-05-28"
}
}
]
}
/v0/efolder/documents/{documentId}/download
returns requested document
Authorizations:
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
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/enrollment-status
Returns the user's VA enrollment status.
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "enrollment_status",
- "id": "23fe358d-6e82-4541-804c-ce7562ba28f4",
- "attributes": {
- "status": "enrolled"
}
}
}
/v0/facilities-info
Retrieves facilities info for a user's va treatment facilities
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "facilitiesInfo",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "facilities": [
- {
- "id": "358",
- "name": "Cheyenne VA Medical Center",
- "city": "Cheyenne",
- "state": "WY",
- "cerner": true,
- "miles": "3.17"
}
]
}
}
}
/v0/facilities-info/{sort_method}
Retrieves facilities info for all facilities a given user has the ability to schedule appointments at
Authorizations:
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
- Payload
{- "lat": 34.5968,
- "long": 10.5796
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "facilitiesInfo",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "facilities": [
- {
- "id": "358",
- "name": "Cheyenne VA Medical Center",
- "city": "Cheyenne",
- "state": "WY",
- "cerner": true,
- "miles": "3.17"
}
]
}
}
}
/v0/financial-status-reports/download
Returns financial status report PDF
Authorizations:
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
- 400
- 401
- 403
- 404
- 408
- 413
- 422
- 429
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/health/immunizations
Returns the list of immunization records for given user
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "immunization",
- "id": "I2-3JYDMXC6RXTU4H25KRVXATSEJQ000000",
- "attributes": {
- "cvxCode": 140,
- "date": "2009-03-19T12:24:55Z",
- "doseNumber": "Booster",
- "doseSeries": 1,
- "groupName": "FLU",
- "manufacturer": "nil",
- "note": "Dose #45 of 101 of Influenza seasonal injectable preservative free vaccine administered.",
- "shortDescription": "Influenza seasonal injectable preservative free",
- "reaction": "Swelling"
}, - "relationships": {
- "location": {
- "data": {
- "id": "I2-4KG3N5YUSPTWD3DAFMLMRL5V5U000000",
- "type": "location"
}, - "links": {
- "related": "staging-api.va.gov/mobile/v0/health/locations/I2-2FPCKUIXVR7RJLLG34XVWGZERM000000"
}
}
}
}
]
}
/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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "allergy_intolerance",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "resourceType": "AllergyIntolerance",
- "type": "allergy",
- "clinicalStatus": {
}, - "code": {
}, - "notes": [
- {
- "authorReference": {
- "display": "DR. JANE460 DOE922 MD"
}, - "time": "1999-01-07T01:43:31Z",
- "text": "Latex allergy"
}
], - "recordedDate": "2019-04-20T14:15:00.000-04:00",
- "patient": {
- "display": "Ms. Carlita746 Kautzer186"
}, - "recorder": {
- "display": "DR. THOMAS359 REYNOLDS206 PHD"
}, - "reactions": [
- {
- "substance": {
}, - "manifestation": [
- {
- "coding": [
- {
- "system": "urn:oid:2.16.840.1.113883.6.233",
- "code": "43000006",
- "display": "Itchy Watery Eyes"
}
]
}
], - "text": "Itchy Watery Eyes"
}
]
}
}
]
}
/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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "letter",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "category": "Laboratory",
- "subject": {
- "display": "Mr. Shane235 Bartell116"
}, - "effectiveDateTime": "2019-04-20T14:15:00.000-04:00",
- "issued": "2019-04-20T14:15:00.000-04:00",
- "results": [
- {
- "display": "Glucose"
}
]
}
}
]
}
/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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "observation",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "status": "final",
- "category": {
- "coding": [
- {
- "code": "laboratory",
- "display": "Laboratory"
}
], - "text": "Laboratory"
}, - "code": {
- "text": "Glucose"
}, - "subject": {
- "display": "Mr. Shane235 Bartell116"
}, - "effectiveDateTime": "2019-04-20T14:15:00.000-04:00",
- "issued": "2019-04-20T14:15:00.000-04:00",
- "performer": {
- "display": "DR. THOMAS359 REYNOLDS206 PHD"
}, - "valueQuantity": {
- "value": 78.278855002875,
- "unit": "mg/dL",
- "code": "mg/dL"
}
}
}
]
}
/v0/health/locations/{id}
Returns location info based on location id from vaccine record
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "location",
- "id": "I2-3JYDMXC6RXTU4H25KRVXATSEJQ000000",
- "attributes": {
- "name": "COLUMBUS VAMC",
- "address": {
- "street": "2360 East Pershing Boulevard",
- "city": "Columbus",
- "state": "OH",
- "zipCode": "82001-5356"
}
}
}
}
/v0/health/rx/prescriptions
Returns the users prescriptions.
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 409
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "13650544",
- "type": "Prescription",
- "attributes": {
- "refillStatus": "refillinprocess",
- "refillSubmitDate": "2022-10-28T04:00:00.000Z",
- "refillDate": "2022-10-28T04:00:00.000Z",
- "refillRemaining": 5,
- "facilityName": "DAYT29",
- "isRefillable": false,
- "isTrackable": false,
- "orderedDate": "2022-10-28T04:00:00.000Z",
- "quantity": 10,
- "expirationDate": "2022-10-28T04:00:00.000Z",
- "prescriptionNumber": "2719536",
- "prescriptionName": "SOMATROPIN 5MG INJ (VI)",
- "instructions": "INJECT 1MG INTO THE MUSCLE WEEKLY FOR 30 DAYS",
- "dispensedDate": "2022-10-28T04:00:00.000Z",
- "stationNumber": "989",
- "facilityPhoneNumber": "(217) 636-6712"
}
}
], - "meta": {
- "prescriptionStatusCount": {
- "active": 1,
- "isRefillable": 1,
- "discontinued": 1,
- "expired": 2,
- "historical": 3,
- "pending": 1,
- "transferred": 2,
- "submitted": 1,
- "hold": 1,
- "unknown": 2,
- "total": 14
}
}
}
/v0/health/rx/prescriptions/refill
Requests refill for prescriptions.
Authorizations:
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
- Payload
{- "ids": [
- "7417954",
- "6970769",
- "8398465"
]
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 409
- 500
- 502
- 503
- 504
{- "id": "6260ab13-177f-583d-b2dc-1b350404abb7",
- "type": "PrescriptionRefills",
- "attributes": {
- "failedStationList": "DAYT29, DAYT29",
- "successfulStationList": "SLC4, VAMCSLC-OUTPTRX",
- "lastUpdatedTime": "Thu, 08 Dec 2022 12:11:33 EST",
- "prescriptionList": null,
- "failedPrescriptionIds": [
- "8398465",
- "8398466",
- "8398467"
], - "errors": [
- {
- "errorCode": 139,
- "developerMessage": "Prescription not refillable for id : 8398465",
- "message": "Prescription is not Refillable"
}
], - "infoMessages": [ ]
}
}
/v0/health/rx/prescriptions/{id}/tracking
Requests list of tracking data for a prescription id
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 409
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "657068347565",
- "type": "PrescriptionTracking",
- "attributes": {
- "prescriptionName": "Ibuprofen 200mg",
- "prescriptionNumber": "2719551",
- "prescriptionId": "13650541",
- "trackingNumber": "657068347565",
- "ndcNumber": "00781171601",
- "shippedDate": "2022-10-28T04:00:00.000Z",
- "deliveryService": "USPS",
- "otherPrescriptions": [
- {
- "prescriptionName": "ETHAMBUTOL HCL 100MG TAB",
- "prescriptionNumber": "2719553"
}
]
}
}
]
}
/v0/letters
Returns the list of letter names and types for the given user
Authorizations:
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
- 200
- 400
- 401
- 403
- 404
- 406
- 408
- 413
- 422
- 429
- 500
- 502
- 503
- 504
{- "data": {
- "type": "letters",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "letters": [
- {
- "name": "Commissary Letter",
- "letterType": "commissary"
}
]
}
}
}
/v0/letters/beneficiary
Returns benefit info and options for the given user with or without a dependent
Authorizations:
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
- 200
- 400
- 401
- 403
- 404
- 406
- 408
- 413
- 422
- 429
- 500
- 502
- 503
- 504
{- "data": {
- "type": "evssLettersBeneficiaryResponses",
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "attributes": {
- "benefitInformation": {
- "awardEffectiveDate": "2013-06-06T04:00:00.000+00:00",
- "hasChapter35Eligibility": true,
- "monthlyAwardAmount": 123,
- "serviceConnectedPercentage": 2,
- "hasDeathResultOfDisability": false,
- "hasSurvivorsIndemnityCompensationAward": true,
- "hasSurvivorsPensionAward": false,
- "hasAdaptedHousing": true,
- "hasIndividualUnemployabilityGranted": false,
- "hasNonServiceConnectedPension": true,
- "hasServiceConnectedDisabilities": false,
- "hasSpecialMonthlyCompensation": true
}, - "militaryService": [
- {
- "branch": "Army",
- "characterOfService": "HONORABLE",
- "enteredDate": "1973-01-01T05:00:00.000+00:00",
- "releasedDate": "1977-10-01T04:00:00.000+00:00"
}
]
}
}
}
/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:
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
- Payload
{- "militaryService": true,
- "serviceConnectedDisabilities": true,
- "serviceConnectedEvaluation": true,
- "nonServiceConnectedPension": true,
- "monthlyAward": true,
- "unemployable": true,
- "specialMonthlyCompensation": true,
- "adaptedHousing": true,
- "chapter35Eligibility": true,
- "deathResultOfDisability": true,
- "survivorsAward": true
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 408
- 413
- 422
- 429
- 500
- 502
- 503
- 504
/v0/maintenance_windows
List maintenance windows
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "23fe358d-6e82-4541-804c-ce7562ba28f4",
- "type": "maintenance_window",
- "attributes": {
- "service": "claims",
- "start_time": "2019-04-20T14:15:00.000-04:00",
- "end_time": "2019-04-20T18:15:00.000Z"
}
}
]
}
/v0/messaging/health/folders
List available secure messaging folders
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "0",
- "type": "folders",
- "attributes": {
- "folderId": 0,
- "name": "Inbox",
- "count": 15,
- "unreadCount": 2,
- "systemFolder": true
},
}
], - "meta": {
- "pagination": {
- "currentPage": 1,
- "perPage": 10,
- "totalPages": 2,
- "totalEntries": 15
}
}
}
/v0/messaging/health/folder
Create a new secure messaging folder
Authorizations:
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 | ||
|
Responses
Request samples
- Payload
{- "folder": {
- "name": "New Folder"
}
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "0",
- "type": "folders",
- "attributes": {
- "folderId": 0,
- "name": "Inbox",
- "count": 15,
- "unreadCount": 2,
- "systemFolder": true
},
}
]
}
/v0/messaging/health/folders/{id}
Get a secure messaging folder
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "id": "0",
- "type": "folders",
- "attributes": {
- "folderId": 0,
- "name": "Inbox",
- "count": 15,
- "unreadCount": 2,
- "systemFolder": true
},
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "messages",
- "id": "123789",
- "attributes": {
- "messageId": 123789,
- "category": "MEDICATIONS",
- "subject": "Medication Inquiry",
- "body": 2,
- "attachment": false,
- "sentDate": "2017-09-01T16:09:56.000Z",
- "senderId": 541200,
- "senderName": "DOE, JANE",
- "recipientId": 399955,
- "recipientName": "ROE, RICHARD",
- "readReceipt": "READ",
- "triageGroupName": "Triage_Group_5",
- "proxySenderName": "SMITH, JOHN"
},
}
], - "meta": {
- "sort": {
- "sentDate": "DESC"
}, - "pagination": {
- "currentPage": 1,
- "perPage": 10,
- "totalPages": 2,
- "totalEntries": 15
}, - "messageCounts": {
- "read": 5,
- "unread": 15
}
}
}
/v0/messaging/health/folders/{id}/threads
List of threads in a secure messaging folder
Authorizations:
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
- 200
- 400
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": 0,
- "type": "message_threads",
- "attributes": {
- "threadId": 1234567,
- "folderId": 0,
- "messageId": 1234567,
- "threadPageSize": 123,
- "messageCount": 123,
- "category": "MEDICATIONS",
- "subject": "Medication Inquiry",
- "triageGroupName": "Triage_Group_5",
- "sentDate": "2017-09-01T16:09:56.000Z",
- "draftDate": "2017-09-01T16:09:56.000Z",
- "senderId": 541200,
- "senderName": "DOE, JANE",
- "recipientId": 399955,
- "recipientName": "ROE, RICHARD",
- "proxySenderName": "SMITH, JOHN",
- "hasAttachment": false,
- "unsentDrafts": false,
- "unreadMessages": true
},
}
]
}
/v0/messaging/health/message_drafts
Save a new draft message
Authorizations:
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/recipientsendpoint. |
category required | string Message category. This must be one of the values returned by the /v0/messaging/health/messages/categoriesendpoint. |
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
- Payload
{- "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
- 201
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "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:
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
Responses
Request samples
- Payload
{- "body": "the updated message"
}
Response samples
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/messaging/health/message_drafts/{reply_id}/replydraft
Save a new draft message as a reply to an existing message
Authorizations:
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/recipientsendpoint. |
category required | string Message category. This must be one of the values returned by the /v0/messaging/health/messages/categoriesendpoint. |
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
- Payload
{- "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
- 201
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "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:
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
Responses
Request samples
- Payload
{- "body": "the updated message"
}
Response samples
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/messaging/health/messages
Send a new secure message
Authorizations:
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/recipientsendpoint. |
category required | string Message category. This must be one of the values returned by the /v0/messaging/health/messages/categoriesendpoint. |
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
- Payload
{- "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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "type": "messages",
- "id": "123789",
- "attributes": {
- "messageId": 123789,
- "category": "MEDICATIONS",
- "subject": "Medication Inquiry",
- "body": "Your prescription is ready for refill\r\nThanks,\r\n,Dr. Doe",
- "attachment": true,
- "sentDate": "2017-09-01T16:09:56.000Z",
- "senderId": 541200,
- "senderName": "DOE, JANE",
- "recipientId": 399955,
- "recipientName": "ROE, RICHARD",
- "readReceipt": "READ",
- "triageGroupName": "Triage_Group_5",
- "proxySenderName": "SMITH, JOHN"
}, - "relationships": {
- "attachments": {
- "data": [
- {
- "id": "7775443",
- "type": "attachments"
}
]
}
}, - "included": [
- {
- "id": 7775443,
- "type": "attachments",
- "attributes": {
- "name": "bb_report.pdf",
- "messageId": 123789,
- "attachmentSize": 225457
},
}
]
}
/v0/messaging/health/messages/categories
List available message categories
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": {
- "id": "0",
- "type": "categories",
- "attributes": {
- "messageCategoryType": [
- "OTHER",
- "COVID",
- "APPOINTMENTS",
- "MEDICATIONS",
- "TEST_RESULTS",
- "EDUCATION"
]
}
}
}
/v0/messaging/health/messages/signature
Gets user message signature preferences
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": {
- "type": "messageSignature",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "signatureName": "My Signature Name",
- "includeSignature": true,
- "signatureTitle": "My Signature Title"
}
}
}
/v0/messaging/health/messages/{id}
Moves a secure message to the "Deleted" folder
Authorizations:
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
- 400
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "code": "SM114",
- "detail": "Unable to move message",
- "status": "400",
- "title": "Operation failed"
}
]
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "type": "messages",
- "id": "123789",
- "attributes": {
- "messageId": 123789,
- "category": "MEDICATIONS",
- "subject": "Medication Inquiry",
- "body": "Your prescription is ready for refill\r\nThanks,\r\n,Dr. Doe",
- "attachment": true,
- "sentDate": "2017-09-01T16:09:56.000Z",
- "senderId": 541200,
- "senderName": "DOE, JANE",
- "recipientId": 399955,
- "recipientName": "ROE, RICHARD",
- "readReceipt": "READ",
- "triageGroupName": "Triage_Group_5",
- "proxySenderName": "SMITH, JOHN"
}, - "relationships": {
- "attachments": {
- "data": [
- {
- "id": "7775443",
- "type": "attachments"
}
]
}
}, - "included": [
- {
- "id": 7775443,
- "type": "attachments",
- "attributes": {
- "name": "bb_report.pdf",
- "messageId": 123789,
- "attachmentSize": 225457
},
}
], - "meta": {
- "userInTriageTeam?": true
}
}
/v0/messaging/health/messages/{id}/move
Moves a secure message to a specified folder
Authorizations:
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
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/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:
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
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/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:
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
- Payload
{- "recipient_id": 1112233,
- "category": "TEST",
- "subject": "My Test Results",
- "body": "Dear provider, please clarify my test results. Thank you.",
- "draft_id": 0
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "type": "messages",
- "id": "123789",
- "attributes": {
- "messageId": 123789,
- "category": "MEDICATIONS",
- "subject": "Medication Inquiry",
- "body": "Your prescription is ready for refill\r\nThanks,\r\n,Dr. Doe",
- "attachment": true,
- "sentDate": "2017-09-01T16:09:56.000Z",
- "senderId": 541200,
- "senderName": "DOE, JANE",
- "recipientId": 399955,
- "recipientName": "ROE, RICHARD",
- "readReceipt": "READ",
- "triageGroupName": "Triage_Group_5",
- "proxySenderName": "SMITH, JOHN"
}, - "relationships": {
- "attachments": {
- "data": [
- {
- "id": "7775443",
- "type": "attachments"
}
]
}
}, - "included": [
- {
- "id": 7775443,
- "type": "attachments",
- "attributes": {
- "name": "bb_report.pdf",
- "messageId": 123789,
- "attachmentSize": 225457
},
}
]
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "messages",
- "id": "123789",
- "attributes": {
- "messageId": 123789,
- "category": "MEDICATIONS",
- "subject": "Medication Inquiry",
- "body": 2,
- "attachment": false,
- "sentDate": "2017-09-01T16:09:56.000Z",
- "senderId": 541200,
- "senderName": "DOE, JANE",
- "recipientId": 399955,
- "recipientName": "ROE, RICHARD",
- "readReceipt": "READ",
- "triageGroupName": "Triage_Group_5",
- "proxySenderName": "SMITH, JOHN"
},
}
], - "meta": {
- "sort": {
- "sentDate": "DESC"
}, - "pagination": {
- "currentPage": 1,
- "perPage": 10,
- "totalPages": 2,
- "totalEntries": 15
}, - "messageCounts": {
- "read": 5,
- "unread": 15
}
}
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "messages",
- "id": "123789",
- "attributes": {
- "messageId": 123789,
- "category": "MEDICATIONS",
- "subject": "Medication Inquiry",
- "body": 2,
- "attachment": false,
- "sentDate": "2017-09-01T16:09:56.000Z",
- "senderId": 541200,
- "senderName": "DOE, JANE",
- "recipientId": 399955,
- "recipientName": "ROE, RICHARD",
- "readReceipt": "READ",
- "triageGroupName": "Triage_Group_5",
- "proxySenderName": "SMITH, JOHN",
- "messageBody": 2,
- "threadId": 1234567,
- "folderId": 0,
- "draftDate": "2017-09-01T16:09:56.000Z",
- "toDate": "2017-09-01T16:09:56.000Z",
- "hasAttachment": false
},
}
], - "meta": {
- "sort": {
- "sentDate": "DESC"
}, - "pagination": {
- "currentPage": 1,
- "perPage": 10,
- "totalPages": 2,
- "totalEntries": 15
}, - "messageCounts": {
- "read": 5,
- "unread": 15
}
}
}
/v0/messaging/health/recipients
List available recipients to which messages may be sent
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": 855912,
- "type": "triage_teams",
- "attributes": {
- "triageTeamId": 855912,
- "name": "RADIOLOGY_TRIAGE_GROUP_1",
- "relationType": "PATIENT"
}
}
], - "meta": {
- "sort": {
- "name": "ASC"
}
}
}
/v0/military-service-history
Returns user's service history
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": {
- "type": "militaryInformation",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "serviceHistory": [
- {
- "branchOfService": "United States Army",
- "beginDate": "1997-09-17",
- "endDate": "2002-12-31",
- "formattedBeginDate": "September 17, 1997",
- "formattedEndDate": "December 31, 2002",
- "characterOfDischarge": "Honorable",
- "honorableServiceIndicator": "Y"
}
]
}
}
}
/v0/payment-history
Returns user's payment history
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "paymentHistory",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "amount": "$350.00",
- "date": "2022-15-01",
- "paymentMethod": "Direct Deposit",
- "paymentType": "Compensation & Pension - Recurring",
- "bank": "PACIFIC PREMIER BANK",
- "account": "************6464"
}
}
], - "meta": {
- "errors": [ ],
- "pagination": {
- "currentPage": 1,
- "perPage": 10,
- "totalPages": 1,
- "totalEntries": 7
}, - "availableYears": [
- 2019,
- 2018,
- 2017,
- 2016,
- 2015
]
}
}
/v0/payment-information/benefits
Returns direct deposit payment info
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "type": "paymentInformation",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "accountControl": {
- "canUpdateAddress": true,
- "corpAvailIndicator": true,
- "corpRecFoundIndicator": true,
- "hasNoBdnPaymentsIndicator": true,
- "identityIndicator": true,
- "indexIndicator": true,
- "isCompetentIndicator": true,
- "noFiduciaryAssignedIndicator": true,
- "notDeceasedIndicator": true,
- "canUpdatePayment": true
}, - "paymentAccount": {
- "accountNumber": "************6464",
- "accountType": "Savings",
- "financialInstitutionName": "PACIFIC PREMIER BANK",
- "financialInstitutionRoutingNumber": "948529982"
}
}
}
/v0/payment-information/benefits
Returns updated direct deposit payment info
Authorizations:
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
- Payload
{- "accountNumber": "12345678901",
- "accountType": "Savings",
- "financialInstitutionName": "PACIFIC PREMIER BANK",
- "financialInstitutionRoutingNumber": "021000021"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "type": "paymentInformation",
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "attributes": {
- "accountControl": {
- "canUpdateAddress": true,
- "corpAvailIndicator": true,
- "corpRecFoundIndicator": true,
- "hasNoBdnPaymentsIndicator": true,
- "identityIndicator": true,
- "indexIndicator": true,
- "isCompetentIndicator": true,
- "noFiduciaryAssignedIndicator": true,
- "notDeceasedIndicator": true,
- "canUpdatePayment": true
}, - "paymentAccount": {
- "accountNumber": "************6464",
- "accountType": "Savings",
- "financialInstitutionName": "PACIFIC PREMIER BANK",
- "financialInstitutionRoutingNumber": "948529982"
}
}
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "pensions",
- "id": "f26bc1f0-c389-4f3c-86e0-7712fb08fbe6",
- "attributes": {
- "isEligibleForPension": true,
- "isInReceiptOfPension": true,
- "netWorthLimit": 129094
}
}
}
/v0/push/prefs/{endpointSid}
Get the user's push notification preferences
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "pushGetPrefs",
- "id": "A3646A8D40C5B7319416179833809496",
- "attributes": {
- "preferences": [
- {
- "preferenceId": "appointment_reminders",
- "preferenceName": "Appointment Reminders",
- "value": true
}
]
}
}
}
/v0/push/prefs/{endpointSid}
Set the user's push notification preferences
Authorizations:
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
- Payload
{- "preference": "appointment_reminders",
- "enabled": true
}
Response samples
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/push/register
Allows a new app install to register to receive push notifications
Authorizations:
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
- Payload
{- "deviceToken": "740f4707bebcf74f9b7c25d48e3358945f6aa01da5ddb387462c7eaf61bb78ad",
- "osName": "ios",
- "deviceName": "Galaxy 8",
- "appName": "va_mobile_app",
- "debug": true
}
Response samples
- 201
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "type": "pushRegister",
- "id": "va_mobile_app",
- "attributes": {
- "endpointSid": "F1DC67487F5CE0227516037291336983"
}
}
}
/v0/push/send
Allows client to trigger specified push notification to be sent to specified endpoint
Authorizations:
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
- Payload
{- "appName": "va_mobile_app",
- "templateId": "0EF7C8C9390847D7B3B521426EFF5814",
- "personalization": {
- "%APPOINTMENT_DATE%": "DEC 14",
- "%APPOINTMENT_TIME%": "10:00"
}, - "debug": true
}
Response samples
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/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 |
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
- 200
- 408
- 422
- 500
- 502
- 503
- 504
"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:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": {
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "type": "user",
- "attributes": {
- "profile": {
- "firstName": "John",
- "middleName": "A",
- "lastName": "Smith",
- "contactEmail": {
- "id": 42,
- "emailAddress": "person42@example.com"
}, - "signinEmail": "john.a.smith@domain.com",
- "residentialAddress": {
- "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"
}, - "mailingAddress": {
- "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"
}, - "homePhoneNumber": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "mobilePhoneNumber": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "workPhoneNumber": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "faxPhoneNumber": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "signinService": "IDME"
}, - "authorizedServices": [
- "appeals",
- "directDepositBenefits",
- "militaryServiceHistory",
- "directDepositBenefitsUpdate",
- "scheduleAppointments"
], - "health": {
- "isCernerPatient": true,
- "facilities": [
- {
- "facilityId": "979",
- "isCerner": false,
- "facilityName": "Cheyenne VA Medical Center"
}
]
}
}
}, - "meta": {
- "availableServices": [
- "appeals",
- "appointments",
- "claims",
- "directDepositBenefits",
- "disabilityRating",
- "lettersAndDocuments",
- "militaryServiceHistory",
- "paymentHistory",
- "userProfileUpdate",
- "secureMessaging",
- "scheduleAppointments",
- "prescriptions"
]
}
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": {
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "type": "contact_info",
- "attributes": {
- "residentialAddress": {
- "id": 157032,
- "addressLine1": "1493 Martin Luther King Rd",
- "addressLine2": "string",
- "addressLine3": "string",
- "addressPou": "RESIDENCE/CHOICE",
- "addressType": "DOMESTIC",
- "city": "Fulton",
- "countryName": "US",
- "countryCodeIso3": "USA",
- "internationalPostalCode": null,
- "province": null,
- "stateCode": "NY",
- "zipCode": "97062",
- "zipCodeSuffix": "1234"
}, - "mailingAddress": {
- "id": 157032,
- "addressLine1": "1493 Martin Luther King Rd",
- "addressLine2": "string",
- "addressLine3": "string",
- "addressPou": "RESIDENCE/CHOICE",
- "addressType": "DOMESTIC",
- "city": "Fulton",
- "countryName": "US",
- "countryCodeIso3": "USA",
- "internationalPostalCode": null,
- "province": null,
- "stateCode": "NY",
- "zipCode": "97062",
- "zipCodeSuffix": "1234"
}, - "homePhone": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "mobilePhone": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "workPhone": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "contactEmail": {
- "id": 157032,
- "contactEmail": "person@example.com"
}
}
}
}
/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:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": {
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "type": "user",
- "attributes": {
- "profile": {
- "firstName": "Johnny",
- "preferredName": "John",
- "middleName": "A",
- "lastName": "Smith",
- "contactEmail": {
- "id": 42,
- "emailAddress": "person42@example.com"
}, - "signinEmail": "john.a.smith@domain.com",
- "genderIdentity": "M",
- "residentialAddress": {
- "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"
}, - "mailingAddress": {
- "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"
}, - "homePhoneNumber": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "mobilePhoneNumber": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "workPhoneNumber": {
- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}, - "signinService": "IDME"
}, - "authorizedServices": [
- "appeals",
- "directDepositBenefits",
- "militaryServiceHistory",
- "directDepositBenefitsUpdate",
- "scheduleAppointments"
], - "health": {
- "isCernerPatient": true,
- "facilities": [
- {
- "facilityId": "979",
- "isCerner": false,
- "facilityName": "Cheyenne VA Medical Center"
}
]
}
}
}, - "meta": {
- "availableServices": [
- "appeals",
- "appointments",
- "claims",
- "directDepositBenefits",
- "disabilityRating",
- "lettersAndDocuments",
- "militaryServiceHistory",
- "paymentHistory",
- "userProfileUpdate",
- "secureMessaging",
- "scheduleAppointments",
- "prescriptions"
]
}
}
/v2/user
Returns basic user information
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": {
- "id": "abe3f152-90b0-45cb-8776-4958bad0e0ef",
- "type": "user",
- "attributes": {
- "firstName": "John",
- "middleName": "A",
- "lastName": "Smith",
- "signinEmail": "john.a.smith@domain.com",
- "birthDate": "1970-08-12",
- "signinService": "IDME",
- "hasFacilityTransitioningToCerner": true,
- "edipi": "384759483"
}
}
}
/v0/user/addresses
Deletes a user's address
Authorizations:
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
- Payload
{- "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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "async_transaction_vet360_address_transactions",
- "attributes": {
- "transactionId": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "transactionStatus": "COMPLETED_SUCCESS",
- "type": "AsyncTransaction::VAProfile::AddressTransaction",
- "metadata": [ ]
}
}
}
/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:
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 | ||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "async_transaction_vet360_address_transactions",
- "attributes": {
- "transactionId": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "transactionStatus": "COMPLETED_SUCCESS",
- "type": "AsyncTransaction::VAProfile::AddressTransaction",
- "metadata": [ ]
}
}
}
/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:
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
- Payload
{- "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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "async_transaction_vet360_address_transactions",
- "attributes": {
- "transactionId": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "transactionStatus": "COMPLETED_SUCCESS",
- "type": "AsyncTransaction::VAProfile::AddressTransaction",
- "metadata": [ ]
}
}
}
/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:
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
- Payload
{- "addressLine1": "51 W Weber Rd",
- "addressPou": "CORRESPONDENCE",
- "addressType": "DOMESTIC",
- "city": "Columbus",
- "countryCodeIso3": "USA",
- "countryName": "United States",
- "stateCode": "OH",
- "type": "DOMESTIC",
- "zipCode": "43202"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "id": "8e07b8ff-6b36-4110-9225-a1a9e785ee13",
- "type": "suggested_address",
- "attributes": {
- "addressLine1": "37 N 1st St",
- "addressLine2": null,
- "addressLine3": null,
- "addressPou": "CORRESPONDENCE",
- "addressType": "DOMESTIC",
- "city": "Brooklyn",
- "countryCodeIso3": "USA",
- "internationalPostalCode": null,
- "province": null,
- "stateCode": "NY",
- "zipCode": "11249",
- "zipCodeSuffix": "3939"
}, - "meta": {
- "address": {
- "confidenceScore": 100,
- "addressType": "Domestic",
- "deliveryPointValidation": "UNDELIVERABLE"
}, - "validationKey": -73046298
}
}, - {
- "id": "a5a3b737-a31b-4c66-83b3-b98556b12072",
- "type": "suggested_address",
- "attributes": {
- "addressLine1": "37 S 1st St",
- "addressLine2": null,
- "addressLine3": null,
- "addressPou": "CORRESPONDENCE",
- "addressType": "DOMESTIC",
- "city": "Brooklyn",
- "countryCodeIso3": "USA",
- "internationalPostalCode": null,
- "province": null,
- "stateCode": "NY",
- "zipCode": "11249",
- "zipCodeSuffix": "4101"
}, - "meta": {
- "address": {
- "confidenceScore": 100,
- "addressType": "Domestic",
- "deliveryPointValidation": "CONFIRMED",
- "residentialDeliveryIndicator": "MIXED"
}, - "validationKey": -73046298
}
}
]
}
/v0/user/demographics
Returns the users demographics info
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "demographics",
- "attributes": {
- "genderIdentity": "F",
- "preferredName": "SAM"
}
}
}
/v0/user/emails
Deletes a user's email address
Authorizations:
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
- Payload
{- "emailAddress": "person42@example.com",
- "id": "42,"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "asyncTransactionVet360EmailTransactions",
- "attributes": {
- "transactionId": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "transactionStatus": "COMPLETED_SUCCESS",
- "type": "AsyncTransaction::VAProfile::EmailTransaction",
- "metadata": [ ]
}
}
}
/v0/user/emails
Creates a new email address
Authorizations:
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
- Payload
{- "emailAddress": "person42@example.com"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "asyncTransactionVet360EmailTransactions",
- "attributes": {
- "transactionId": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "transactionStatus": "COMPLETED_SUCCESS",
- "type": "AsyncTransaction::VAProfile::EmailTransaction",
- "metadata": [ ]
}
}
}
/v0/user/emails
Updates a user's email address
Authorizations:
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
- Payload
{- "emailAddress": "person42@example.com",
- "id": "42,"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "asyncTransactionVet360EmailTransactions",
- "attributes": {
- "transactionId": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "transactionStatus": "COMPLETED_SUCCESS",
- "type": "AsyncTransaction::VAProfile::EmailTransaction",
- "metadata": [ ]
}
}
}
/v0/user/gender_identity
Updates a user's gender identity. Only users with id.me or login.gov accounts may use this
Authorizations:
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
- Payload
{- "code": "B"
}
Response samples
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/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:
Responses
Response samples
- 200
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "data": {
- "id": "23fe358d-6e82-4541-804c-ce7562ba28f4",
- "type": "GenderIdentityOptions",
- "attributes": {
- "options": {
- "M": "Man",
- "B": "Non-binary",
- "TM": "Transgender man",
- "TF": "Transgender woman",
- "F": "Woman",
- "N": "Prefer not to answer",
- "O": "A gender not listed here"
}
}
}
}
/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:
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
- 400
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/user/logged-in
Called by the mobile app after successful login to perform any actions needed to start a session.
Authorizations:
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
- 400
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/user/preferred_name
Updates a user's preferred name. Only users with id.me or login.gov accounts may use this
Authorizations:
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
- Payload
{- "text": "New Preferred Name"
}
Response samples
- 401
- 403
- 404
- 408
- 500
- 502
- 503
- 504
{- "errors": [
- {
- "title": "string",
- "detail": "string",
- "code": "string",
- "status": "string",
- "source": null,
- "meta": {
- "messages": [
- {
- "key": "string",
- "severity": "string",
- "text": "string"
}
]
}
}
]
}
/v0/user/phones
Deletes one of a user's phone numbers
Authorizations:
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
- Payload
{- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "asyncTransactionVet360PhoneTransactions",
- "attributes": {
- "transactionId": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "transactionStatus": "COMPLETED_SUCCESS",
- "type": "AsyncTransaction::VAProfile::PhoneTransaction",
- "metadata": [ ]
}
}
}
/v0/user/phones
Creates a phone number for a user
Authorizations:
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
- Payload
{- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "asyncTransactionVet360PhoneTransactions",
- "attributes": {
- "transactionId": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "transactionStatus": "COMPLETED_SUCCESS",
- "type": "AsyncTransaction::VAProfile::PhoneTransaction",
- "metadata": [ ]
}
}
}
/v0/user/phones
Updates a user's phone number
Authorizations:
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
- Payload
{- "id": 157032,
- "areaCode": "704",
- "countryCode": "1",
- "phoneNumber": "7749069",
- "phoneType": "HOME",
- "extension": "4567"
}
Response samples
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": {
- "id": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "type": "asyncTransactionVet360PhoneTransactions",
- "attributes": {
- "transactionId": "3be0c7de-bfe1-4101-a326-5567bcd98b63",
- "transactionStatus": "COMPLETED_SUCCESS",
- "type": "AsyncTransaction::VAProfile::PhoneTransaction",
- "metadata": [ ]
}
}
}
/v1/health/immunizations
Returns a paginated list of immunization records for given user
Authorizations:
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
- 200
- 401
- 403
- 404
- 408
- 422
- 500
- 502
- 503
- 504
{- "data": [
- {
- "type": "immunization",
- "id": "I2-3JYDMXC6RXTU4H25KRVXATSEJQ000000",
- "attributes": {
- "cvxCode": 140,
- "date": "2009-03-19T12:24:55Z",
- "doseNumber": "Booster",
- "doseSeries": 1,
- "groupName": "FLU",
- "manufacturer": "nil",
- "note": "Dose #45 of 101 of Influenza seasonal injectable preservative free vaccine administered.",
- "shortDescription": "Influenza seasonal injectable preservative free",
- "reaction": "Swelling"
}, - "relationships": {
- "location": {
- "data": {
- "id": "I2-4KG3N5YUSPTWD3DAFMLMRL5V5U000000",
- "type": "location"
}, - "links": {
- "related": "staging-api.va.gov/mobile/v0/health/locations/I2-2FPCKUIXVR7RJLLG34XVWGZERM000000"
}
}
}
}
], - "meta": {
- "pagination": {
- "currentPage": 1,
- "perPage": 10,
- "totalPages": 2,
- "totalEntries": 15
}
}
}