{"swagger":"2.0","info":{"version":"1.0.0","title":"va.gov API","description":"The API for managing va.gov","termsOfService":"","contact":{"name":"va.gov team"},"license":{"name":"Creative Commons Zero v1.0 Universal"}},"tags":[{"name":"authentication","description":"Authentication operations"},{"name":"user","description":"Current authenticated user data"},{"name":"profile","description":"User profile information"},{"name":"benefits_info","description":"Veteran benefits profile information"},{"name":"benefits_forms","description":"Apply for and claim Veteran benefits"},{"name":"benefits_status","description":"Check status of benefits claims and appeals"},{"name":"form_526","description":"Creating and submitting compensation applications"},{"name":"prescriptions","description":"Prescription refill/tracking operations"},{"name":"secure_messaging","description":"Send and receive secure messages to health providers"},{"name":"gi_bill_institutions","description":"Discover institutions at which GI Bill benefits may be used"},{"name":"in_progress_forms","description":"In-progress form operations"},{"name":"claim_status_tool","description":"Claim Status Tool"},{"name":"site","description":"Site service availability and feedback"},{"name":"medical_copays","description":"Veteran Medical Copay information for VA facilities"},{"name":"banners","description":"VAMC Situation Update Banners"},{"name":"digital_disputes","description":"Submit digital dispute PDFs to the Debt Management Center and VBS"},{"name":"cave","description":"Submit documents to CAVE and retrieve extraction results"}],"host":"dev-api.va.gov","schemes":["https","http"],"basePath":"/","consumes":["application/json"],"produces":["application/json"],"parameters":{"authorization":{"name":"Authorization","in":"header","description":"The authorization method and token value","required":true,"type":"string"},"optional_authorization":{"name":"Authorization","in":"header","description":"The authorization method and token value","required":false,"type":"string"},"optional_page_number":{"name":"page","in":"query","required":false,"type":"integer","description":"Page of results, greater than 0 (default: 1)"},"optional_page_length":{"name":"per_page","in":"query","required":false,"type":"integer","description":"number of results, between 1 and 99 (default: 10)"},"optional_sort":{"name":"sort","in":"query","required":false,"type":"string","description":"Comma separated sort field(s), prepend with '-' for descending"},"optional_filter":{"name":"filter","in":"query","required":false,"type":"string","description":"Filter on refill_status: [[refill_status][logical operator]=status]"}},"paths":{"/v0/appeals":{"get":{"responses":{"401":{"description":"User is not authenticated (logged in)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"200 passes the response from the upstream appeals API","schema":{"$ref":"#/definitions/Appeals"}},"403":{"description":"Forbidden: user is not authorized for appeals","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"Not found: appeals not found for user","schema":{"$ref":"#/definitions/Errors"}},"422":{"description":"Unprocessable Entity: one or more validations has failed","schema":{"$ref":"#/definitions/Errors"}},"502":{"description":"Bad Gateway: the upstream appeals app returned an invalid response (500+)","schema":{"$ref":"#/definitions/Errors"}}},"description":"returns list of appeals for a user","operationId":"getAppeals","tags":["benefits_status"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/backend_statuses":{"get":{"description":"Gets the current status of all external services","operationId":"getBackendStatuses","tags":["backend_statuses"],"parameters":[{"$ref":"#/parameters/authorization"}],"responses":{"200":{"description":"Response is OK","schema":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["reported_at","statuses"],"properties":{"reported_at":{"type":"string","description":"The time from the call to PagerDuty's API","example":"2019-03-21T16:54:34.000Z"},"statuses":{"type":"array","items":{"properties":{"service":{"type":"string","example":"Appeals"},"service_id":{"type":"string","example":"appeals"},"status":{"type":"string","enum":["active","warning","critical","maintenance","disabled"],"example":"active"},"last_incident_timestamp":{"type":["string","null"],"example":"2019-03-21T16:54:34.000Z"}}}},"maintenance_windows":{"type":"array","items":{"properties":{"id":{"type":"integer","example":1},"external_service":{"type":"string","example":"idme"},"start_time":{"type":"string","description":"The start time of the maintenance window","example":"2024-02-17T09:00:00.000Z"},"end_time":{"type":"string","description":"The end time of the maintenance window","example":"2024-02-17T10:00:00.000Z"},"description":{"type":"string","description":"The description of the maintenance window","example":"ID.me will be down for maintenance"}}}}}}}}}}},"429":{"description":"Exceeded rate limit","schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"required":["title","detail","code","status"],"properties":{"title":{"type":"string","example":"Exceeded rate limit"},"detail":{"type":"string","example":"Exceeded PagerDuty's API rate limit"},"code":{"type":"string","example":"PAGERDUTY_429"},"status":{"type":"string","example":"429"}}}}}}}}}},"/v0/banners":{"get":{"description":"Returns banners that match the specified path and banner type","operationId":"getBannersByPath","tags":["banners"],"parameters":[{"name":"path","in":"query","description":"Path to match banners against","required":true,"type":"string"},{"name":"type","in":"query","description":"Banner type to filter by (default: \"full_width_banner_alert\")","required":false,"type":"string"}],"responses":{"200":{"description":"Banners retrieved successfully","schema":{"properties":{"banners":{"type":"array","items":{"properties":{"id":{"type":"integer"},"entity_bundle":{"type":"string"},"context":{"type":"array","items":{"properties":{"entity":{"properties":{"entityUrl":{"properties":{"path":{"type":"string"}}}}}}}}}}},"path":{"type":"string"},"banner_type":{"type":"string"}}}},"422":{"description":"Unprocessable Entity","schema":{"properties":{"error":{"type":"string","example":"Path parameter is required"}}}}}}},"/v0/benefits_claims/{id}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"Record not found","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"502":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"503":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Successfully retrieved claim details","schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/definitions/BenefitsClaimDetail"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded","schema":{"$ref":"#/definitions/Errors"}},"504":{"description":"Gateway Timeout: Lighthouse failed to respond in a timely manner","schema":{"$ref":"#/definitions/Errors"}}},"description":"Get details for a single benefits claim","operationId":"getBenefitsClaimById","tags":["benefits_claims"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"Lighthouse claim ID (e.g., 600383363)","required":true,"type":"string"}]}},"/v0/benefits_claims/failed_upload_evidence_submissions":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"Record not found","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/definitions/FailedEvidenceSubmission"}}}}},"504":{"description":"Gateway Timeout: Lighthouse failed to respond in a timely manner","schema":{"$ref":"#/definitions/Errors"}}},"description":"Get a list of failed evidence submissions for all claims for a user.","operationId":"getFailedUploadEvidenceSubmissions","tags":["benefits_claims"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/cave":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Document accepted for processing","schema":{"$ref":"#/definitions/CaveIntakeResponse"}},"502":{"description":"Document processing service unavailable","schema":{"$ref":"#/definitions/CaveServiceUnavailable"}}},"description":"Submit a PDF to the CAVE document processing proxy","operationId":"createCaveDocument","tags":["cave"],"consumes":["application/json"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"document","in":"body","description":"Document intake payload","required":true,"schema":{"$ref":"#/definitions/CaveIntakeRequest"}}]}},"/v0/cave/{id}/status":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Current document status","schema":{"$ref":"#/definitions/CaveStatusResponse"}},"502":{"description":"Document processing service unavailable","schema":{"$ref":"#/definitions/CaveServiceUnavailable"}}},"description":"Get the current processing status for a submitted document","operationId":"getCaveDocumentStatus","tags":["cave"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"Document identifier returned by POST /v0/cave","required":true,"type":"string"}]}},"/v0/cave/{id}/output":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Extracted output payload","schema":{"$ref":"#/definitions/CaveOutputResponse"}},"502":{"description":"Document processing service unavailable","schema":{"$ref":"#/definitions/CaveServiceUnavailable"}}},"description":"Retrieve extracted document output for a processed document","operationId":"getCaveDocumentOutput","tags":["cave"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"Document identifier returned by POST /v0/cave","required":true,"type":"string"},{"name":"type","in":"query","description":"Output variant to request. Defaults to 'artifact' when omitted.","required":false,"type":"string","enum":["artifact","form"]}]}},"/v0/cave/{id}/download":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Stored JSON payload for the requested KVP record","schema":{"$ref":"#/definitions/CaveKeyValuePayload"}},"502":{"description":"Document processing service unavailable","schema":{"$ref":"#/definitions/CaveServiceUnavailable"}}},"description":"Download the JSON payload for a specific extracted key-value pair","operationId":"downloadCaveDocumentOutput","tags":["cave"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"Document identifier returned by POST /v0/cave","required":true,"type":"string"},{"name":"kvpid","in":"query","description":"Key-value pair identifier from a prior output response","required":true,"type":"string"}]}},"/v0/cave/{id}/update":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Updated JSON payload","schema":{"$ref":"#/definitions/CaveKeyValuePayload"}},"502":{"description":"Document processing service unavailable","schema":{"$ref":"#/definitions/CaveServiceUnavailable"}}},"description":"Replace the JSON payload for a specific extracted key-value pair","operationId":"updateCaveDocumentOutput","tags":["cave"],"consumes":["application/json"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"Document identifier returned by POST /v0/cave","required":true,"type":"string"},{"name":"kvpid","in":"query","description":"Key-value pair identifier from a prior output response","required":true,"type":"string"},{"name":"payload","in":"body","description":"Replacement JSON object for the selected KVP record","required":true,"schema":{"$ref":"#/definitions/CaveKeyValuePayload"}}]}},"/v0/cave/diff":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Computed differences between the provided payloads","schema":{"$ref":"#/definitions/CaveDiffResponse"}}},"description":"Compare two JSON objects and return the detected field-level differences","operationId":"diffCavePayloads","tags":["cave"],"consumes":["application/json"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"payload","in":"body","description":"JSON object containing both 'lhs' and 'rhs' payloads","required":true,"schema":{"$ref":"#/definitions/CaveDiffRequest"}}]}},"/v0/datadog_action":{"post":{"summary":"Record a front-end action in Datadog","operationId":"recordDatadogAction","tags":["Telemetry"],"parameters":[{"name":"metric","in":"body","required":true,"schema":{"$ref":"#/definitions/DatadogActionRequest"}}],"responses":{"204":{"description":"No Content"}}}},"/burials/v0/claims":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}}},"description":"Submit a burial benefit claim","operationId":"addBurialClaim","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"form","in":"body","description":"Burial claim form data","required":true,"schema":{"type":"string"}}]}},"/v0/benefits_reference_data/{path}":{"get":{"description":"Get data from the Lighthouse Benefits Reference Data (BRD) End-point.","operationId":"getBenefitsReferenceData","tags":["benefits_reference_data"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"path","in":"path","description":"The path/end-point to get data from the Lighthouse Benefits Reference Data (BRD) api","required":true,"type":"string"}],"responses":{"200":{"description":"Response is OK","schema":{"required":["totalItems","totalPages","links","items"],"properties":{"totalItems":{"type":"integer"},"totalPages":{"type":"integer"},"links":{"type":"array"},"items":{"type":"array"}}}}}}},"/v0/claim_attachments":{"post":{"responses":{"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}}},"description":"Submit a claim document","operationId":"addClaimDocument","tags":["saved_claims","claim_attachments"],"parameters":[{"name":"form","in":"body","description":"Claim Document Data","required":true,"schema":{"required":["file","form_id"],"properties":{"file":{"type":"object"},"form_id":{"type":"string","example":"21P-0000"}}}}]}},"/v0/evss_claims/{evss_claim_id}/documents":{"post":{"responses":{"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/Errors"}},"202":{"description":"Response is Accepted","schema":{"required":["job_id"],"properties":{"job_id":{"type":"string","example":""}}}}},"description":"upload a document associated with a claim","operationId":"postDocument","tags":["claim_status_tool"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"cst_file_upload","in":"body","description":"","required":true,"schema":{"$ref":"#/definitions/ClaimDocumentInput"}},{"name":"evss_claim_id","description":"","in":"path","required":true,"type":"string"}]}},"/v0/claim_letters":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Claim Letters metadata list","schema":{"type":"array","items":{"$ref":"#/definitions/ClaimLetter"}}}},"description":"Get a list of claim letters' metadata","tags":["claim_letters"],"operationId":"getClaimLetters","summary":"Retrieve all claim letters' metadata"}},"/v0/claim_letters/{document_id}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Single Claim Letter PDF","schema":{"type":"file"}}},"tags":["claim_letters"],"summary":"Download a single PDF claim letter","operationId":"downloadPDFClaimLetter","produces":["application/pdf"],"parameters":[{"in":"path","name":"document_id","pattern":"^{[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}}$","description":"Specifies the `document_id` (a UUID) of the claim letter to retrieve.\\\n            Format: ***{AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE}***. *Note the use of `{` and `}`. These are required.*","required":true,"type":"string"}]}},"/v0/claims_evidence":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/Errors"}},"503":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"File uploaded successfully; returns the Claims Evidence file UUID","schema":{"type":"object","properties":{"uuid":{"type":"string","example":"c30626c9-954d-4dd1-9f70-1e38756d9d97"},"currentVersionUuid":{"type":"string","example":"c30626c9-954d-4dd1-9f70-1e38756d9d98"}}}},"404":{"description":"Endpoint not found (feature flag disabled)","schema":{"$ref":"#/definitions/Errors"}}},"description":"Upload a supplemental claim evidence file to the veteran's VA eFolder","operationId":"uploadClaimsEvidence","tags":["claims_evidence"],"consumes":["multipart/form-data"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"file","in":"formData","description":"The evidence file to upload","required":true,"type":"file"},{"name":"documentTypeId","in":"formData","description":"Claims Evidence document type ID identifying the type of evidence being uploaded","required":true,"type":"integer"},{"name":"supplementalClaimId","in":"formData","description":"Caseflow supplemental claim identifier (e.g. \"SC10879\") the upload is associated with","required":true,"type":"string"}]}},"/v0/coe/status":{"get":{"description":"Returns the status of a vet's Certificate of Eligibility application.","operationId":"coeGetCoeStatus","tags":["coe"],"parameters":[{"$ref":"#/parameters/authorization"}],"responses":{"200":{"description":"Response is OK. Possible statuses:\n            - ELIGIBLE: vet is automatically enrolled in a COE.\n            - UNABLE_TO_DETERMINE_AUTOMATICALLY: vet must complete the COE form.\n            - AVAILABLE: vet has filled out the COE form and it is available for download.\n            - DENIED: means that the vet submitted a COE form but it was denied.\n            - PENDING: vet submitted a COE form but it is still being reviewed.\n            - PENDING_UPLOAD: vet submitted a COE form but must upload more supporting documents to be granted a COE.\n            A reference_number is always returned.\n            An application_create_date is returned unless the COE application is ELIGIBLE or PENDING.\n            ","schema":{"properties":{"data":{"properties":{"attributes":{"properties":{"status":{"type":"string","enum":["ELIGIBLE","UNABLE_TO_DETERMINE_AUTOMATICALLY","AVAILABLE","DENIED","PENDING","PENDING_UPLOAD"],"example":"UNABLE_TO_DETERMINE_AUTOMATICALLY"},"referenceNumber":{"type":"string","example":"17923279"},"applicationCreateDate":{"type":"integer","example":1668447149000}}}}}}}}}}},"/v0/coe/download_coe":{"get":{"description":"Downloads Certificate of Eligiblity application as PDF","operationId":"coeDownloadCoe","tags":["coe"],"produces":["application/pdf"],"parameters":[{"$ref":"#/parameters/authorization"}],"responses":{"200":{"description":"Response is OK."}}}},"/v0/coe/documents":{"get":{"description":"Retrieves a list of supporting documents that the             vet attached to their COE application. The `id` is used to fetch documents             via the `/vo/coe/document_download/{id}` endpoint below. The `mimeType`             is, unfortunately, the filename from which the front end pulls the file             extension. The `documentType` will either be \"Veteran Correspondence\"             (meaning, a document uploaded by the veteran during the COE form) or             the \"kind\" of notification letter (e.g. \"COE Application First Returned\").             By the time you read this, the `description` will probably be a description             of any \"Veteran Correspondence.\" Notification letters should not have a             `description`.           ","operationId":"coeDocuments","tags":["coe"],"parameters":[{"$ref":"#/parameters/authorization"}],"responses":{"200":{"description":"Response is OK.","schema":{"properties":{"data":{"properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":23924541},"documentType":{"type":"string","example":"COE Application First Returned"},"description":{"type":["string","null"],"example":"null"},"mimeType":{"type":"string","example":"COE Application First Returned.pdf"},"createDate":{"type":"integer","example":1664222568000}}}}}}}}}}}},"/v0/coe/document_download/{id}":{"get":{"description":"Downloads supporting document with specified ID.","operationId":"coeDocumentDownload","tags":["coe"],"produces":["application/pdf"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"The ID of the supporting document.","required":true,"type":"integer"}],"responses":{"200":{"description":"Response is OK."}}}},"/v0/coe/submit_coe_claim":{"post":{"description":"Saves form data and submits it to LGY.","operationId":"coeSubmitCoeClaim","tags":["coe"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"lgy_coe_claim","in":"body","description":"Form data as a json string.","required":true,"schema":{"properties":{"lgy_coe_claim":{"properties":{"form":{"type":"string"}}}},"example":{"form":"{\"files\":[{\"name\":\"Example.pdf\",\"size\":60217,\"confirmationCode\":\"a7b6004e-9a61-4e94-b126-518ec9ec9ad0\",\"isEncrypted\":false,\"attachmentType\":\"Discharge or separation papers (DD214)\"}],\"relevantPriorLoans\":[{\"dateRange\":{\"from\":\"2002-05-01T00:00:00.000Z\",\"to\":\"2003-01-01T00:00:00.000Z\"},\"propertyAddress\":{\"propertyAddress1\":\"123 Faker St\",\"propertyAddress2\":\"2\",\"propertyCity\":\"Fake City\",\"propertyState\":\"AL\",\"propertyZip\":\"11111\"},\"vaLoanNumber\":\"111222333444\",\"propertyOwned\":true,\"intent\":\"ONETIMERESTORATION\"}],\"vaLoanIndicator\":true,\"periodsOfService\":[{\"serviceBranch\":\"Air National Guard\",\"dateRange\":{\"from\":\"2001-01-01T00:00:00.000Z\",\"to\":\"2002-02-02T00:00:00.000Z\"}}],\"identity\":\"ADSM\",\"contactPhone\":\"2222222222\",\"contactEmail\":\"veteran@example.com\",\"applicantAddress\":{\"country\":\"USA\",\"street\":\"140 FAKER ST\",\"street2\":\"2\",\"city\":\"FAKE CITY\",\"state\":\"MT\",\"postalCode\":\"80129\"},\"fullName\":{\"first\":\"Alexander\",\"middle\":\"Guy\",\"last\":\"Cook\",\"suffix\":\"Jr.\"},\"dateOfBirth\":\"1950-01-01\",\"privacyAgreementAccepted\":true}"}}}],"responses":{"200":{"description":"Form submitted successfully.","schema":{"properties":{"data":{"properties":{"attributes":{"properties":{"claim":{"properties":{"createdAt":{"type":"string","format":"date-time"},"encryptedKmsKey":{"type":"string"},"formId":{"type":"string"},"guid":{"type":"string","format":"uuid"},"id":{"type":"integer"},"updatedAt":{"type":"string","format":"date-time"},"verifiedDecryptableAt":{"type":"string","format":"date-time"}}},"referenceNumber":{}}}}}}}}}}},"/v0/coe/document_upload":{"post":{"description":"Upload supporting documents","operationId":"coeDocumentUpload","tags":["coe"],"consumes":["multipart/form-data"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"files","in":"body","description":"File data","required":true,"schema":{"type":"array","items":{"type":"object","properties":{"file":{"type":"string","format":"binary","example":"(binary)"},"document_type":{"type":"string","example":"VA home loan documents"},"file_type":{"type":"string","example":"pdf"},"file_name":{"type":"string","example":"example.pdf"}}}}}],"responses":{"200":{"description":"Files uploaded successfully"},"500":{"description":"Files failed uploading"}}}},"/v0/debts":{"get":{"description":"Provides an array of debt details provided by the Debt Management Center for the veteran.","operationId":"getDebts","tags":["debts"],"parameters":[{"name":"count_only","in":"query","description":"When true, returns only the count of debts","required":false,"type":"boolean"}],"responses":{"200":{"description":"Successful debts lookup","schema":{"properties":{"debtsCount":{"type":"integer","description":"Total number of debts (only returned when count_only=true)"},"has_dependent_debts":{"type":"boolean"},"debts":{"type":"array","items":{"properties":{"file_number":{"type":"string"},"payee_number":{"type":"string"},"person_entitled":{"type":"string"},"deduction_code":{"type":"string"},"benefit_type":{"type":"string"},"amount_overpaid":{"type":"string"},"amount_withheld":{"type":"string"},"debt_history":{"type":"array","items":{"properties":{"date":{"type":"string"},"letter_code":{"type":"string"},"status":{"type":"string"},"description":{"type":"string"}}}}}}}}}}}}},"/v0/debt_letters/{id}":{"get":{"description":"Download a debt letter PDF","operationId":"getDebtLetter","tags":["debts"],"parameters":[{"name":"id","in":"path","description":"Document ID of debt letter","required":true,"type":"string"}],"responses":{"200":{"description":"Debt letter download","schema":{"properties":{"data":{"type":"string","format":"binary"}}}}}}},"/v0/debt_letters":{"get":{"description":"Provides an array of debt letter ids and descriptions collected from eFolder","operationId":"getDebtLetters","tags":["debts"],"responses":{"200":{"description":"Successful debt letters lookup","schema":{"items":{"properties":{"document_id":{"type":"string"},"doc_type":{"type":"string"},"type_description":{"type":"string"},"received_at":{"type":"string","format":"date"}}}}}}}},"/v0/dependents_applications/show":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/Dependents"}}},"description":"Get the dependents for a veteran by participant ID","operationId":"getDependents","tags":["dependents_applications"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/dependents_applications":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}}},"description":"Submit a dependency claim","operationId":"addDependencyClaim","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"form","in":"body","description":"Dependency claim form data","required":true,"schema":{"type":"string"}}]}},"/debts_api/v0/digital_disputes":{"post":{"summary":"Submits digital dispute documents to the Debt Management Center and VBS","description":"Submits PDF documents for debt disputes to the Debt Management Center.\n            Veterans can upload one or more PDF files containing documentation supporting\n            their dispute of a debt.","operationId":"postDigitalDispute","tags":["digital_disputes"],"consumes":["multipart/form-data"],"parameters":[{"name":"metadata","in":"formData","description":"JSON string containing dispute information. Must include a \"disputes\" array with objects containing: composite_debt_id (string, required), deduction_code (string, required), original_ar (number, required), current_ar (number, required), benefit_type (string, required), dispute_reason (string, required), rcvbl_id (string, optional). Example: {\"disputes\":[{\"composite_debt_id\":\"71166\",\"deduction_code\":\"71\",\"original_ar\":166.67,\"current_ar\":120.4,\"benefit_type\":\"CH35\",\"dispute_reason\":\"I don't think I owe this debt to VA\"}]}","required":true,"type":"string"},{"name":"files[]","in":"formData","description":"One or more PDF files (maximum 1MB each)","required":true,"type":"file"}],"responses":{"200":{"description":"Digital dispute successful submission","schema":{"properties":{"message":{"type":"string"},"submission_id":{"type":"string"}}}},"422":{"description":"Validation error","schema":{"properties":{"errors":{"type":"object"}}}}}}},"/v0/dependents_verifications":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/DependentsVerifications"}}},"description":"Get the veteran's dependent status","operationId":"getDependentsVerifications","tags":["dependents_verifications"],"parameters":[{"$ref":"#/parameters/authorization"}]},"post":{"responses":{"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}}},"description":"Update diaries by sending true","operationId":"adDependentsVerifications","tags":["dependents_verifications"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"form","in":"body","description":"Veteran Diary verification","required":true,"schema":{"type":"string"}}]}},"/v0/disability_compensation_form/rated_disabilities":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"502":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/RatedDisabilities"}}},"description":"Get a list of previously rated disabilities for a veteran","operationId":"getRatedDisabilities","tags":["form_526"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/disability_compensation_form/suggested_conditions{params}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Returns a list of conditions","schema":{"$ref":"#/definitions/SuggestedConditions"}}},"description":"Given part of a condition name (medical or lay), return a list of matching conditions","operationId":"getSuggestedConditions","tags":["form_526"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"params","description":"part of a medical term of lay term for a medical condition; for example \"?name_part=anxiety\"","in":"path","type":"string","required":true}]}},"/v0/disability_compensation_form/submit_all_claim":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/SubmitDisabilityForm"}}},"description":"Submit the disability compensation v2 application for a veteran","operationId":"postSubmitFormV2","tags":["form_526"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"form526","in":"body","description":"Disability Compensation form data","required":true,"schema":{"$ref":"#/definitions/Form526SubmitV2"}}]}},"/v0/disability_compensation_form/submission_status/{job_id}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"Record not found","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Returns the status of a given submission","schema":{"$ref":"#/definitions/JobStatus"}}},"description":"Check the status of a submission job","operationId":"getSubmissionStatus","tags":["form_526"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"job_id","description":"the job_id for the submission to check the status of","in":"path","type":"string","required":true}]}},"/v0/disability_compensation_form/rating_info":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/RatingInfo"}}},"description":"Get the total combined disability rating for a veteran","operationId":"getRatingInfo","tags":["form_526"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/disability_compensation_form/separation_locations":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"502":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"503":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"forbidden user","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/SeparationLocations"}}},"description":"Get the separation locations from EVSS","operationId":"getIntakeSites","tags":["form_526"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/disability_compensation_in_progress_forms/{id}":{"delete":{"tags":["in_progress_forms","form_526"],"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"delete form response","schema":{"$ref":"#/definitions/InProgressFormResponse"}}},"description":"Delete form data","operationId":"deleteInProgressForm","parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"ID of the form","required":true,"type":"string"}]},"get":{"tags":["in_progress_forms","form_526"],"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"get form response","schema":{"$ref":"#/definitions/InProgressFormShowResponse"}}},"description":"Get form data","operationId":"getInProgressForm","parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"ID of the form","required":true,"type":"string"}]},"put":{"tags":["in_progress_forms","form_526"],"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"update form response","schema":{"$ref":"#/definitions/InProgressFormResponse"}}},"description":"Update form data and metadata","operationId":"updateInProgressForm","parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"ID of the form","required":true,"type":"string"},{"name":"payload","in":"body","description":"updated form data and metadata. one of \"form_data\" or \"formData\" must be present","required":true,"schema":{"example":{"formData":{"lastName":"Smith"},"metadata":{"ver":1}},"properties":{"formData":{"type":"object","description":"(alias \"form_data\")"},"form_data":{"type":"object","description":"(alias \"formData\")"},"metadata":{"type":"object"}}}}]}},"/v0/education_benefits_claims/{form_type}":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"create education benefits claim response","schema":{"$ref":"#/definitions/EducationBenefitsClaimData"}}},"description":"Submit an education benefits claim","operationId":"addEducationBenefitsClaim","tags":["benefits_forms"],"parameters":[{"name":"education_benefits_claim","in":"body","description":"Education benefits form data","required":true,"schema":{"$ref":"#/definitions/EducationBenefitsClaimInput"}},{"name":"form_type","in":"path","description":"Form code. Allowed values: 1990 1995 5490","required":true,"type":"string"}]}},"/v0/efolder":{"get":{"summary":"Provides a list of document ids and descriptions from eFolder","description":"Provides a list of document ids and descriptions from eFolder. The documents provided are extracted from VBMS and compared against a list of documents for the user that is provided by BGS. A merge function between the two lists is performed to determine which documents should be viewable for the veteran.","operationId":"getDocuments","tags":["efolder"],"responses":{"200":{"description":"Document metadata retrieved successfully","schema":{"items":{"properties":{"document_id":{"type":"string"},"doc_type":{"type":"string"},"type_description":{"type":"string"},"received_at":{"type":"string","format":"date"}}}}}}}},"/v0/efolder/{id}":{"get":{"summary":"Allows the veteran to download the document","description":"Provides a method to download a PDF copy of the document. The ID passed into the query string of the URL must match the ID that is attached to the document that is provided by VBMS.","operationId":"getDocument","tags":["efolder"],"parameters":[{"name":"id","in":"path","description":"Document ID of document","required":true,"type":"string"}],"responses":{"200":{"description":"Document download","schema":{"properties":{"data":{"type":"string","format":"binary"}}}}}}},"/v0/event_bus_gateway/send_email":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"type":"object","properties":{"errors":{"type":"string","example":"Service Account access token JWT is malformed"}}}},"200":{"description":"Response is OK"}},"description":"Sends an email to a veteran about an event managed by Event Bus Gateway","operationId":"sendEmail","tags":["event_bus_gateway"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"template_id","description":"VA Notify template ID","in":"formData","required":true,"type":"integer"}]}},"/v0/event_bus_gateway/send_push":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"type":"object","properties":{"errors":{"type":"string","example":"Service Account access token JWT is malformed"}}}},"200":{"description":"Response is OK"}},"description":"Sends a push notification to a veteran about an event managed by Event Bus Gateway","operationId":"sendPush","tags":["event_bus_gateway"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"template_id","description":"VEText push notification template ID","in":"formData","required":true,"type":"integer"}]}},"/v0/event_bus_gateway/send_notifications":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"type":"object","properties":{"errors":{"type":"string","example":"Service Account access token JWT is malformed"}}}},"200":{"description":"Response is OK"}},"description":"Sends one email and/or one push notification to a veteran. At least one template ID must be provided.","operationId":"sendNotifications","tags":["event_bus_gateway"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"email_template_id","description":"VA Notify email template ID (optional)","in":"formData","required":false,"type":"integer"},{"name":"push_template_id","description":"VEText push notification template ID (optional)","in":"formData","required":false,"type":"integer"}]}},"/v0/feature_toggles":{"get":{"description":"Gets the current status of feature toggles","operationId":"getFeatureToggless","tags":["site"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"$ref":"#/parameters/features"},{"name":"cookie_id","in":"query","description":"a unique string from the front end so that features can be configured to be \"sticky\" for\n                               unauthenticated users","required":false,"type":"string"}],"responses":{"200":{"description":"Response is OK","schema":{"required":["data"],"properties":{"data":{"type":"object","required":["features"],"properties":{"features":{"type":"array","items":{"properties":{"name":{"type":"string","example":"facility_locator"},"value":{"type":"boolean"}}}}}}}}}}}},"/debts_api/v0/financial_status_reports":{"post":{"summary":"Submits Form VA-5655 data to the Debt Management Center","description":"Submits Form VA-5655 to the Debt Management Center.\n            The data is ingested by DMC's Financial Status Report API, where it is\n            then used to fill a PDF version of the VA-5655 form, which gets submitted\n            to filenet.","operationId":"postFinancialStatusReport","tags":["financial_status_reports"],"parameters":[{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/FinancialStatusReport"}}],"responses":{"200":{"description":"Form VA-5655 Financial Status Report successful submission","schema":{"properties":{"content":{"type":"string"}}}}}}},"/debts_api/v0/financial_status_reports/transform_and_submit":{"post":{"summary":"Transforms FE-shaped Form VA-5655 data and submits to the Debt Management Center","description":"Accepts a raw FE-submitted VA-5655 payload, runs server-side\n            transforms (discretionary income, totals, additional-comment composition,\n            etc.) via FullTransformService, then forwards the result to the Debt\n            Management Center's Financial Status Report API, where it is used to fill\n            a PDF version of the VA-5655 form for submission to filenet.\n            This is the endpoint the vets-website FE posts to, and the only endpoint\n            that accepts hardship-suspension resolution data.","operationId":"postFinancialStatusReportTransformAndSubmit","tags":["financial_status_reports"],"parameters":[{"name":"request","in":"body","required":true,"schema":{"$ref":"#/definitions/FinancialStatusReportTransform"}}],"responses":{"200":{"description":"Form VA-5655 Financial Status Report successful submission","schema":{"properties":{"content":{"type":"string"}}}}}}},"/debts_api/v0/financial_status_reports/download_pdf":{"get":{"summary":"Downloads the filled copy of VA-5655 Financial Status Report","operationId":"getFinancialStatusReport","tags":["financial_status_reports"],"responses":{"200":{"description":"Financial Status Report download","schema":{"properties":{"data":{"type":"string","format":"binary"}}}}}}},"/debts_api/v0/financial_status_reports/submissions":{"get":{"summary":"Returns all Financial Status Report submissions for the current user","description":"Retrieves a list of all FSR (VA Form 5655) submissions for the authenticated user,\n            ordered by most recent first.","operationId":"getFinancialStatusReportSubmissions","tags":["financial_status_reports"],"responses":{"200":{"description":"Financial Status Report submissions list","schema":{"properties":{"submissions":{"type":"array","items":{"properties":{"id":{"type":"string","description":"Submission UUID"},"created_at":{"type":"string","format":"date-time","description":"Submission creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"},"state":{"type":"string","enum":["unassigned","in_progress","submitted","failed"],"description":"Current state of the submission"},"metadata":{"type":"object","properties":{"debt_type":{"type":"string","enum":["DEBT","COPAY"],"description":"Type of debt included in the submission"},"streamlined":{"type":"object","description":"Streamlined waiver information","properties":{"value":{"type":"boolean","description":"Whether this is a streamlined submission"},"type":{"type":"string","enum":["short","long"],"description":"Type of streamlined submission"}}},"combined":{"type":"boolean","description":"Whether submission includes both VBA debts and VHA copays"},"debt_identifiers":{"type":"array","description":"Array of unique identifiers for debts/copays to help detect duplicate submissions","items":{"type":"string","description":"For VBA debts: composite ID (deductionCode + originalAR). For VHA copays: UUID"}}}}}}}}}}}}},"/v0/form1010cg/attachments":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Ok","schema":{"required":["data"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"description":"The record's identifier","type":"string","example":"\"67\""},"type":{"description":"This is always \"form1010cg_attachments\"","type":"string","example":"form1010cg_attachments"},"attributes":{"type":"object","required":["guid"],"properties":{"guid":{"description":"The document's GUID. To attach this document to a claim,\\\n                                         include this id the claim's submission payload.","type":"string","example":"834d9f51-d0c7-4dc2-9f2e-9b722db98069"}}}}}}}}},"description":"Upload Power of Attorney attachment for a caregivers assistance claim.","parameters":[{"name":"attachment","in":"body","description":"The document data","required":true,"schema":{"required":["file_data"],"properties":{"file_data":{"type":"string","example":"my-poa.png"},"password":{"type":"string","example":"MyPassword123"}}}}]}},"/v0/form1010_ezr_attachments":{"post":{"responses":{"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"submit 10-10EZR attachment response","schema":{"properties":{"data":{"type":"object","required":["attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","required":["guid"],"properties":{"guid":{"type":"string"}}}}}}}}},"description":"Submit a 10-10EZR form attachment","operationId":"postForm1010EzrAttachment","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"form1010_ezr_attachment","in":"body","description":"10-10EZR form attachment data","required":true,"schema":{"required":["file_data"],"properties":{"file_data":{"type":"string","example":"filename.pdf"},"password":{"type":"string","example":"My Password"}}}}]}},"/v0/form1010_ezrs":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Backend service error","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"submit 10-10EZR form response","schema":{"$ref":"#/definitions/Form1010EzrSubmissionResponse"}}},"description":"Submit a 10-10EZR form","operationId":"postForm1010Ezr","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"form","in":"body","description":"10-10EZR form data","required":true,"schema":{"type":"string"}}]}},"/v0/form1010_ezrs/download_pdf":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}}},"description":"Download a pre-filled 10-10EZR PDF form.","operationId":"postForm1010EzrDownloadPdf","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/form1095_bs/available_forms":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Successful return of available forms array","schema":{"required":["available_forms"],"properties":{"available_forms":{"type":"array","items":{"properties":{"year":{"type":"integer","example":2021},"last_updated":{"type":["string","null"],"example":"2022-08-03T16:08:50.071Z"}}}}}}}},"description":"List of available 1095-B forms for the user","operationId":"getAvailable1095BForms","tags":["form_1095_b"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/form1095_bs/download_txt/{tax_year}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Successful production of 1095-B text form","schema":{"type":"file"}},"404":{"description":"User's 1095-B form not found for given tax-year","schema":{"$ref":"#/definitions/Errors"}}},"description":"Download text version of the 1095-B for the given tax year","operationId":"downloadTextForm1095B","produces":["text/plain; charset=utf-8"],"tags":["form_1095_b"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"tax_year","in":"path","description":"Tax year of 1095-B to retrieve","required":true,"type":"integer"}]}},"/v0/form1095_bs/download_pdf/{tax_year}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Successful production of 1095-B PDF form","schema":{"type":"file"}},"404":{"description":"User's 1095-B form not found for given tax-year","schema":{"$ref":"#/definitions/Errors"}}},"description":"Download PDF version of the 1095-B for the given tax year","operationId":"downloadPdfForm1095B","produces":["application/pdf"],"tags":["form_1095_b"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"tax_year","in":"path","description":"Tax year of 1095-B to retrieve","required":true,"type":"integer"}]}},"/v0/form210779":{"post":{"responses":{"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"Record not found","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}},"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}}},"description":"Submit a 21-0779 form (Request for Nursing Home Information in Connection with Claim for Aid and Attendance) - STUB IMPLEMENTATION for frontend development","operationId":"submitForm210779","tags":["benefits_forms"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"form","in":"body","description":"Form 21-0779 submission data","required":true,"schema":{}}]}},"/v0/form210779/download_pdf/{guid}":{"get":{"responses":{"404":{"description":"Record not found","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"PDF file successfully generated and ready for download","schema":{"type":"file"}}},"description":"Download the submitted 21-0779 PDF form","operationId":"downloadForm210779Pdf","tags":["benefits_forms"],"produces":["application/pdf","application/json"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"guid","in":"path","description":"the guid from the form submission response","required":true,"type":"string"}]}},"/v0/form212680":{"post":{"responses":{"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"Record not found","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}},"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}}},"description":"Create a SavedClaim for 21-2680(Examination for Housebound Status or Permanent Need for Regular Aid and Attendance),to be used later for PDF generation","operationId":"createForm212680Pdf","tags":["benefits_forms"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"form","in":"body","description":"Form 21-2680 submission data","required":true,"schema":{}}]}},"/v0/form212680/download_pdf/{guid}":{"get":{"responses":{"404":{"description":"Record not found","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"PDF file successfully generated and ready for download","schema":{"type":"file"}}},"description":"Download the submitted 21-2680 PDF form","operationId":"downloadForm212680Pdf","tags":["benefits_forms"],"produces":["application/pdf","application/json"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"guid","in":"path","description":"the guid from the form submission response","required":true,"type":"string"}]}},"/v0/forms":{"get":{"description":"Returns a list of forms from the VA Lighthouse API, filtered using an optional search term","operationId":"getForms","tags":["forms"],"parameters":[{"name":"term","in":"query","description":"Query the form number as well as title","required":false,"type":"string"}],"responses":{"200":{"description":"Successful forms query","schema":{"$ref":"#/definitions/Forms"}}}}},"/v0/gi/calculator_constants":{"get":{"description":"Gets all calculator constants","operationId":"gibctCalculatorConstantsIndex","tags":["gi_bill_institutions"],"responses":{"200":{"description":"autocomplete response","schema":{"$ref":"#/definitions/GibctCalculatorConstants"}}}}},"/v0/gi/institutions/autocomplete":{"get":{"description":"Retrieves institution names begining with a set of letters","operationId":"gibctInstitutionsAutocomplete","tags":["gi_bill_institutions"],"parameters":[{"name":"term","in":"query","required":true,"type":"string","description":"start of an institution name"}],"responses":{"200":{"description":"autocomplete response","schema":{"$ref":"#/definitions/GibctInstitutionsAutocomplete"}}}}},"/v0/gi/institutions/search":{"get":{"description":"Retrieves institutions with a partial match for names, or match of city or facility code","operationId":"gibctInstitutionsSearch","tags":["gi_bill_institutions"],"parameters":[{"name":"term","in":"query","required":false,"type":"string","description":"(partial) institution name, city, or facility code"}],"responses":{"200":{"description":"search response","schema":{"$ref":"#/definitions/GibctInstitutionsSearch"}}}}},"/v0/gi/institutions/{id}":{"get":{"description":"Get details about an institution","operationId":"showInstitution","tags":["gi_bill_institutions"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","description":"facility code of the institution"}],"responses":{"200":{"description":"show response","schema":{"$ref":"#/definitions/GibctInstitution"}},"404":{"description":"Operation fails with invalid facility code","schema":{"$ref":"#/definitions/Errors"}}}}},"/v0/gi/institution_programs/autocomplete":{"get":{"description":"Retrieves institution programs beginning with a set of letters","operationId":"gibctInstitutionProgramsAutocomplete","tags":["gi_bill_institutions"],"parameters":[{"name":"term","in":"query","required":true,"type":"string","description":"start of an institution program name"}],"responses":{"200":{"description":"autocomplete response","schema":{"$ref":"#/definitions/GibctInstitutionProgramsAutocomplete"}}}}},"/v0/gi/institution_programs/search":{"get":{"description":"Retrieves institution programs with partial match","operationId":"gibctInstitutionProgramsSearch","tags":["gi_bill_institutions"],"parameters":[{"name":"term","in":"query","required":false,"type":"string","description":"(partial) institution program name, city, or facility code"}],"responses":{"200":{"description":"search response","schema":{"$ref":"#/definitions/GibctInstitutionProgramsSearch"}}}}},"/v0/gi/yellow_ribbon_programs":{"get":{"description":"Retrieves Yellow Ribbon Programs with partial match","operationId":"gibctYellowRibbonPrograms","tags":["gi_bill_institutions"],"parameters":[{"description":"Filter results by the name of a city.","in":"query","name":"city","required":false,"type":"string"},{"description":"Filter results to only include unlimited contribution amounts.","enum":["unlimited"],"in":"query","name":"contribution_amount","required":false,"type":"string"},{"description":"Filter results by a country abbreviation (e.g. \"usa\").","in":"query","name":"country","required":false,"type":"string"},{"description":"Filter results to only include unlimited eligible students.","enum":["unlimited"],"in":"query","name":"number_of_students","required":false,"type":"string"},{"description":"The page of results. It must be greater than 0 if used.","in":"query","name":"page","required":false,"type":"number"},{"description":"Number of results to include per page. It must be greater than 0 if used.","in":"query","name":"per_page","required":false,"type":"string"},{"description":"Filter results by the name of the Institution.","in":"query","name":"name","required":false,"type":"string"},{"description":"Sort results by a Yellow Ribbon Program attribute.","enum":["city","contribution_amount","country","number_of_students","institution","state"],"in":"query","name":"sort_by","required":false,"type":"string"},{"description":"Sorts results either ascending or descending.","enum":["desc","asc"],"in":"query","name":"sort_direction","required":false,"type":"string"},{"description":"Filter results by a State abbreviation (e.g. \"co\").","in":"query","name":"state","required":false,"type":"string"}],"responses":{"200":{"description":"response","schema":{"$ref":"#/definitions/GibctYellowRibbonPrograms"}}}}},"/v0/health_care_applications/rating_info":{"get":{"description":"Get the user's service connected disability rating","operationId":"getDisabilityRating","tags":["benefits_forms"],"responses":{"200":{"description":"disability rating response","schema":{"properties":{"data":{"type":"object","required":["attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","required":["user_percent_of_disability"],"properties":{"user_percent_of_disability":{"type":"integer"}}}}}}}}}}},"/v0/health_care_applications/{id}":{"get":{"description":"Show the status of a health care application","operationId":"getHealthCareApplication","tags":["benefits_forms"],"parameters":[{"name":"id","in":"path","description":"ID of the application","required":true,"type":"string"}],"responses":{"200":{"description":"get HCA response","schema":{"properties":{"data":{"type":"object","required":["attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","required":["state"],"properties":{"state":{"type":"string"},"form_submission_id":{"type":["string","null"]},"timestamp":{"type":["string","null"]}}}}}}}}}}},"/v0/health_care_applications":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Backend service error","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"submit health care application response","schema":{"$ref":"#/definitions/HealthCareApplicationSubmissionResponse"}}},"description":"Submit a health care application","operationId":"addHealthCareApplication","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"form","in":"body","description":"Health care application form data","required":true,"schema":{"type":"string"}}]}},"/v0/health_care_applications/enrollment_status":{"get":{"description":"Check the status of a health care application. Non-logged in users must pass query parameters with user attributes. No parameters needed for logged in loa3 users.","operationId":"enrollmentStatusHealthCareApplication","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"}],"responses":{"200":{"description":"enrollment_status response","schema":{"properties":{"application_date":{"type":["string","null"],"example":"2018-12-27T00:00:00.000-06:00"},"enrollment_date":{"type":["string","null"],"example":"2018-12-27T17:15:39.000-06:00"},"preferred_facility":{"type":["string","null"],"example":"988 - DAYT20"},"parsed_status":{"type":"string","example":"enrolled","enum":["activeduty","canceled_declined","closed","deceased","enrolled","inelig_champva","inelig_character_of_discharge","inelig_citizens","inelig_filipinoscouts","inelig_fugitivefelon","inelig_guard_reserve","inelig_medicare","inelig_not_enough_time","inelig_not_verified","inelig_other","inelig_over65","inelig_refusedcopay","inelig_training_only","login_required","none_of_the_above","pending_mt","pending_other","pending_purpleheart","pending_unverified","rejected_inc_wrongentry","rejected_rightentry","rejected_sc_wrongentry","non_military"]},"effective_date":{"type":"string","example":"2019-01-02T21:58:55.000-06:00"},"priority_group":{"type":["string","null"],"example":"Group 3"},"can_submit_financial_info":{"type":["boolean","null"],"example":true}}}}}},"post":{"description":"Check the status of a health care application. Non-logged in users must pass request body parameters with user attributes. No parameters needed for logged in loa3 users.","operationId":"enrollmentStatusHealthCareApplication","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"userAttributes","in":"body","description":"User attributes for enrollment status check","required":false,"schema":{"properties":{"userAttributes":{"type":"object","properties":{"veteranFullName":{"type":"object","properties":{"first":{"type":"string","description":"user first name"},"middle":{"type":"string","description":"user middle name"},"last":{"type":"string","description":"user last name"},"suffix":{"type":"string","description":"user name suffix"}}},"veteranDateOfBirth":{"type":"string","description":"user date of birth"},"veteranSocialSecurityNumber":{"type":"string","description":"user ssn"},"gender":{"type":"string","description":"user gender"}}}}}}],"responses":{"200":{"description":"enrollment_status response","schema":{"properties":{"application_date":{"type":["string","null"],"example":"2018-12-27T00:00:00.000-06:00"},"enrollment_date":{"type":["string","null"],"example":"2018-12-27T17:15:39.000-06:00"},"preferred_facility":{"type":["string","null"],"example":"988 - DAYT20"},"parsed_status":{"type":"string","example":"enrolled","enum":["activeduty","canceled_declined","closed","deceased","enrolled","inelig_champva","inelig_character_of_discharge","inelig_citizens","inelig_filipinoscouts","inelig_fugitivefelon","inelig_guard_reserve","inelig_medicare","inelig_not_enough_time","inelig_not_verified","inelig_other","inelig_over65","inelig_refusedcopay","inelig_training_only","login_required","none_of_the_above","pending_mt","pending_other","pending_purpleheart","pending_unverified","rejected_inc_wrongentry","rejected_rightentry","rejected_sc_wrongentry","non_military"]},"effective_date":{"type":"string","example":"2019-01-02T21:58:55.000-06:00"},"priority_group":{"type":["string","null"],"example":"Group 3"},"can_submit_financial_info":{"type":["boolean","null"],"example":true}}}}}}},"/v0/health_care_applications/healthcheck":{"get":{"description":"Check if the HCA submission service is up","operationId":"healthcheckHealthCareApplication","tags":["benefits_forms"],"responses":{"200":{"description":"health care application health check response","schema":{"$ref":"#/definitions/HealthCareApplicationHealthcheckResponse"}}}}},"/v0/health_care_applications/facilities":{"get":{"description":"Retrieve a list of active healthcare facilities","operationId":"getFacilities","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"zip","in":"query","description":"ZIP code for filtering facilities","required":false,"type":"string"},{"name":"state","in":"query","description":"State for filtering facilities","required":false,"type":"string"},{"name":"lat","in":"query","description":"Latitude for filtering facilities","required":false,"type":"string"},{"name":"long","in":"query","description":"Longitude for filtering facilities","required":false,"type":"string"},{"name":"radius","in":"query","description":"The radius around the location for facility search.","required":false,"type":"string"},{"name":"bbox","in":"query","description":"Bounding box for facility search","required":false,"type":"string"},{"name":"visn","in":"query","description":"VISN code for filtering facilities","required":false,"type":"string"},{"name":"type","in":"query","description":"Type of facility","required":false,"type":"string"},{"name":"services","in":"query","description":"Services offered at the facility","required":false,"type":"string"},{"name":"mobile","in":"query","description":"Filter by mobile facilities","required":false,"type":"boolean"},{"name":"page","in":"query","description":"Page number for pagination","required":false,"type":"integer"},{"name":"per_page","in":"query","description":"Number of facilities per page","required":false,"type":"integer"},{"name":"facilityIds","in":"query","description":"Array of facility IDs","type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Successful response with a list of healthcare facilities","schema":{"$ref":"#/definitions/Facilities"}}}}},"/v0/health_care_applications/download_pdf":{"post":{"description":"Download a pre-filled 10-10EZ PDF form.","tags":["benefits_forms"],"parameters":[{"name":"form","in":"body","description":"The form data used to fill the PDF form.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF form download","schema":{"properties":{"data":{"type":"string","format":"binary"}}}}}}},"/v0/hca_attachments":{"post":{"responses":{"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"submit hca attachment response","schema":{"properties":{"data":{"type":"object","required":["attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","required":["guid"],"properties":{"guid":{"type":"string"}}}}}}}}},"description":"Submit a health care application attachment","operationId":"postHealthCareApplicationAttachment","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"hca_attachment","in":"body","description":"HCA attachment data","required":true,"schema":{"required":["file_data"],"properties":{"file_data":{"type":"string","example":"filename.pdf"},"password":{"type":"string","example":"My Password"}}}}]}},"/v0/in_progress_forms":{"get":{"tags":["in_progress_forms"],"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"get saved form summaries","schema":{"$ref":"#/definitions/InProgressFormsResponse"}}},"description":"Get Saved Form Summaries","operationId":"listInProgressForms","parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/in_progress_forms/{id}":{"delete":{"tags":["in_progress_forms"],"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"delete form response","schema":{"$ref":"#/definitions/InProgressFormResponse"}}},"description":"Delete form data","operationId":"deleteInProgressForm","parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"ID of the form","required":true,"type":"string"}]},"get":{"tags":["in_progress_forms"],"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"get form response","schema":{"$ref":"#/definitions/InProgressFormShowResponse"}}},"description":"Get form data","operationId":"getInProgressForm","parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"ID of the form","required":true,"type":"string"}]},"put":{"tags":["in_progress_forms"],"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"Internal server error","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"update form response","schema":{"$ref":"#/definitions/InProgressFormResponse"}}},"description":"Update form data and metadata","operationId":"updateInProgressForm","parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"ID of the form","required":true,"type":"string"},{"name":"payload","in":"body","description":"updated form data and metadata. one of \"form_data\" or \"formData\" must be present","required":true,"schema":{"example":{"formData":{"lastName":"Smith"},"metadata":{"ver":1}},"properties":{"formData":{"type":"object","description":"(alias \"form_data\")"},"form_data":{"type":"object","description":"(alias \"formData\")"},"metadata":{"type":"object"}}}}]}},"/v0/intent_to_file":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/IntentToFiles"}}},"description":"Get a list of all Intent To File requests made by the veteran","operationId":"getIntentToFile","tags":["form_526","intent_to_file"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/intent_to_file/{itf_type}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/IntentToFiles"}}},"description":"Get a list of the Intent To File requests with the specified type made by the veteran","operationId":"getIntentToFile","tags":["intent_to_file"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"itf_type","in":"path","description":"ITF type. Allowed values: compensation pension survivor","required":true,"type":"string"}]},"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/IntentToFile"}}},"description":"Creates a new Intent To File for the veteran","operationId":"postIntentToFile","tags":["form_526","intent_to_file"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"itf_type","in":"path","description":"ITF type. Allowed values: compensation pension survivor","required":true,"type":"string"}]}},"/v0/intents_to_file":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","example":"193685"},"type":{"type":"string","example":"compensation"},"creation_date":{"type":"string","example":"2025-03-16T19:15:21.000-05:00"},"expiration_date":{"type":"string","example":"2026-03-16T19:15:20.000-05:00"},"status":{"type":"string","example":"active"}}}}}}}},"description":"Get all active Intent to File records across compensation, pension, and survivor types","operationId":"getIntentsToFile","tags":["intents_to_file"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/maintenance_windows":{"get":{"description":"Get a list of scheduled maintenance windows by service","operationId":"getMaintenanceWindows","tags":["site"],"responses":{"200":{"description":"get list of scheduled maintenance windows","schema":{"$ref":"#/definitions/MaintenanceWindows"}}}}},"/v0/mdot/supplies":{"post":{"description":"Create a MDOT supply order","operationId":"addMdotOrder","tags":["mdot"],"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"integer","example":2499},"order_id":{"type":"integer","example":1001},"status":{"type":"string","example":"Order Processed","enum":["Order Processed","Order Pending","Unable to order item since the last order was less than 5 months ago."]}}}}}},"parameters":[{"$ref":"#/parameters/authorization"},{"name":"order_input","in":"body","description":"Order input","required":true,"schema":{"type":"object","properties":{"use_permanent_address":{"type":"boolean","example":true},"use_temporary_address":{"type":"boolean","example":false},"vet_email":{"type":"string","example":"vet1@va.gov"},"order":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"integer","example":2499}}}},"permanent_address":{"type":"object","properties":{"is_military":{"type":"boolean","example":false},"street":{"type":"string","example":"125 SOME RD"},"street2":{"type":"string","example":"APT 101"},"city":{"type":"string","example":"DENVER"},"state":{"type":"string","example":"CO"},"country":{"type":"string","example":"United States"},"postal_code":{"type":"string","example":"11111"}}},"temporary_address":{"type":"object","properties":{"is_military":{"type":"boolean","example":false},"street":{"type":"string","example":"17250 w colfax ave"},"street2":{"type":"string","example":"a-204"},"city":{"type":"string","example":"Golden"},"state":{"type":"string","example":"CO"},"country":{"type":"string","example":"United States"},"postal_code":{"type":"string","example":"80401"}}}}}}],"produces":["application/json"],"consumes":["application/json"]}},"/v0/medical_copays":{"get":{"description":"List of user copays for VA facilities","operationId":"getMedicalCopays","tags":["medical_copays"],"parameters":[{"$ref":"#/parameters/authorization"}],"responses":{"200":{"description":"Successful copays lookup","schema":{"required":["data","status"],"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"pSSeqNum":{"type":"integer","example":0},"pSTotSeqNum":{"type":"integer","example":0},"pSFacilityNum":{"type":"string"},"pSFacPhoneNum":{"type":"string"},"pSTotStatement":{"type":"integer","example":0},"pSStatementVal":{"type":"string"},"pSStatementDate":{"type":"string"},"pSStatementDateOutput":{"type":"string"},"pSProcessDate":{"type":"string"},"pSProcessDateOutput":{"type":"string"},"pHPatientLstNme":{"type":"string"},"pHPatientFstNme":{"type":"string"},"pHPatientMidNme":{"type":"string"},"pHAddress1":{"type":"string"},"pHAddress2":{"type":"string"},"pHAddress3":{"type":"string"},"pHCity":{"type":"string"},"pHState":{"type":"string"},"pHZipCde":{"type":"string"},"pHZipCdeOutput":{"type":"string"},"pHCtryNme":{"type":"string"},"pHAmtDue":{"type":"integer","example":0},"pHAmtDueOutput":{"type":"string"},"pHPrevBal":{"type":"integer","example":0},"pHPrevBalOutput":{"type":"string"},"pHTotCharges":{"type":"integer","example":0},"pHTotChargesOutput":{"type":"string"},"pHTotCredits":{"type":"integer","example":0},"pHTotCreditsOutput":{"type":"string"},"pHNewBalance":{"type":"integer","example":0},"pHNewBalanceOutput":{"type":"string"},"pHSpecialNotes":{"type":"string"},"pHROParaCdes":{"type":"string"},"pHNumOfLines":{"type":"integer","example":0},"pHDfnNumber":{"type":"integer","example":0},"pHCernerStatementNumber":{"type":"integer","example":0},"pHCernerPatientId":{"type":"string"},"pHCernerAccountNumber":{"type":"string"},"pHIcnNumber":{"type":"string"},"pHAccountNumber":{"type":"integer","example":0},"pHLargeFontIndcator":{"type":"integer","example":0},"details":{"type":"array","items":{"properties":{"pDDatePosted":{"type":"string"},"pDDatePostedOutput":{"type":"string"},"pDTransDesc":{"type":"string"},"pDTransDescOutput":{"type":"string"},"pDTransAmt":{"type":"integer","example":0},"pDTransAmtOutput":{"type":"string"},"pDRefNo":{"type":"string"}}}},"station":{"type":"object","properties":{"facilitYNum":{"type":"string"},"visNNum":{"type":"string"},"facilitYDesc":{"type":"string"},"cyclENum":{"type":"string"},"remiTToFlag":{"type":"string"},"maiLInsertFlag":{"type":"string"},"staTAddress1":{"type":"string"},"staTAddress2":{"type":"string"},"staTAddress3":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"ziPCde":{"type":"string"},"ziPCdeOutput":{"type":"string"},"baRCde":{"type":"string"},"teLNumFlag":{"type":"string"},"teLNum":{"type":"string"},"teLNum2":{"type":"string"},"contacTInfo":{"type":"string"},"dM2TelNum":{"type":"string"},"contacTInfo2":{"type":"string"},"toPTelNum":{"type":"string"},"lbXFedexAddress1":{"type":"string"},"lbXFedexAddress2":{"type":"string"},"lbXFedexAddress3":{"type":"string"},"lbXFedexCity":{"type":"string"},"lbXFedexState":{"type":"string"},"lbXFedexZipCde":{"type":"string"},"lbXFedexBarCde":{"type":"string"},"lbXFedexContact":{"type":"string"},"lbXFedexContactTelNum":{"type":"string"}}}}}},"status":{"type":"integer","example":200}}}}}}},"/v0/medical_copays/{id}":{"get":{"description":"Fetch individual copay statement by id","operationId":"getMedicalCopayById","tags":["medical_copays"],"parameters":[{"$ref":"#/parameters/authorization"}],"responses":{"200":{"description":"Successful copay lookup by id","schema":{"required":["data","status"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"pSSeqNum":{"type":"integer","example":0},"pSTotSeqNum":{"type":"integer","example":0},"pSFacilityNum":{"type":"string"},"pSFacPhoneNum":{"type":"string"},"pSTotStatement":{"type":"integer","example":0},"pSStatementVal":{"type":"string"},"pSStatementDate":{"type":"string"},"pSStatementDateOutput":{"type":"string"},"pSProcessDate":{"type":"string"},"pSProcessDateOutput":{"type":"string"},"pHPatientLstNme":{"type":"string"},"pHPatientFstNme":{"type":"string"},"pHPatientMidNme":{"type":"string"},"pHAddress1":{"type":"string"},"pHAddress2":{"type":"string"},"pHAddress3":{"type":"string"},"pHCity":{"type":"string"},"pHState":{"type":"string"},"pHZipCde":{"type":"string"},"pHZipCdeOutput":{"type":"string"},"pHCtryNme":{"type":"string"},"pHAmtDue":{"type":"integer","example":0},"pHAmtDueOutput":{"type":"string"},"pHPrevBal":{"type":"integer","example":0},"pHPrevBalOutput":{"type":"string"},"pHTotCharges":{"type":"integer","example":0},"pHTotChargesOutput":{"type":"string"},"pHTotCredits":{"type":"integer","example":0},"pHTotCreditsOutput":{"type":"string"},"pHNewBalance":{"type":"integer","example":0},"pHNewBalanceOutput":{"type":"string"},"pHSpecialNotes":{"type":"string"},"pHROParaCdes":{"type":"string"},"pHNumOfLines":{"type":"integer","example":0},"pHDfnNumber":{"type":"integer","example":0},"pHCernerStatementNumber":{"type":"integer","example":0},"pHCernerPatientId":{"type":"string"},"pHCernerAccountNumber":{"type":"string"},"pHIcnNumber":{"type":"string"},"pHAccountNumber":{"type":"integer","example":0},"pHLargeFontIndcator":{"type":"integer","example":0},"details":{"type":"array","items":{"properties":{"pDDatePosted":{"type":"string"},"pDDatePostedOutput":{"type":"string"},"pDTransDesc":{"type":"string"},"pDTransDescOutput":{"type":"string"},"pDTransAmt":{"type":"integer","example":0},"pDTransAmtOutput":{"type":"string"},"pDRefNo":{"type":"string"}}}},"station":{"type":"object","properties":{"facilitYNum":{"type":"string"},"visNNum":{"type":"string"},"facilitYDesc":{"type":"string"},"cyclENum":{"type":"string"},"remiTToFlag":{"type":"string"},"maiLInsertFlag":{"type":"string"},"staTAddress1":{"type":"string"},"staTAddress2":{"type":"string"},"staTAddress3":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"ziPCde":{"type":"string"},"ziPCdeOutput":{"type":"string"},"baRCde":{"type":"string"},"teLNumFlag":{"type":"string"},"teLNum":{"type":"string"},"teLNum2":{"type":"string"},"contacTInfo":{"type":"string"},"dM2TelNum":{"type":"string"},"contacTInfo2":{"type":"string"},"toPTelNum":{"type":"string"},"lbXFedexAddress1":{"type":"string"},"lbXFedexAddress2":{"type":"string"},"lbXFedexAddress3":{"type":"string"},"lbXFedexCity":{"type":"string"},"lbXFedexState":{"type":"string"},"lbXFedexZipCde":{"type":"string"},"lbXFedexBarCde":{"type":"string"},"lbXFedexContact":{"type":"string"},"lbXFedexContactTelNum":{"type":"string"}}}}},"status":{"type":"integer","example":200}}}}}}},"/v0/medical_copays/get_pdf_statement_by_id/{statement_id}":{"get":{"description":"Endpoint to get PDF statement by medical_copay id","operationId":"getPDFStatementsById","tags":["medical_copays"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"The type of letter to be downloaded","required":true,"type":"string"}],"responses":{"200":{"description":"Successful PDF download","schema":{"properties":{"data":{"type":"string","format":"binary"}}}}}}},"/v0/medical_copays/send_statement_notifications":{"post":{"description":"Endpoint to trigger notifications from new statements","operationId":"sendNewStatementsNotifications","tags":["medical_copays"],"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"statements","in":"body","description":"An array of statement data sent as a base64 json file","required":true,"schema":{"type":"array","required":["statements"],"items":{"type":"object","properties":{"veteranIdentifier":{"type":"string","example":"123456789"},"identifierType":{"type":"string","example":"edipi"},"facilityNum":{"type":"string","example":"123"},"facilityName":{"type":"string","example":"VA Medical Center"},"statementDate":{"type":"string","example":"01/01/2023"}}}}}],"responses":{"200":{"description":"New statement notifications sent successfully","schema":{"type":"object","properties":{"status":{"type":"integer","example":200},"message":{"type":"string","example":"Parsing and sending notifications"}}}}}}},"/v0/mvi_users/{id}":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"MVI Orchestrated Search returned a Success response","schema":{"properties":{"message":{"type":"string","example":"Success"}}}}},"summary":"Add user to MVI","description":"Make Orchestrated Search call to the Master Veteran Index (MVI)\n            requesting that MVI make calls to upstream services to find or create the user's\n            CorpDB (Corp) ID, and possibly the user's Beneficiary Identification and Records\n            Locator Subsystem (BIRLS) ID. MVI will save the IDs it discovers to its own database.\n            The Corp and BIRLS IDs are required prerequisites for serving the 21-0966 Intent to File\n            form and 21-526EZ disability claim form to the client.","operationId":"postMviUser","tags":["form_526"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"ID of the form. Allowed values: '21-0966' (Intent to File),\n              '21-526EZ' (Disability Compensation)","required":true,"type":"string"}]}},"/v0/onsite_notifications/{id}":{"patch":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"Record not found","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Onsite notification updated successfully","schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/OnsiteNotification"}}}}},"description":"Update a onsite notification","operationId":"updateOnsiteNotification","tags":["my_va"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"onsite_notification","in":"body","description":"Onsite notification data","required":true,"schema":{"type":"object","required":["onsite_notification"],"properties":{"onsite_notification":{"type":"object","required":["dismissed"],"properties":{"dismissed":{"type":"boolean"}}}}}}],"produces":["application/json"],"consumes":["application/json"]}},"/v0/onsite_notifications":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Array of onsite notifications","schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/definitions/OnsiteNotification"}},"meta":{"$ref":"#/definitions/MetaPagination"}}}}},"description":"List a user's onsite notifications","operationId":"listOnsiteNotification","tags":["my_va"],"produces":["application/json"],"parameters":[{"$ref":"#/parameters/authorization"},{"$ref":"#/parameters/optional_page_number"},{"$ref":"#/parameters/optional_page_length"},{"name":"include_dismissed","in":"query","description":"Whether to include dismissed notifications","required":false,"type":"boolean"}]},"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Onsite notification created successfully","schema":{"type":"object","properties":{"data":{"$ref":"#/definitions/OnsiteNotification"}}}}},"description":"Create an onsite notification","operationId":"addOnsiteNotification","tags":["my_va"],"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use JWT ES256 algorithm to encode payload {user: 'va_notify', iat: send_time, 'exp': send_time + X}\nPut token in the header in the format 'Bearer ${token}'","required":true,"type":"string"},{"name":"onsite_notification","in":"body","description":"Onsite notification data","required":true,"schema":{"type":"object","required":["onsite_notification"],"properties":{"onsite_notification":{"type":"object","required":["template_id","va_profile_id"],"properties":{"template_id":{"type":"string","example":"f9947b27-df3b-4b09-875c-7f76594d766d"},"va_profile_id":{"type":"string","example":"505193"}}}}}}]}},"/v0/my_va/submission_statuses":{"get":{"description":"Get list of submitted forms for the current session","operationId":"getSubmissionStatuses","tags":["my_va"],"parameters":[{"$ref":"#/parameters/authorization"}],"produces":["application/json"],"responses":{"200":{"description":"submitted forms and statuses","schema":{"type":"object","properties":{"data":{"type":"array","items":{"required":["id","type","attributes"],"properties":{"id":{"type":"string","example":"3b03b5a0-3ad9-4207-b61e-3a13ed1c8b80","description":"Form submission UID"},"type":{"type":"string","example":"submission_status","description":"type of request"},"attributes":{"$ref":"#/definitions/SubmissionStatusAttrs"}}}}}}},"296":{"description":"submitted forms but errors occured looking up statuses from lighthouse","schema":{"type":"object","required":["data","errors"],"properties":{"data":{"type":"array","items":{"required":["id","type","attributes"],"properties":{"id":{"type":"string","example":"3b03b5a0-3ad9-4207-b61e-3a13ed1c8b80","description":"Form submission UID"},"type":{"type":"string","example":"submission_status","description":"type of request"},"attributes":{"$ref":"#/definitions/SubmissionStatusAttrs"}}}},"errors":{"type":"array","items":{"required":["status","source","title","detail"],"properties":{"status":{"type":"integer","example":429,"description":"Error code"},"source":{"type":"string","example":"Lighthouse - Benefits Intake API","description":"Error source"},"title":{"type":"string","example":"Form Submission Status: Too Many Requests","description":"Error description"},"detail":{"type":"string","example":"API rate limit exceeded","description":"Error details"}}}}}}}}}},"/v0/form0969":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}}},"description":"Submit a income and assets statement","operationId":"addIncomeAndAssetsClaim","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"form","in":"body","description":"Income and assets statement form data","required":true,"schema":{"type":"string"}}]}},"/pensions/v0/claims":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}}},"description":"Submit a pension benefit claim","operationId":"addPensionClaim","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"form","in":"body","description":"Pension claim form data","required":true,"schema":{"type":"string"}}]}},"/v0/preneeds/cemeteries":{"get":{"description":"Get the cemeteries from EOAS (Eligibility Office Automation System)","operationId":"getCemetaries","tags":["benefits_forms"],"responses":{"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/PreneedCemeteries"}}}}},"/v0/profile/direct_deposits":{"get":{"produces":["application/json"],"consumes":["application/json"],"description":"Get a veterans direct deposit information for comp and pen or education benefits","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}],"responses":{"200":{"description":"Direct deposit information for a users comp and pen or education benefits.","schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"control_information":{"required":["can_update_direct_deposit","is_corp_available","is_edu_claim_available","has_cp_claim","has_cp_award","is_corp_rec_found","has_no_bdn_payments","has_index","is_competent","has_mailing_address","has_no_fiduciary_assigned","is_not_deceased","has_payment_address","has_identity"],"properties":{"can_update_direct_deposit":{"type":"boolean","example":true,"description":"Must be true to view payment account information"},"is_corp_available":{"type":"boolean","example":true,"description":""},"is_edu_claim_available":{"type":"boolean","example":true,"description":"Is true if education claim"},"has_cp_claim":{"type":"boolean","example":true,"description":"Is true if comp and pen claim"},"has_cp_award":{"type":"boolean","example":true,"description":"Is true if comp and pen award"},"is_corp_rec_found":{"type":"boolean","example":true,"description":""},"has_no_bdn_payments":{"type":"boolean","example":true,"description":""},"has_index":{"type":"boolean","example":true,"description":""},"is_competent":{"type":"boolean","example":true,"description":""},"has_mailing_address":{"type":"boolean","example":true,"description":""},"has_no_fiduciary_assigned":{"type":"boolean","example":true,"description":""},"is_not_deceased":{"type":"boolean","example":true,"description":""},"has_payment_address":{"type":"boolean","example":true,"description":""},"has_identity":{"type":"boolean","example":true,"description":""}}},"payment_account":{"required":["name","account_type","account_number","routing_number"],"properties":{"name":{"type":"string","example":"WELLS FARGO BANK","description":"Bank name"},"account_type":{"type":"string","enum":["Checking","Savings"],"example":"Checking","description":"Bank account type"},"account_number":{"type":"string","example":"******7890","description":"Bank account number (masked)"},"routing_number":{"type":"string","example":"*****0503","description":"Bank routing number (masked)"}}}}}}}}}},"400":{"description":"Bad Request","schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"required":["title","detail","code","source"],"properties":{"title":{"type":"string","example":"Invalid field value","description":"Error title"},"detail":{"type":"string","example":"getDirectDeposit.icn size must be between 17 and 17, getDirectDeposit.icn must match \\\"^\\d{10}V\\d{6}$\\\"","description":"Description of error (optional)"},"code":{"type":"string","example":"direct.deposit.icn.invalid","description":"Service name with code appended"},"source":{"type":["string","object"],"example":"Lighthouse Direct Deposit","description":"Service name"}}}}}}},"401":{"description":"Not authorized","schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"required":["title","detail","code","source"],"properties":{"title":{"type":"string","example":"Invalid token.","description":"Error title"},"detail":{"type":["string","null"],"description":"Description of error (optional)"},"code":{"type":"string","example":"direct.deposit.invalid.token","description":"Error code"},"source":{"type":["string","object"],"example":"Lighthouse Direct Deposit","description":"Service name"}}}}}}},"404":{"description":"Not found","schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"required":["title","detail","code","source"],"properties":{"title":{"type":"string","example":"Person for ICN not found","description":"Error title"},"detail":{"type":"string","example":"No data found for ICN","description":"Description of error (optional)"},"code":{"type":"string","example":"direct.deposit.icn.not.found","description":"Service name with code appended"},"source":{"type":["string","object"],"example":"Lighthouse Direct Deposit","description":"Service name"}}}}}}}}},"put":{"produces":["application/json"],"consumes":["application/json"],"description":"Update a veterans direct deposit information for comp and pen or education benefits","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes to update a payment account.","required":true,"schema":{"properties":{"payment_account":{"type":"object","properties":{"account_number":{"type":"string","example":"1234567890"},"account_type":{"type":"string","example":"Checking"},"routing_number":{"type":"string","example":"031000503"}}}}}}],"responses":{"200":{"description":"Direct deposit information for a users comp and pen or education benefits.","schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"control_information":{"required":["can_update_direct_deposit","is_corp_available","is_edu_claim_available","has_cp_claim","has_cp_award","is_corp_rec_found","has_no_bdn_payments","has_index","is_competent","has_mailing_address","has_no_fiduciary_assigned","is_not_deceased","has_payment_address","has_identity"],"properties":{"can_update_direct_deposit":{"type":"boolean","example":true,"description":"Must be true to view payment account information"},"is_corp_available":{"type":"boolean","example":true,"description":""},"is_edu_claim_available":{"type":"boolean","example":true,"description":"Is true if education claim"},"has_cp_claim":{"type":"boolean","example":true,"description":"Is true if comp and pen claim"},"has_cp_award":{"type":"boolean","example":true,"description":"Is true if comp and pen award"},"is_corp_rec_found":{"type":"boolean","example":true,"description":""},"has_no_bdn_payments":{"type":"boolean","example":true,"description":""},"has_index":{"type":"boolean","example":true,"description":""},"is_competent":{"type":"boolean","example":true,"description":""},"has_mailing_address":{"type":"boolean","example":true,"description":""},"has_no_fiduciary_assigned":{"type":"boolean","example":true,"description":""},"is_not_deceased":{"type":"boolean","example":true,"description":""},"has_payment_address":{"type":"boolean","example":true,"description":""},"has_identity":{"type":"boolean","example":true,"description":""}}},"payment_account":{"required":["name","account_type","account_number","routing_number"],"properties":{"name":{"type":"string","example":"WELLS FARGO BANK","description":"Bank name"},"account_type":{"type":"string","enum":["Checking","Savings"],"example":"Checking","description":"Bank account type"},"account_number":{"type":"string","example":"******7890","description":"Bank account number (masked)"},"routing_number":{"type":"string","example":"*****0503","description":"Bank routing number (masked)"}}}}}}}}}},"400":{"description":"Routing number related to fraud","schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"required":["title","detail","code","source"],"properties":{"title":{"type":"string","example":"Bad Request","description":"Error title"},"detail":{"type":"string","example":"Routing number related to potential fraud","description":"Description of error (optional)"},"code":{"type":"string","example":"direct.deposit.routing.number.fraud.message","description":"Service name with code appended"},"source":{"type":["string","object"],"example":"Lighthouse Direct Deposit","description":"Service name"}}}}}}}}}},"/v0/profile/communication_preferences/{communication_permission_id}":{"patch":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Create or update communication permission response","schema":{"type":"object","properties":{"tx_audit_id":{"type":"string"},"status":{"type":"string"},"bio":{"type":"object","properties":{"create_date":{"type":"string"},"update_date":{"type":"string"},"tx_audit_id":{"type":"string"},"source_system":{"type":"string"},"source_date":{"type":"string"},"communication_permission_id":{"type":"integer"},"va_profile_id":{"type":"integer"},"communication_channel_id":{"type":"integer"},"communication_item_id":{"type":"integer"},"communication_channel_name":{"type":"string"},"communication_item_common_name":{"type":"string"},"allowed":{"type":"boolean"}}}}}}},"description":"Update a communication permission","operationId":"updateCommunicationPreference","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"permission_data","in":"body","description":"Communication permission details","required":true,"schema":{"type":"object","required":["communication_item"],"properties":{"communication_item":{"type":"object","required":["id","communication_channel"],"properties":{"id":{"type":"integer"},"communication_channel":{"type":"object","required":["id","communication_permission"],"properties":{"id":{"type":"integer"},"communication_permission":{"type":"object","required":["allowed"],"properties":{"allowed":{"type":"boolean"}}}}}}}}}}],"produces":["application/json"],"consumes":["application/json"]}},"/v0/profile/communication_preferences":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Create or update communication permission response","schema":{"type":"object","properties":{"tx_audit_id":{"type":"string"},"status":{"type":"string"},"bio":{"type":"object","properties":{"create_date":{"type":"string"},"update_date":{"type":"string"},"tx_audit_id":{"type":"string"},"source_system":{"type":"string"},"source_date":{"type":"string"},"communication_permission_id":{"type":"integer"},"va_profile_id":{"type":"integer"},"communication_channel_id":{"type":"integer"},"communication_item_id":{"type":"integer"},"communication_channel_name":{"type":"string"},"communication_item_common_name":{"type":"string"},"allowed":{"type":"boolean"}}}}}}},"description":"Create a communication permission","operationId":"createCommunicationPreference","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"permission_data","in":"body","description":"Communication permission details","required":true,"schema":{"type":"object","required":["communication_item"],"properties":{"communication_item":{"type":"object","required":["id","communication_channel"],"properties":{"id":{"type":"integer"},"communication_channel":{"type":"object","required":["id","communication_permission"],"properties":{"id":{"type":"integer"},"communication_permission":{"type":"object","required":["allowed"],"properties":{"allowed":{"type":"boolean"}}}}}}}}}}],"produces":["application/json"],"consumes":["application/json"]},"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Communication preferences data","schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"communication_groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"communication_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"communication_channels":{"type":"array","items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"default_send_indicator":{"type":"boolean"},"communication_permission":{"type":"object","properties":{"id":{"type":"integer"},"allowed":{"type":"boolean"}}}}}}}}}}}}}}}}}}}},"description":"Get user's communication preferences data","operationId":"getCommunicationPreferences","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}],"produces":["application/json"],"consumes":["application/json"]}},"/v0/profile/address_validation":{"post":{"description":"Outputs address suggestions","operationId":"postVet360AddressValidation","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"address","in":"body","description":"Address input","required":true,"schema":{"type":"object","required":["address"],"properties":{"address":{"$ref":"#/definitions/Vet360AddressSuggestion","required":["address_pou"]}}}}],"produces":["application/json"],"consumes":["application/json"],"responses":{"200":{"description":"Response is OK","schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address":{"$ref":"#/definitions/Vet360AddressSuggestion"},"address_meta_data":{"type":"object","properties":{"confidence_score":{"type":"number"},"address_type":{"type":"string"},"delivery_point_validation":{"type":"string"},"residential_delivery_indicator":{"type":"string"}}}}}}}}}}}},"/v0/profile/addresses/create_or_update":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Create or updates a user's VA profile address","operationId":"changeVaProfileAddress","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"domestic_body","in":"body","description":"Attributes to create a domestic address.","required":true,"schema":{"$ref":"#/definitions/PostVet360DomesticAddress"}},{"name":"international_body","in":"body","description":"Attributes to create an international address.","required":true,"schema":{"$ref":"#/definitions/PostVet360InternationalAddress"}},{"name":"military_overseas_body","in":"body","description":"Attributes to create a military overseas address.","required":true,"schema":{"$ref":"#/definitions/PostVet360MilitaryOverseasAddress"}}]}},"/v0/profile/addresses":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Creates a users Vet360 address","operationId":"postVet360Address","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"domestic_body","in":"body","description":"Attributes to create a domestic address.","required":true,"schema":{"$ref":"#/definitions/PostVet360DomesticAddress"}},{"name":"international_body","in":"body","description":"Attributes to create an international address.","required":true,"schema":{"$ref":"#/definitions/PostVet360InternationalAddress"}},{"name":"military_overseas_body","in":"body","description":"Attributes to create a military overseas address.","required":true,"schema":{"$ref":"#/definitions/PostVet360MilitaryOverseasAddress"}}]},"put":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Updates a users existing Vet360 address","operationId":"putVet360Address","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"domestic_body","in":"body","description":"Attributes to update a domestic address.","required":true,"schema":{"$ref":"#/definitions/PutVet360DomesticAddress"}},{"name":"international_body","in":"body","description":"Attributes to update an international address.","required":true,"schema":{"$ref":"#/definitions/PutVet360InternationalAddress"}},{"name":"military_overseas_body","in":"body","description":"Attributes to update a military overseas address.","required":true,"schema":{"$ref":"#/definitions/PutVet360MilitaryOverseasAddress"}}]},"delete":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Logically deletes a user's existing Vet360 address","operationId":"deleteVet360Address","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"domestic_body","in":"body","description":"Attributes of the domestic address.","required":true,"schema":{"$ref":"#/definitions/PutVet360DomesticAddress"}},{"name":"international_body","in":"body","description":"Attributes of the international address.","required":true,"schema":{"$ref":"#/definitions/PutVet360InternationalAddress"}},{"name":"military_overseas_body","in":"body","description":"Attributes of the military overseas address.","required":true,"schema":{"$ref":"#/definitions/PutVet360MilitaryOverseasAddress"}}]}},"/v0/profile/email_addresses/create_or_update":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Create or update a users VA profile email address","operationId":"changeVaProfileEmailAddress","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes to create an email address.","required":true,"schema":{"$ref":"#/definitions/PostVet360Email"}}]}},"/v0/profile/email_addresses":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Creates a users Vet360 email address","operationId":"postVet360EmailAddress","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes to create an email address.","required":true,"schema":{"$ref":"#/definitions/PostVet360Email"}}]},"put":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Updates a users existing Vet360 email address","operationId":"putVet360EmailAddress","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes to update an email address.","required":true,"schema":{"$ref":"#/definitions/PutVet360Email"}}]},"delete":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Deletes a users existing Vet360 email address","operationId":"deleteVet360EmailAddress","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes of an email address.","required":true,"schema":{"$ref":"#/definitions/PutVet360Email"}}]}},"/v0/profile/full_name":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"first":{"type":"string","example":"Jack"},"middle":{"type":"string","example":"Robert"},"last":{"type":"string","example":"Smith"},"suffix":{"type":"string","example":"Jr."}}}}}}}}},"description":"Gets a users full name with suffix","operationId":"getFullName","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/initialize_vet360_id":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Initializes a vet360_id for the current user","operationId":"initializeVet360Id","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/person/status/{transaction_id}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Gets an updated person transaction by ID","operationId":"getPersonTransactionStatusById","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"transaction_id","in":"path","description":"ID of transaction","required":true,"type":"string"}]}},"/v0/profile/personal_information":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"gender":{"type":"string","example":"M"},"birth_date":{"type":"string","format":"date","example":"1949-03-04"},"preferred_name":{"type":"string","example":"Pat"},"gender_identity":{"type":"object","properties":{"code":{"type":"string","example":"F"},"name":{"type":"string","example":"Female"}}}}}}}}}},"502":{"description":"Unexpected response body","schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"required":["title","detail","code","status","source"],"properties":{"title":{"type":"string","example":"Unexpected response body"},"detail":{"type":"string","example":"MVI service responded without a birthday or a gender."},"code":{"type":"string","example":"MVI_BD502"},"status":{"type":"string","example":"502"},"source":{"type":"string","example":"V0::Profile::PersonalInformationsController"}}}}}}}},"description":"Gets a users gender, birth date, preferred name, and gender identity","operationId":"getPersonalInformation","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/service_history":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["service_history"],"properties":{"service_history":{"type":"array","items":{"required":["branch_of_service","begin_date"],"properties":{"service_type":{"type":"string","example":"Military Service"},"branch_of_service":{"type":"string","example":"Air Force"},"begin_date":{"type":"string","format":"date","example":"2007-04-01"},"end_date":{"type":"string","format":"date","example":"2016-06-01"},"termination_reason_code":{"type":"string","example":"S","description":"S = Separation From Personnel Category, C = Completion of Active Service Period, D = Death while in personnel category or organization, W = Not Applicable"},"termination_reason_text":{"type":"string","example":"Separation from personnel category or organization"},"period_of_service_type_code":{"type":"string","example":"V","description":"Service type code"},"period_of_service_type_text":{"type":"string","example":"Reserve member","description":"Service type text"},"character_of_discharge_code":{"type":"string","example":"DVN","description":"The abbreviated code used to reference the status of a Servicemember upon termination of an episode"}}}},"vet_status_eligibility":{"type":"object","items":{"properties":{"confirmed":{"type":"boolean"},"message":{"type":"array"}}}}}}}}}}},"400":{"description":"_CUF_UNEXPECTED_ERROR","schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"required":["title","detail","code","status","source"],"properties":{"title":{"type":"string","example":"_CUF_UNEXPECTED_ERROR"},"detail":{"type":"string","example":"there was an error encountered processing the Request.  Please retry.  If problem persists, please contact support with a copy of the Response."},"code":{"type":"string","example":"CORE100"},"status":{"type":"string","example":"400"},"source":{"type":"string","example":"V0::Profile::ServiceHistoriesController"}}}}}}}},"description":"Gets a collection of a users military service episodes","operationId":"getServiceHistory","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/status/{transaction_id}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Gets an updated transaction by ID","operationId":"getTransactionStatusById","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"transaction_id","in":"path","description":"ID of transaction","required":true,"type":"string"}]}},"/v0/profile/status/":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionsVet360"}}},"description":"Gets the most recent transactions for a user. Response will include an array of transactions that are still in progress, or that were just updated to COMPLETED during the course of this request. The array will be empty if no transactions are pending or updated. Only the most recent transaction for each profile field will be included so there may be up to 5 (Address, Email, Telephone, Permission, PersonOptions).","operationId":"getTransactionStatusesByUser","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/telephones/create_or_update":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Create or update a users VA profile telephone","operationId":"changeVaProfileTelephone","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes to create a telephone.","required":true,"schema":{"$ref":"#/definitions/PostVet360Telephone"}}]}},"/v0/profile/telephones":{"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Creates a users Vet360 telephone","operationId":"postVet360Telephone","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes to create a telephone.","required":true,"schema":{"$ref":"#/definitions/PostVet360Telephone"}}]},"put":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Updates a users existing telephone","operationId":"putVet360Telephone","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes to update a telephone","required":true,"schema":{"$ref":"#/definitions/PutVet360Telephone"}}]},"delete":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Deletes an existing telephone","operationId":"deleteVet360Telephone","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes of a telephone","required":true,"schema":{"$ref":"#/definitions/PutVet360Telephone"}}]}},"/v0/profile/connected_applications":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"List of OAuth applications you have connected","schema":{"$ref":"#/definitions/ConnectedApplications"}}},"description":"GET OAuth Applications","operationId":"getConnectedApplications","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/connected_applications/{application_id}":{"delete":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"204":{"description":"the connected application's grant have been deleted"}},"description":"Delete grants for OAuth Applications","operationId":"deleteConnectedApplications","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"application_id","in":"path","description":"ID of application","required":true,"type":"string"}]}},"/v0/profile/valid_va_file_number":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/ValidVAFileNumber"}}},"description":"GET returns true false if veteran has a VA file number","operationId":"getValidVAFileNumber","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/payment_history":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/PaymentHistory"}}},"description":"GET returns two arrays. One is payments made, the other is payments returned","operationId":"getPaymentHistory","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/preferred_names":{"put":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/PreferredName"}}},"description":"Adds or updates a users preferred name","operationId":"putPreferredName","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes to update a users preferred name","required":false,"schema":{"$ref":"#/definitions/PutPreferredName"}}]}},"/v0/profile/gender_identities":{"put":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is OK","schema":{"$ref":"#/definitions/GenderIdentity"}}},"description":"Adds or updates a users gender identity","operationId":"putGenderIdentity","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Attributes to update a users gender identity","required":false,"schema":{"$ref":"#/definitions/PutGenderIdentity"}}]}},"/v0/profile/contacts":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Successful request","schema":{"$ref":"#/definitions/Contacts"}}},"description":"Returns a Veteran's Next-of-Kin and Emergency Contacts","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/vet_verification_status":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Confirmation status successfully retrieved.","schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"veteran_status":{"type":"string","example":"not confirmed","description":"Veteran's Title 38 status"},"not_confirmed_reason":{"type":"string","example":"PERSON_NOT_FOUND","description":"Reason for not being confirmed"},"message":{"type":"array","example":"We're sorry. There's a problem...","description":"Alert message to display to user"}}}}}}}}},"description":"Indicates whether an individual is \"Confirmed\" or \"Not Confirmed\" as a Title 38 Veteran according to VA.","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/profile/scheduling_preferences":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Scheduling preferences retrieved successfully","schema":{"$ref":"#/definitions/SchedulingPreferences"}},"403":{"description":"Forbidden - user not in pilot VISN or feature disabled","schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"properties":{"title":{"type":"string","example":"Forbidden"},"detail":{"type":"string","example":"Scheduling preferences not available"},"code":{"type":"string","example":"COMMON_FORBIDDEN"},"status":{"type":"string","example":"403"}}}}}}}},"description":"Gets a Veteran's appointment scheduling preferences","operationId":"getSchedulingPreferences","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"}]},"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Scheduling preferences creation initiated","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Creates scheduling preferences for a specific item","operationId":"createSchedulingPreferences","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Scheduling preference data","required":true,"schema":{"$ref":"#/definitions/SchedulingPreferencesRequest"}}]},"put":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Scheduling preferences update initiated","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Updates scheduling preferences for a specific item","operationId":"updateSchedulingPreferences","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Scheduling preference data","required":true,"schema":{"$ref":"#/definitions/SchedulingPreferencesRequest"}}]},"delete":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Scheduling preferences removal initiated","schema":{"$ref":"#/definitions/AsyncTransactionVet360"}}},"description":"Removes all scheduling preferences from Veteran's profile for a specific item","operationId":"deleteSchedulingPreferences","tags":["profile"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"body","in":"body","description":"Scheduling preference data to remove","required":true,"schema":{"$ref":"#/definitions/SchedulingPreferencesRequest"}}]}},"/v0/search":{"get":{"description":"Returns a list of search results, from Search.gov, for the passed search query","operationId":"getSearchResults","tags":["search"],"parameters":[{"name":"query","in":"query","description":"The search term being queried","required":true,"type":"string"},{"name":"page","in":"query","description":"The page number for the page of results that is being requested","required":false,"type":"integer"}],"responses":{"200":{"description":"Response is OK","schema":{"required":["data","meta"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["body"],"properties":{"body":{"type":"object","properties":{"query":{"type":"string","description":"The term used to generate these search results"},"web":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of results available."},"next_offset":{"type":"integer","description":"Offset for the subsequent results."},"spelling_correction":{"type":["string","null"],"description":"Spelling correction for your search term."},"results":{"type":"array","items":{"properties":{"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"publication_date":{"type":["string","null"]}}}}}},"text_best_bets":{"type":"array","description":"Text best bets, which appear only when the query matches the text of the best bet’s title, description, or keywords.","items":{"properties":{"id":{"type":"integer"},"title":{"type":"string"},"url":{"type":"string"},"description":{"type":"string"}}}},"graphic_best_bets":{"type":"array","description":"Graphic best bets, which appear only when the query matches the text of the best bet’s title, description, or keywords.","items":{"properties":{"id":{"type":"integer"},"title":{"type":"string"},"title_url":{"type":"string"},"image_url":{"type":"string"},"image_alt_text":{"type":"string"},"links":{"type":"array","description":"An array of links in the graphic best bet. Each link contains a title and a URL","items":{"properties":{"title":{"type":"string"},"url":{"type":"string"}}}}}}},"health_topics":{"type":"array","items":{"properties":{"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"related_topics":{"type":"array","description":"An array of topics related to the health topic. Each topic contains a title and a URL","items":{"properties":{"title":{"type":"string"},"url":{"type":"string"}}}},"related_sites":{"type":"array","description":"An array of sites related to the the health topic. Each site contains a title and a URL","items":{"properties":{"title":{"type":"string"},"url":{"type":"string"}}}}}}},"job_openings":{"type":"array","items":{"properties":{"position_title":{"type":"string"},"organization_name":{"type":"string"},"rate_interval_code":{"type":"string"},"minimum":{"type":"integer","description":"Minimum salary of the job opening"},"maximum":{"type":"integer","description":"Maximum salary of the job opening"},"start_date":{"type":"string"},"end_date":{"type":"string"},"url":{"type":"string"},"org_codes":{"type":"string"},"locations":{"type":"array","description":"An array of locations of the job opening","items":{"type":"string"}},"related_sites":{"type":"array","items":{"properties":{"title":{"type":"string"},"url":{"type":"string"}}}}}}},"recent_tweets":{"type":"array","items":{"properties":{"text":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"snippet":{"type":"string"},"screen_name":{"type":"string","description":"Screen name of the tweet author"},"profile_image_url":{"type":"string"}}}},"recent_news":{"type":"array","items":{"properties":{"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"publication_date":{"type":"string"},"source":{"type":"string"}}}},"recent_video_news":{"type":"array","items":{"properties":{"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"publication_date":{"type":"string"},"source":{"type":"string"},"thumbnail_url":{"type":"string"}}}},"federal_register_documents":{"type":"array","items":{"properties":{"id":{"type":"integer"},"document_number":{"type":"string"},"document_type":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"agency_names":{"type":"array","description":"An array of agency names of the federal register document","items":{"type":"string"}},"page_length":{"type":"integer"},"start_page":{"type":"integer"},"end_page":{"type":"integer"},"publication_date":{"type":"string"},"comments_close_date":{"type":"string"}}}},"related_search_terms":{"type":"array","description":"An array of related search terms, which are based on recent, common searches on the your site.","items":{"type":"string"}}}}}}}},"meta":{"properties":{"pagination":{"$ref":"#/definitions/Pagination"}}}}}},"400":{"description":"Error Occurred","schema":{"$ref":"#/definitions/Errors"}},"429":{"description":"Exceeded rate limit","schema":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"required":["title","detail","code","status","source"],"properties":{"title":{"type":"string","example":"Exceeded rate limit"},"detail":{"type":"string","example":"Exceeded Search.gov rate limit"},"code":{"type":"string","example":"SEARCH_429"},"status":{"type":"string","example":"429"},"source":{"type":"string","example":"Search::Service"}}}}}}}}}},"/v0/search_click_tracking/?position={position}&query={query}&url={url}&module_code={module_code}&user_agent={user_agent}":{"post":{"description":"Sends a Click Tracking event to Search.gov analytics","operationId":"sendClickTrackingData","tags":["search_click_tracking"],"parameters":[{"name":"url","in":"path","description":"the url of the link that was clicked","required":true,"type":"string"},{"name":"query","in":"path","description":"the search query used to generate results","required":true,"type":"string"},{"name":"position","in":"path","description":"The position/rank of the result on your search results page. Was it the first result or the second?","required":true,"type":"integer"},{"name":"user_agent","in":"path","description":"the user agent of the user who clicked","required":true,"type":"string"},{"name":"module_code","in":"path","description":"I14Y for web urls, BOOS for best bets, defaults to I14Y","required":true,"type":"string"}],"responses":{"204":{"description":"Empty Response"},"400":{"description":"Error Occurred","schema":{"$ref":"#/definitions/Errors"}}}}},"/v0/sign_in/authorize":{"get":{"description":"Initializes Sign in Service authorization & authentication.","operationId":"getSignInAuthorize","tags":["authentication"],"produces":["text/html"],"consumes":["application/json"],"parameters":[{"name":"type","in":"query","description":"Credential provider selected to authenticate with. Values: `logingov`, `idme`, `mhv`","required":true,"type":"string"},{"name":"client_id","in":"query","description":"Determines cookie (web) vs. API (mobile) authentication. Values: `web`, `mobile`.","required":true,"type":"string"},{"name":"acr","in":"query","description":"Level of authentication requested, dependant on CSP. Values: `loa1`, `loa3`, `ial1`, `ial2`, `min`.","required":true,"type":"string"},{"name":"code_challenge","in":"query","description":"Value created from a `code_verifier` hex that is hash and encoded.","required":true,"type":"string"},{"name":"code_challenge_method","in":"query","description":"Method used to create code_challenge (*must* equal `S256`).","required":true,"type":"string"},{"name":"state","in":"query","description":"Client-provided code that is returned to the client upon successful authentication. Minimum length is 22 characters.","required":false,"type":"string"}],"responses":{"200":{"description":"User is redirected to credential service provider via a frontend form submission.","schema":{"$ref":"#/definitions/CSPAuthFormResponse"}}}}},"/v0/sign_in/callback":{"get":{"description":"Sign in Service authentication callback.","operationId":"getSignInCallback","tags":["authentication"],"produces":["text/html"],"consumes":["application/json"],"parameters":[{"name":"code","in":"query","description":"Authentication code created by the credential provider & used to obtain tokens from them.","required":true,"type":"string"},{"name":"state","in":"query","description":"Encoded payload that includes information passed from vets-api to credential provider in `/authorize` call.","required":true,"type":"string"}],"responses":{"302":{"description":"User object is created in vets-api, then redirected back to client with an authentication code that can be used to obtain tokens. If a `state` param was included in the original `/authorize` request it will be returned here.","schema":{"type":"string","format":"uri","example":"vamobile://login-success?code=0c2d21d3-465b-4054-8030-1d042da4f667&state=d940a929b7af6daa595707d0c99bec57"}}}}},"/v0/sign_in/token":{"post":{"description":"Sign in Service session creation & tokens request.","operationId":"postSignInToken","tags":["authentication"],"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"grant_type","in":"query","description":"Authentication grant type value, must equal `authorization_code`.","required":true,"type":"string"},{"name":"code","in":"query","description":"Authentication code passed to the client through the `code` param in authentication `/callback` redirect.","required":true,"type":"string"},{"name":"code_verifier","in":"query","description":"Original hex that was hashed and SHA256-encoded to create the `code_challenge` used in the `/authenticate` request.","required":true,"type":"string"}],"responses":{"200":{"description":"Authentication code and code_verifier validated, session and tokens created & tokens returned to client.","schema":{"$ref":"#/definitions/TokenResponse"}}}}},"/v0/sign_in/refresh":{"post":{"description":"Sign in Service session & tokens refresh.","operationId":"postSignInRefresh","tags":["authentication"],"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"refresh_token","in":"query","description":"Refresh token string.","required":true,"type":"string"},{"name":"anti_csrf_token","in":"query","description":"Anti CSRF token, used to match `/refresh` calls with the `token` call that generated the refresh token used - currently disabled, this can be ignored.","required":false,"type":"string"}],"responses":{"200":{"description":"Refresh token validated, session updated, new tokens created and returned to client.","schema":{"$ref":"#/definitions/TokenResponse"}}}}},"/v0/sign_in/revoke":{"post":{"description":"Sign in Service session destruction.","operationId":"postSignInRevoke","tags":["authentication"],"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"refresh_token","in":"query","description":"Refresh token string, must be URI-encoded.","required":true,"type":"string"},{"name":"anti_csrf_token","in":"query","description":"Anti CSRF token, used to match `refresh` calls with the `token` call that generated the refresh token used - currently disabled, this can be ignored.","required":false,"type":"string"}],"responses":{"200":{"description":"Refresh token validated & session destroyed, invalidating connected tokens."}}}},"/v0/sign_in/revoke_all_sessions":{"post":{"description":"Sign in Service destruction of all of a user's sessions except the calling session.","operationId":"postSignInRevokeAll","tags":["authentication"],"produces":["application/json"],"consumes":["application/json"],"parameters":[{"$ref":"#/parameters/optional_authorization"}],"responses":{"200":{"description":"Access token validated & included `user_uuid` used to look up & destroy all of the user's sessions except the calling session.","schema":{}}}}},"/v0/sign_in/logout":{"get":{"description":"User-initiated logout of their Sign in Service session.","operationId":"getSignInLogout","tags":["authentication"],"produces":["application/json"],"consumes":["application/json"],"parameters":[{"$ref":"#/parameters/optional_authorization"}],"responses":{"302":{"description":"Access token validated & session destroyed, invalidating connected tokens. User is redirected to credential provider to end their session, then redirect back to VA.gov frontend.","schema":{"$ref":"#/definitions/LogoutRedirectResponse"}}}}},"/v0/sign_in/sessions/{handle}":{"delete":{"description":"Sign in Service destruction of a single session owned by the caller, identified by handle.","operationId":"deleteSignInSession","tags":["authentication"],"produces":["application/json"],"consumes":["application/json"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"handle","in":"path","description":"The handle of the session to destroy. Must be owned by the authenticated caller.","required":true,"type":"string"}],"responses":{"200":{"description":"Access token validated & the session matching the given handle, owned by the caller, was destroyed.","schema":{}}}}},"/travel_pay/v0/claims":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Successfully retrieved claims for a user with pagination information","schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/definitions/TravelPayClaimSummary"}},"metadata":{"type":"object","properties":{"status":{"type":"integer","example":200},"pageNumber":{"type":"integer","example":1},"totalRecordCount":{"type":"integer","example":85}}}}}},"400":{"description":"Bad request made","schema":{"properties":{"error":{"type":"string","example":"Bad Request: Invalid date format"},"correlation_id":{"type":"string","example":"33333333-5555-4444-bbbb-222222444444"}}}}},"description":"Get a list of travel reimbursment claim summaries","operationId":"getTravelPayClaims","tags":["travel_pay"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"start_date","in":"query","description":"The start date of the date range. Defaults to 3 months ago.","required":false,"type":"string"},{"name":"end_date","in":"query","description":"The end date of the date range. Defaults to today.","required":false,"type":"string"},{"name":"page_number","in":"query","description":"Page number to start pagination on. Defaults to 1.","required":false,"type":"integer"}]},"post":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"201":{"description":"Successfully submitted claim for a user","schema":{"$ref":"#/definitions/TravelPayClaimSummary"}}},"description":"Submit a travel reimbursment claim","operationId":"postTravelPayClaim","tags":["travel_pay"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"appointmentDateTime","in":"body","description":"Appointment local start time","required":true,"schema":{"properties":{"appointmentDateTime":{"type":"string"}}}},{"name":"facilityStationNumber","in":"body","description":"Appointment facility ID","required":true,"schema":{"properties":{"facilityStationNumber":{"type":"string"}}}},{"name":"appointmentType","in":"body","description":"CompensationAndPensionExamination or Other","required":true,"schema":{"properties":{"appointmentType":{"type":"string"}}}},{"name":"isComplete","in":"body","description":"Whether or not appointment is complete","required":true,"schema":{"properties":{"isComplete":{"type":"boolean"}}}}]}},"/travel_pay/v0/claims/{id}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Successfully retrieved claim details for a user","schema":{"$ref":"#/definitions/TravelPayClaimDetails"}},"404":{"description":"Missing claim","schema":{"properties":{"errors":{"type":"array","items":{"properties":{"title":{"type":"string"},"detail":{"type":"string"},"code":{"type":"string"},"status":{"type":"string"}}}}}}}},"description":"Get a single travel reimbursment claim details","operationId":"getTravelPayClaimById","tags":["travel_pay"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"id","in":"path","description":"The non-PII/PHI id of a claim (UUID - any version)","required":true,"type":"string"}]}},"/travel_pay/v0/claims/{claimId}/documents/{docId}":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"Record not found","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Successfully retrieved claim details for a user","schema":{"$ref":"#/definitions/TravelPayDocumentBinary"}}},"description":"Get a document binary","operationId":"getTravelPayDocumentBinary","tags":["travel_pay"],"parameters":[{"$ref":"#/parameters/authorization"},{"name":"claimId","in":"path","description":"The non-PII/PHI id of a claim (UUID - any version)","required":true,"type":"string"},{"name":"docId","in":"path","description":"The non-PII/PHI id of a document (UUID - any version)","required":true,"type":"string"}]}},"/v0/upload_supporting_evidence":{"post":{"responses":{"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/Errors"}},"422":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Response is ok","schema":{"$ref":"#/definitions/UploadSupportingEvidence"}}},"description":"Upload a pdf or image file containing supporting evidence for form 526","operationId":"uploadSupportingEvidence","tags":["form_526"],"parameters":[{"name":"supporting_evidence_attachment","in":"body","description":"Object containing file name","required":true,"schema":{"required":["file_data"],"properties":{"file_data":{"type":"string","example":"filename.pdf"},"password":{"type":"string","example":"My Password"},"attachment_id":{"type":"string","example":"L1839","description":"Optional attachment identifier to enable OCR-based document validation (currently supports L1839)"}}}}]}},"/v0/user":{"get":{"responses":{"401":{"description":"Not authorized","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"get user response","schema":{"$ref":"#/definitions/UserData"}},"296":{"description":"Get user data with some external service errors","schema":{"allOf":[{"$ref":"#/definitions/UserInternalServices"},{"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"account":{"type":["object","null"]},"va_profile":{"type":["object","null"]},"veteran_status":{"type":["object","null"]},"vet360_contact_information":{"type":["object","null"]}}}}},"meta":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"properties":{"external_service":{"type":"string"},"start_time":{"type":"string"},"end_time":{"type":["string","null"]},"description":{"type":"string"},"status":{"type":"integer"}}}}}}}}]}}},"description":"Get user data","operationId":"getUser","tags":["user"],"parameters":[{"$ref":"#/parameters/authorization"}]}},"/v0/caregivers_assistance_claims":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"description":"Number of pages contained in the form","type":"string","example":""},"type":{"description":"This is always \"form1010cg_submissions\"","type":"string","example":"form1010cg_submissions"}}}}}}},"description":"Submit a 10-10CG form (Application for the Program of Comprehensive Assistance for Family Caregivers)","tags":["benefits_forms"],"parameters":[{"name":"form","in":"body","description":"The application's submission data (formatted in compliance with the 10-10CG schema).","required":true,"schema":{"type":"string"}}]}},"/v0/caregivers_assistance_claims/facilities":{"post":{"description":"Get a list of medical facilities based on search criteria.","tags":["benefits_forms"],"parameters":[{"name":"zip","in":"query","description":"The zip code for facility search.","type":"string"},{"name":"state","in":"query","description":"The state for facility search.","type":"string"},{"name":"lat","in":"query","description":"The latitude for facility search.","type":"number"},{"name":"long","in":"query","description":"The longitude for facility search.","type":"number"},{"name":"radius","in":"query","description":"The radius around the location for facility search.","type":"number"},{"name":"page","in":"query","description":"The page of results to retrieve.","type":"integer"},{"name":"per_page","in":"query","description":"The number of facilities per page.","type":"integer"},{"name":"facilityIds","in":"query","description":"Comma-separated list of facility IDs to filter by.","type":"string"}],"responses":{"200":{"description":"List of facilities retrieved successfully","schema":{"$ref":"#/definitions/Facilities"}}}}},"/v0/caregivers_assistance_claims/download_pdf":{"post":{"description":"Download a pre-filled 10-10CG PDF form.","tags":["benefits_forms"],"parameters":[{"name":"claim_id","in":"query","description":"The ID of the claim to download the PDF for.","required":true,"type":"string"}],"responses":{"200":{"description":"PDF form download","schema":{"properties":{"data":{"type":"string","format":"binary"}}}}}}},"/v0/education_career_counseling_claims":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}}},"description":"Submit a '28-8832' to central mail for career counseling","operationId":"requestCareerCounseling","tags":["central_mail_claim"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"form","in":"body","description":"Dependency claim form data","required":true,"schema":{"type":"string"}}]}},"/v0/veteran_readiness_employment_claims":{"post":{"responses":{"422":{"description":"Failed model validation(s)","schema":{"$ref":"#/definitions/Errors"}},"200":{"description":"Form Submitted","schema":{"$ref":"#/definitions/SavedForm"}}},"description":"Submit an employment readiness claim (CH31)/28-1900","operationId":"adVeteranReadinessEmploymentClaim","tags":["benefits_forms"],"parameters":[{"$ref":"#/parameters/optional_authorization"},{"name":"form","in":"body","description":"Veteran Readiness Employment Claim form data","required":true,"schema":{"type":"string"}}]}},"/v0/veteran_status_card":{"get":{"description":"Retrieve a user Veteran Status Card","operationId":"veteranStatusCard","tags":["veteran_status_card"],"parameters":[{"$ref":"#/parameters/authorization"}],"responses":{"200":{"description":"Successful veteran status card retrieval","schema":{"required":["type","attributes"],"properties":{"type":{"type":"string","enum":["veteran_status_card","veteran_status_alert"],"description":"'veteran_status_card' or 'veteran_status_alert' depending on the vet eligibility"},"attributes":{"type":"object","required":["veteran_status","confirmation_status","service_summary_code"],"description":"Displays data specific to either 'confirmed' or 'not confirmed' veteran status card","properties":{"full_name":{"type":["string","null"],"description":"The concatenated full name of the veteran, displayed when eligible for a status card","example":"John T Doe Jr"},"disability_rating":{"type":["integer","null"],"description":"The disability rating for the veteran when eligible for a status card","example":50},"edipi":{"type":["string","null"],"description":"The user's EDIPI number when eligible for a veteran status card","example":"001001999"},"header":{"type":["string","null"],"description":"Displays an error/warning title when the veteran is ineligible for a status card","example":"You're not eligible for a Veteran Status Card"},"body":{"type":["array","null"],"description":"A list of message components to display when the veteran is ineligible for a status card","items":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["text","phone","link"],"description":"The type of message component - can be 'text', 'phone', or 'link'","example":"text"},"value":{"type":"string","description":"The content to be displayed based on the data type","example":"Your record is missing information about your service history or discharge status."},"tty":{"type":["boolean","null"],"description":"An optional parameter when data type is 'phone' to signify TTY","example":true},"url":{"type":["string","null"],"description":"When data type is 'link', this field contains the hyperlink","example":"https://www.va.gov"}}}},"alert_type":{"type":["string","null"],"enum":["error","warning"],"description":"The type of alert - can either be 'error' or 'warning'","example":"warning"},"veteran_status":{"type":"string","enum":["confirmed","not confirmed"],"description":"'confirmed' or 'not confirmed' depending on if the veteran is eligible for a status card","example":"confirmed"},"not_confirmed_reason":{"type":["string","null"],"enum":["ERROR","MORE_RESEARCH_REQUIRED","NOT_TITLE_38","PERSON_NOT_FOUND"],"description":"Displays the reason the veteran is not eligible for a status card","example":"PERSON_NOT_FOUND"},"confirmation_status":{"type":"string","enum":["DISCHONORABLE_SSC","INELIGIBLE_SSC","UNKNOWN_SSC","EDIPI_NO_PNL_SSC","CURRENTLY_SERVING_SSC","ERROR_SSC","UNCAUGHT_SSC","UNKNOWN_REASON","NO_SSC_CHECK","AD_DSCH_VAL_SSC","AD_VAL_PREV_QUAL_SSC","AD_VAL_PREV_RES_GRD_SSC","AD_UNCHAR_DSCH_SSC","VAL_PREV_QUAL_SSC"],"description":"Displays the confirmation status of the veteran","example":"INELIGIBLE_SSC_CODE"},"service_summary_code":{"type":"string","description":"The veteran's Service Summary Code determined by VAProfile","example":"A5"}}}}}}}}}},"definitions":{"CaveIntakeRequest":{"required":["pdf_b64","file_name"],"properties":{"pdf_b64":{"type":"string","description":"Base64-encoded PDF contents to submit to the document processing pipeline","example":"JVBERi0xLjQKJcfs..."},"file_name":{"type":"string","description":"Original filename forwarded to the upstream intake service","example":"test.pdf"}}},"CaveIntakeResponse":{"required":["id"],"properties":{"id":{"type":"string","example":"abc123"}}},"CaveStatusResponse":{"required":["scan_status"],"description":"Envelope-bearing CAVE response. `scan_status` is the shared failure contract and is\nalways one of four values. ALL four are returned as HTTP 200 with this body; the\nfailure/partial-success is conveyed in the body (not via an HTTP error status) so the\nfrontend poller can stop on a terminal `scan_status`:\n  - `pending`               processing has not finished\n  - `completed`             processing succeeded\n  - `completed_with_errors` processing finished but returned recoverable `warnings`\n  - `failed`                processing failed (terminal); `error` describes the failure\n\nHTTP 502 is reserved for transport-level problems (upstream unreachable/error) and for\na missing/unrecognized `scan_status` or malformed payload — never for a valid `failed`.\n","properties":{"id":{"type":"string","example":"abc123"},"scan_status":{"type":"string","enum":["pending","completed","completed_with_errors","failed"],"example":"completed"},"error":{"type":"object","description":"Present when scan_status is `failed`; describes the failure.","properties":{"scan_status":{"type":"string","example":"failed"},"step":{"type":"string","example":"classification"},"error_type":{"type":"string","example":"processing_error"},"error_message":{"type":"string","example":"Unable to classify document"}}},"warnings":{"type":"array","description":"Present when scan_status is `completed_with_errors`; recoverable issues.","items":{"type":"object","properties":{"step":{"type":"string","example":"extraction"},"warning_type":{"type":"string","example":"low_confidence_field"},"warning_message":{"type":"string","example":"Low confidence on DATE_OF_BIRTH"}}}}}},"CaveOutputResponse":{"description":"Extracted `forms` payload from the upstream document processor. Payload shape varies by\ndocument type. Unlike CaveStatusResponse this is NOT the doc-status envelope: it carries\nno top-level `scan_status`. vets-api validates the payload shape (a non-empty object) and\nreturns HTTP 502 if the upstream returns an unusable body.\n","properties":{"forms":{"type":"array","items":{"properties":{"mmsFormValidationId":{"type":"string","example":"form-kvp-123"},"mmsArtifactValidationId":{"type":"string","example":"artifact-kvp-456"}}}}}},"CaveKeyValuePayload":{"description":"Arbitrary JSON object associated with a KVP identifier.","properties":{"FIRST_NAME":{"type":"string","example":"Ada"},"LAST_NAME":{"type":"string","example":"Lovelace"}}},"CaveDiffRequest":{"required":["lhs","rhs"],"properties":{"lhs":{"type":"object","description":"Original JSON object to compare"},"rhs":{"type":"object","description":"Updated JSON object to compare"}}},"CaveDiffResponse":{"required":["is_different","diff"],"properties":{"is_different":{"type":"boolean","example":true},"diff":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"object","properties":{"lhs":{"type":"string","example":"jee"},"rhs":{"type":"string","example":"john"},"is_different":{"type":"boolean","example":true}}}}}}}},"CaveServiceUnavailable":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/Error"}}}},"ClaimDocumentInput":{"required":["file","document_type"],"properties":{"file":{"type":"string"},"tracked_item_id":{"type":"string"},"password":{"type":"string","example":"My Password!"},"document_type":{"type":"string","example":"L023","enum":["1489","L014","L015","L018","L023","L029","L033","L034","L037","L048","L049","L051","L070","L102","L107","L115","L117","L133","L139","L149","L159","L222","L228","L229","L418","L450","L451","L478","L702","L703","L827","L1489","L1839"]}}},"ClaimLetter":{"properties":{"document_id":{"type":"string","pattern":"^{[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}}$"},"series_id":{"type":"string","pattern":"^{[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}}$"},"version":{"type":"string"},"type_description":{"type":"string"},"type_id":{"type":"string"},"doc_type":{"type":"string"},"subject":{"type":["string","null"]},"received_at":{"type":"string"},"source":{"type":"string"},"mime_type":{"type":"string"},"alt_doc_types":{"type":"string"},"restricted":{"type":"boolean"},"upload_date":{"type":"string"}}},"DigitalDisputeMetadata":{"required":["disputes"],"properties":{"disputes":{"type":"array","items":{"required":["composite_debt_id","deduction_code","original_ar","current_ar","benefit_type","dispute_reason"],"properties":{"composite_debt_id":{"type":"string","description":"Composite debt identifier"},"deduction_code":{"type":"string","description":"Deduction code"},"original_ar":{"type":"number","description":"Original accounts receivable amount"},"current_ar":{"type":"number","description":"Current accounts receivable amount"},"benefit_type":{"type":"string","description":"Type of benefit associated with the debt"},"dispute_reason":{"type":"string","description":"Reason for disputing the debt"},"rcvbl_id":{"type":"integer","description":"Receivable ID (optional)"}}}}}},"EducationBenefitsClaimInput":{"required":["form"],"properties":{"form":{"type":"string","description":"Should conform to vets-json-schema (https://va.ghe.com/software/vets-json-schema)"}}},"EducationBenefitsClaimData":{"required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"form":{"type":"string"},"submitted_at":{"type":"string"},"regional_office":{"type":"string"},"confirmation_number":{"type":"string"}}}}}}},"Form1010EzrSubmissionResponse":{"required":["formSubmissionId","timestamp","success"],"properties":{"formSubmissionId":{"type":["integer","null"],"example":null},"timestamp":{"type":["string","null"],"example":null},"success":{"type":"boolean"}}},"fullName":{"type":"object","properties":{"first":{"type":"string","example":"John","maxLength":12},"middle":{"type":["string","null"],"example":"A","maxLength":1},"last":{"type":"string","example":"Doe","maxLength":18}}},"simpleAddress":{"type":"object","properties":{"street":{"type":"string","example":"123 Main St","maxLength":30},"street2":{"type":["string","null"],"example":"Apt 4","maxLength":5},"city":{"type":"string","example":"Springfield","maxLength":18},"state":{"type":"string","example":"IL","maxLength":2},"postalCode":{"type":"string","example":"62701","maxLength":9},"country":{"type":"string","example":"US","maxLength":3}}},"HealthCareApplicationSubmissionResponse":{"required":["formSubmissionId","timestamp","success"],"properties":{"formSubmissionId":{"type":"integer"},"timestamp":{"type":"string"},"success":{"type":"boolean"}}},"HealthCareApplicationHealthcheckResponse":{"required":["formSubmissionId","timestamp"],"properties":{"formSubmissionId":{"type":"integer"},"timestamp":{"type":"string"}}},"InProgressFormShowResponse":{"properties":{"formData":{"type":"object"},"metadata":{"type":"object"}}},"InProgressFormResponse":{"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"formId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"metadata":{"type":"object"}}}}}}},"InProgressFormsResponse":{"properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"formId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"metadata":{"type":"object"}}}}}}}},"SubmissionStatusAttrs":{"type":"object","description":"submitted form attributes","properties":{"id":{"type":"string","example":"3b03b5a0-3ad9-4207-b61e-3a13ed1c8b80","description":"Submitted form UID from lighthouse"},"detail":{"type":["string","null"],"example":"","description":"Error details (only when errors are present)"},"form_type":{"type":"string","example":"21-0845","description":"The type of form"},"message":{"type":["string","null"],"example":"Descriptive message"},"status":{"type":["string","null"],"enum":[null,"pending","uploaded","received","processing","success","vbms","error","expired"],"example":"received","description":"The current status of the submission"},"created_at":{"type":"string","example":"2023-12-15T20:40:47.583Z","description":"The submission record created in VA.gov"},"updated_at":{"type":["string","null"],"example":"2023-12-15T20:40:54.474Z","description":"The last time the submission status was updated"},"pdf_support":{"type":"boolean","example":true,"description":"True if submission supports archived pdf downloads"}}},"PreneedAddress":{"properties":{"street":{"type":"string","example":"140 Rock Creek Church Rd NW"},"street2":{"type":"string","example":""},"city":{"type":"string","example":"Washington"},"country":{"type":"string","example":"USA"},"state":{"type":"string","example":"DC"},"postalCode":{"type":"string","example":"20011"}}},"PreneedName":{"properties":{"first":{"type":"string","example":"Jon"},"middle":{"type":"string","example":"Bob"},"last":{"type":"string","example":"Doe"},"suffix":{"type":"string","example":"Jr."},"maiden":{"type":"string","example":"Smith"}}},"PreneedCemeteryAttributes":{"properties":{"cemetery_id":{"type":"string","example":"915","description":"the same cemetary id again"},"cemetery_type":{"type":"string","example":"N","enum":["N","S","I","A","M"]},"name":{"type":"string","example":"ABRAHAM LINCOLN NATIONAL CEMETERY"},"num":{"type":"string","example":"915","description":"the same cemetary id yet again, why not?"}}},"PreneedCemeteries":{"required":["data"],"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string","example":"915","description":"the cemetary id"},"type":{"type":"string","example":"preneeds_cemeteries"},"attributes":{"type":"object","$ref":"#/definitions/PreneedCemeteryAttributes"}}}}}},"UserData":{"required":["data","meta"],"allOf":[{"$ref":"#/definitions/Vet360ContactInformation"},{"$ref":"#/definitions/UserInternalServices"},{"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"account":{"type":"object","properties":{"account_uuid":{"type":["string","null"],"example":"b2fab2b5-6af0-45e1-a9e2-394347af91ef","description":"A UUID correlating all user identifiers. Intended to become the user's UUID."}}},"va_profile":{"type":"object","properties":{"status":{"type":"string"},"birthdate":{"type":"string"},"family_name":{"type":"string"},"gender":{"type":"string"},"is_cerner_patient":{"type":"boolean"},"facilities":{"type":"array","items":{"required":["facility_id","is_cerner"],"properties":{"facility_id":{"type":"string"},"is_cerner":{"type":"boolean"}}}},"given_names":{"type":"array","items":{"type":"string"}},"va_patient":{"type":"boolean"},"mhv_account_state":{"type":"string","enum":["OK","DEACTIVATED","MULTIPLE","NONE"],"example":"OK","description":"DEACTIVATED: user has at least one MHV id that is not active; NONE: user has no active MHV ids; MULTIPLE: user has multiple active MHV ids; OK: user has one MHV id and its active"},"user_at_pretransitioned_oh_facility":{"type":"boolean","example":true,"description":"Indicates whether the user is associated with a facility that is pre-transitioned to Oracle Health."},"user_facility_ready_for_info_alert":{"type":"boolean","example":false,"description":"Indicates whether the user's facility is ready for the blue informational alert about Oracle Health."},"user_facility_migrating_to_oh":{"type":"boolean","example":false,"description":"Indicates whether the user is associated with a facility that is migrating to Oracle Health."}}},"veteran_status":{"type":"object","required":["status"],"properties":{"is_veteran":{"type":"boolean","example":true},"status":{"type":"string","enum":["OK","NOT_AUTHORIZED","NOT_FOUND","SERVER_ERROR"],"example":"OK"},"served_in_military":{"type":"boolean","example":true}}}}}}},"meta":{"type":"object","required":["errors"],"properties":{"errors":{"type":"null"}}}}}]},"Address":{"type":"object","properties":{"address_line_one":{"type":"string"},"address_line_two":{"type":"string"},"address_line_three":{"type":"string"},"city":{"type":"string"},"state_or_province":{"type":"string"},"zip_or_postal_code":{"type":"string"},"country_name":{"type":"string"}}},"Appeals":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object"}}}},"AppealsErrors":{"type":"object","items":{"type":"object","properties":{"title":{"type":"string"},"detail":{"type":"string"}}}},"nodContestableIssues":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","description":"A contestable issue (to contest this, you include it as a RequestIssue when creating a HigherLevelReview, SupplementalClaim, or Appeal)","properties":{"type":{"type":"string","enum":["contestableIssue"]},"id":{"type":["string","null"]},"attributes":{"type":"object","properties":{"ratingIssueReferenceId":{"type":["string","null"],"description":"RatingIssue ID"},"ratingIssueProfileDate":{"type":["string","null"],"format":"date","description":"(yyyy-mm-dd) RatingIssue profile date"},"ratingIssueDiagnosticCode":{"type":["string","null"],"description":"RatingIssue diagnostic code"},"ratingDecisionReferenceId":{"type":["string","null"],"description":"The BGS ID for the contested rating decision. This may be populated while ratingIssueReferenceId is nil"},"decisionIssueId":{"type":["integer","null"],"description":"DecisionIssue ID"},"approxDecisionDate":{"type":["string","null"],"format":"date","description":"(yyyy-mm-dd) Approximate decision date"},"description":{"type":["string","null"],"description":"Description"},"rampClaimId":{"type":["string","null"],"description":"RampClaim ID"},"titleOfActiveReview":{"type":["string","null"],"description":"Title of DecisionReview that this issue is still active on"},"sourceReviewType":{"type":["string","null"],"description":"The type of DecisionReview (HigherLevelReview, SupplementalClaim, Appeal) the issue was last decided on (if any)"},"timely":{"type":"boolean","description":"An issue is timely if the receipt date is within 372 dates of the decision date."},"latestIssuesInChain":{"type":"array","description":"Shows the chain of decision and rating issues that preceded this issue. Only the most recent issue can be contested (the object itself that contains the latestIssuesInChain attribute).","items":{"type":"object","properties":{"id":{"type":["string","null","integer"]},"approxDecisionDate":{"type":["string","null"],"format":"date"}}}},"ratingIssueSubjectText":{"type":["string","null"],"description":"Short description of RatingIssue"},"ratingIssuePercentNumber":{"type":["string","null"],"description":"Numerical rating for RatingIssue"},"isRating":{"type":"boolean","description":"Whether or not this is a RatingIssue"}}}}}}},"example":{"data":[{"type":"contestableIssue","id":"string","attributes":{"ratingIssueReferenceId":"string","ratingIssueProfileDate":"2020-08-31","ratingIssueDiagnosticCode":"string","ratingDecisionReferenceId":"string","decisionIssueId":0,"approxDecisionDate":"2020-08-31","description":"string","rampClaimId":"string","titleOfActiveReview":"string","sourceReviewType":"string","timely":true,"latestIssuesInChain":[{"id":19,"approxDecisionDate":"2020-08-31"}],"ratingIssueSubjectText":"string","ratingIssuePercentNumber":"string","isRating":true}}]}},"AsyncTransactionVet360":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"transaction_status":{"type":"string","enum":["REJECTED","RECEIVED","RECEIVED_ERROR_QUEUE","RECEIVED_DEAD_LETTER_QUEUE","COMPLETED_SUCCESS","COMPLETED_NO_CHANGES_DETECTED","COMPLETED_FAILURE"],"example":"RECEIVED"},"transaction_id":{"type":"string","example":"786efe0e-fd20-4da2-9019-0c00540dba4d"},"type":{"type":"string","enum":["AsyncTransaction::VAProfile::AddressTransaction","AsyncTransaction::VAProfile::EmailTransaction","AsyncTransaction::VAProfile::InitializePersonTransaction","AsyncTransaction::VAProfile::PermissionTransaction","AsyncTransaction::VAProfile::TelephoneTransaction","AsyncTransaction::VAProfile::PersonOptionsTransaction"],"example":"AsyncTransaction::VAProfile::EmailTransaction"},"metadata":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"CORE103"},"key":{"type":"string","example":"_CUF_NOT_FOUND"},"severity":{"type":"string","example":"ERROR"},"text":{"type":"string","example":"The tx for id/criteria XZY could not be found."}}}}}}}}}},"AsyncTransactionsVet360":{"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"transaction_status":{"type":"string","enum":["REJECTED","RECEIVED","RECEIVED_ERROR_QUEUE","RECEIVED_DEAD_LETTER_QUEUE","COMPLETED_SUCCESS","COMPLETED_NO_CHANGES_DETECTED","COMPLETED_FAILURE"],"example":"RECEIVED"},"transaction_id":{"type":"string","example":"786efe0e-fd20-4da2-9019-0c00540dba4d"},"type":{"type":"string","enum":["AsyncTransaction::VAProfile::AddressTransaction","AsyncTransaction::VAProfile::EmailTransaction","AsyncTransaction::VAProfile::InitializePersonTransaction","AsyncTransaction::VAProfile::PermissionTransaction","AsyncTransaction::VAProfile::TelephoneTransaction","AsyncTransaction::VAProfile::PersonOptionsTransaction"],"example":"AsyncTransaction::VAProfile::AddressTransaction"},"metadata":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"CORE103"},"key":{"type":"string","example":"_CUF_NOT_FOUND"},"severity":{"type":"string","example":"ERROR"},"text":{"type":"string","example":"The tx for id/criteria XZY could not be found."}}}}}}}}}}},"FailedEvidenceSubmission":{"description":"A failed evidence submission record","properties":{"acknowledgement_date":{"type":["string","null"],"example":"2023-03-15"},"claim_id":{"type":"integer","example":600383363},"created_at":{"type":"string","example":"2023-03-14T10:30:00Z"},"delete_date":{"type":["string","null"],"example":"2023-06-14"},"document_type":{"type":"string","example":"L023"},"failed_date":{"type":"string","example":"2023-03-14"},"file_name":{"type":"string","example":"medical_records.pdf"},"id":{"type":"integer","example":12345},"lighthouse_upload":{"type":"boolean","example":true},"tracked_item_id":{"type":["integer","null"],"example":395084},"tracked_item_display_name":{"type":["string","null"],"example":"21-4142/21-4142a"},"upload_status":{"type":"string","example":"FAILED"},"va_notify_status":{"type":["string","null"],"example":"permanent-failure"}}},"BenefitsClaimDetail":{"description":"Detailed claim data including tracked items","properties":{"id":{"type":"string","description":"Claim ID","example":"600383363"},"type":{"type":"string","example":"claim"},"attributes":{"type":"object","properties":{"claimTypeCode":{"type":["string","null"],"example":"020NEW"},"claimDate":{"type":["string","null"],"example":"2022-09-27"},"claimPhaseDates":{"type":"object","properties":{"phaseChangeDate":{"type":["string","null"],"example":"2022-09-30"},"currentPhaseBack":{"type":"boolean","example":false},"latestPhaseType":{"type":["string","null"],"example":"GATHERING_OF_EVIDENCE"},"previousPhases":{"type":"object"}}},"claimType":{"type":["string","null"],"example":"Compensation"},"closeDate":{"type":["string","null"],"example":"2023-05-15"},"contentions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Tinnitus (New)"}}}},"decisionLetterSent":{"type":"boolean","example":false},"developmentLetterSent":{"type":"boolean","example":true},"documentsNeeded":{"type":"boolean","example":true},"endProductCode":{"type":["string","null"],"example":"020"},"evidenceWaiverSubmitted5103":{"type":"boolean","example":false},"errors":{"type":"array","items":{"type":"object"}},"jurisdiction":{"type":["string","null"],"example":"National Work Queue"},"lighthouseId":{"type":["string","null"],"example":"600383363"},"maxEstClaimDate":{"type":["string","null"],"example":"2023-08-14"},"minEstClaimDate":{"type":["string","null"],"example":"2023-03-22"},"status":{"type":["string","null"],"example":"EVIDENCE_GATHERING_REVIEW_DECISION"},"submitterApplicationCode":{"type":["string","null"],"example":"VBMS"},"submitterRoleCode":{"type":["string","null"],"example":"VBA"},"tempJurisdiction":{"type":["string","null"],"example":"Louisville, KY"},"canUpload":{"type":"boolean","example":true,"description":"Whether the user can upload documents to this claim"},"displayTitle":{"type":["string","null"],"description":"Generated display title for the claim","example":"Disability Compensation Claim"},"claimTypeBase":{"type":["string","null"],"description":"Base claim type used for title generation","example":"Compensation"},"uploadMetadata":{"type":"object","description":"Upload routing metadata used by clients to choose upload destination and payload","properties":{"uploadDestinationKey":{"type":"string","example":"benefits_claims"},"formId":{"type":["string","null"],"example":"10-10D-EXTENDED"},"finalizeDestinationKey":{"type":["string","null"],"example":"ivc_champva_docs_only_resubmission"},"submissionType":{"type":["string","null"],"example":"existing"},"acceptedFileTypes":{"type":"array","description":"Optional list of accepted file extensions for this upload destination","items":{"type":"string","example":"pdf"}},"documentTypeOptions":{"type":"array","description":"Optional list of provider-specific document type choices for uploader dropdowns","items":{"type":"object","properties":{"value":{"type":"string","example":"Birth certificate"},"label":{"type":"string","example":"Birth certificate"}}}}}},"supportingDocuments":{"type":"array","items":{"$ref":"#/definitions/SupportingDocument"}},"trackedItems":{"type":"array","description":"List of evidence requests (tracked items) for this claim","items":{"$ref":"#/definitions/TrackedItem"}},"evidenceSubmissions":{"type":"array","description":"List of evidence submissions for this claim","items":{"$ref":"#/definitions/EvidenceSubmission"}}}}}},"EvidenceSubmission":{"description":"An evidence submission record for a claim","properties":{"acknowledgement_date":{"type":["string","null"],"example":"2023-03-15"},"claim_id":{"type":"integer","example":600383363},"created_at":{"type":"string","example":"2023-03-14T10:30:00Z"},"delete_date":{"type":["string","null"],"example":"2023-06-14"},"document_type":{"type":["string","null"],"example":"L023"},"failed_date":{"type":["string","null"],"example":"2023-03-14"},"file_name":{"type":["string","null"],"example":"medical_records.pdf"},"id":{"type":"integer","example":12345},"lighthouse_upload":{"type":"boolean","example":true},"tracked_item_id":{"type":["integer","null"],"example":395084},"tracked_item_display_name":{"type":["string","null"],"example":"21-4142/21-4142a"},"tracked_item_friendly_name":{"type":["string","null"],"example":"Authorization to disclose information"},"upload_status":{"type":["string","null"],"example":"SUCCESS"},"va_notify_status":{"type":["string","null"],"example":"delivered"}}},"SupportingDocument":{"description":"A supporting document uploaded for a claim","properties":{"documentId":{"type":["string","null"],"example":"{7AF4C5E0-EBCE-49B2-9544-999ECA2904FD}"},"documentTypeLabel":{"type":["string","null"],"example":"Medical Treatment Record - Non-Government Facility"},"originalFileName":{"type":["string","null"],"example":"medical_records.pdf"},"trackedItemId":{"type":["integer","null"],"example":360053},"uploadDate":{"type":["string","null"],"example":"2022-10-11"}}},"TrackedItem":{"description":"An evidence request (tracked item) for a claim","properties":{"id":{"type":"integer","example":395084,"description":"Tracked item ID"},"displayName":{"type":["string","null"],"example":"21-4142/21-4142a","description":"Display name of the tracked item"},"description":{"type":["string","null"],"example":"Please complete and return the enclosed VA Form 21-4142.","description":"Description of what is needed"},"status":{"type":["string","null"],"description":"Current status of the tracked item","enum":["ACCEPTED","INITIAL_REVIEW_COMPLETE","NEEDED_FROM_YOU","NEEDED_FROM_OTHERS","NO_LONGER_REQUIRED","SUBMITTED_AWAITING_REVIEW"],"example":"NEEDED_FROM_YOU"},"overdue":{"type":"boolean","example":false},"requestedDate":{"type":["string","null"],"example":"2023-03-16"},"receivedDate":{"type":["string","null"],"example":"2023-03-20"},"closedDate":{"type":["string","null"],"example":"2023-03-25"},"suspenseDate":{"type":["string","null"],"example":"2023-04-15"},"uploaded":{"type":"boolean","example":true},"uploadsAllowed":{"type":"boolean","example":true},"friendlyName":{"type":["string","null"],"description":"User-friendly display name for the tracked item","example":"Authorization to disclose information"},"activityDescription":{"type":["string","null"],"description":"Brief description of why this item is needed","example":"We need your permission to request your personal information."},"shortDescription":{"type":["string","null"],"description":"Short description of the tracked item","example":"Authorization form for medical records"},"supportAliases":{"type":"array","description":"Alternative names or form numbers for this tracked item","example":["21-4142/21-4142a"],"items":{"type":"string"}},"canUploadFile":{"type":"boolean","description":"Whether the user can upload files for this tracked item","example":true},"longDescription":{"type":["object","null"],"description":"Structured content blocks for detailed description","properties":{"blocks":{"type":"array","items":{"$ref":"#/definitions/ContentBlock"}}}},"nextSteps":{"type":["object","null"],"description":"Structured content blocks for next steps","properties":{"blocks":{"type":"array","items":{"$ref":"#/definitions/ContentBlock"}}}},"noActionNeeded":{"type":"boolean","description":"Whether no action is needed from the veteran","example":false},"isDBQ":{"type":"boolean","description":"Whether this is a Disability Benefits Questionnaire item","example":false},"isProperNoun":{"type":"boolean","description":"Whether the display name is a proper noun","example":false},"isSensitive":{"type":"boolean","description":"Whether this item contains sensitive information","example":false},"noProvidePrefix":{"type":"boolean","description":"Whether to omit the \"Provide\" prefix in UI","example":false},"hideClaimLetterSection":{"type":"boolean","description":"Whether to hide the claim letter section for this tracked item","example":false},"isFirstParty":{"type":"boolean","description":"Whether the evidence was requested from the veteran (true) or from a third party (false). Derived from the tracked item's displayName. Absent unless the caller enables the `cst_surface_closed_tracked_items` feature flag.","example":true}}},"ContentBlock":{"description":"A structured content block for rich text display","properties":{"type":{"type":"string","enum":["paragraph","list","lineBreak"],"description":"The type of content block","example":"paragraph"},"content":{"type":["string","array"],"description":"The content - can be a string or array of inline elements","example":"For your benefits claim, we need your permission to request your personal information."},"style":{"type":"string","enum":["bullet","numbered"],"description":"For list blocks, the list style","example":"bullet"},"items":{"type":"array","description":"For list blocks, the list items","example":["Medical treatments","Hospitalizations","Outpatient care"]}}},"Countries":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["countries"],"properties":{"countries":{"type":"array","items":{"required":["name"],"properties":{"name":{"type":"string","example":"USA"}}}}}}}}}},"ConnectedApplications":{"required":["data"],"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"title":{"type":"string"},"created":{"type":"string"},"logo":{"type":"string"},"privacy_url":{"type":"string"},"grants":{"type":"array","items":{"properties":{"id":{"type":"string"},"title":{"type":"string"}}}}}}}}}}},"Contacts":{"required":["data"],"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"$ref":"#/definitions/Contact"}}}},"meta":{"type":"object","description":"Upstream response metadata"}}},"Contact":{"required":["contact_type","given_name","family_name","primary_phone"],"properties":{"contact_type":{"type":"string","enum":["Emergency Contact","Other emergency contact","Primary Next of Kin","Other Next of Kin"]},"given_name":{"type":["string","null"]},"family_name":{"type":["string","null"]},"relationship":{"type":["string","null"]},"address_line1":{"type":["string","null"]},"address_line2":{"type":["string","null"]},"address_line3":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"zip_code":{"type":["string","null"]},"primary_phone":{"type":["string","null"]}}},"Dependents":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"persons":{"items":{"type":"object","$ref":"#/definitions/Persons"}}}}}}}},"Persons":{"required":["award_indicator"],"properties":{"award_indicator":{"type":"string","example":"N"},"city_of_birth":{"type":"string","example":"WASHINGTON"},"current_relate_status":{"type":"string","example":null},"date_of_birth":{"type":"string","example":"01/01/2000"},"date_of_death":{"type":"string","example":null},"death_reason":{"type":"string","example":null},"email_address":{"type":"string","example":"Curt@email.com"},"first_name":{"type":"string","example":"CURT"},"last_name":{"type":"string","example":"WEBB-STER"},"middle_name":{"type":"string","example":null},"proof_of_dependency":{"type":"string","example":"Y"},"ptcpnt_id":{"type":"string","example":"32354974"},"related_to_vet":{"type":"string","example":"N"},"relationship":{"type":"string","example":"Child"},"ssn":{"type":"string","example":"500223351"},"ssn_verify_status":{"type":"string","example":"1"},"state_of_birth":{"type":"string","example":"DC"}}},"DependentsVerifications":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"prompt_renewal":{"type":"boolean","example":true},"dependency_verifications":{"type":"array","example":[{"award_effective_date":"2016-06-01T00:00:00.000-05:00","award_event_id":"185878","award_type":"CPL","begin_award_event_id":"171629","beneficiary_id":"13367440","birthday_date":"1995-05-01T00:00:00.000-05:00","decision_date":"2015-02-24T10:50:42.000-06:00","decision_id":"125932","dependency_decision_id":"53153","dependency_decision_type":"SCHATTT","dependency_decision_type_description":"School Attendance Terminates","dependency_status_type":"NAWDDEP","dependency_status_type_description":"Not an Award Dependent","event_date":"2016-05-01T00:00:00.000-05:00","first_name":"JAMES","full_name":"JAMES E. SMITH","last_name":"SMITH","middle_name":"E","modified_action":"I","modified_by":"VHAISWWHITWT","modified_date":"2015-02-24T10:50:41.000-06:00","modified_location":"317","modified_process":"Awds/RBA-cp_dependdec_pkg.do_cre","person_id":"600086386","sort_date":"2015-02-24T10:50:42.000-06:00","sort_order_number":"0","veteran_id":"13367440","veteran_indicator":"N"}]}}}}},"Email":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"email":{"type":"string","example":"john@example.com"},"effective_at":{"type":"string","example":"2018-02-27T14:41:32.283Z"}}}}}}},"Errors":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/definitions/Error"}}}},"Error":{"required":["title","detail","code","status"],"properties":{"title":{"type":"string","example":"Bad Request","description":"error class name"},"detail":{"type":"string","example":"Received a bad request response from the upstream server","description":"possibly some additional info, or just the class name again"},"code":{"type":"string","example":"EVSS400","description":"Sometiems just the http code again, sometimes something like \"EVSS400\", where\" \\\n                        \" the code can be found in config/locales/exceptions.en.yml"},"source":{"type":["string","object"],"example":"EVSS::DisabilityCompensationForm::Service","description":"error source class"},"status":{"type":"string","example":"400","description":"http status code"},"meta":{"type":"object","description":"additional info, like a backtrace"}}},"EVSSAuthError":{"required":["errors"],"properties":{"errors":{"type":"array","items":{"required":["title","detail","code","status"],"properties":{"title":{"type":"string","example":"Forbidden"},"detail":{"type":"string","example":"User does not have access to the requested resource due to missing values: corp_id, edipi"},"code":{"type":"string","example":"403"},"status":{"type":"string","example":"403"}}}}}},"FullName":{"type":"object","properties":{"first":{"type":"string"},"middle":{"type":"string"},"last":{"type":"string"}}},"PersonalIdentification":{"required":["ssn","file_number","fsr_reason"],"properties":{"ssn":{"type":"string"},"file_number":{"type":"string"},"fsr_reason":{"type":"string"}}},"PersonalData":{"properties":{"veteran_full_name":{"type":"object","$ref":"#/definitions/FullName"},"address":{"type":"object","$ref":"#/definitions/Address"},"telephone_number":{"type":"string"},"email_address":{"type":"string"},"date_of_birth":{"type":"string"},"married":{"type":"boolean"},"spouse_full_name":{"type":"object","$ref":"#/definitions/FullName"},"ages_of_other_dependents":{"type":"array","items":{"type":"string"}},"employment_history":{"type":"array","items":{"properties":{"veteran_or_spouse":{"type":"string"},"occupation_name":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"present":{"type":"boolean"},"employer_name":{"type":"string"},"employer_address":{"type":"object","$ref":"#/definitions/Address"}}}}}},"Income":{"properties":{"veteran_or_spouse":{"type":"string"},"monthly_gross_salary":{"type":"string"},"deductions":{"type":"object","properties":{"taxes":{"type":"string"},"retirement":{"type":"string"},"social_security":{"type":"string"},"other_deductions":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"string"}}}}},"total_deductions":{"type":"string"},"net_take_home_pay":{"type":"string"},"other_income":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"string"}}},"total_monthly_net_income":{"type":"string"}}},"Expenses":{"properties":{"rent_or_mortgage":{"type":"string"},"food":{"type":"string"},"utilities":{"type":"string"},"other_living_expenses":{"type":"object","properties":{"name":{"type":"string"},"amount":{"type":"string"}}},"expenses_installment_contracts_and_other_debts":{"type":"string"},"total_monthly_expenses":{"type":"string"}}},"DiscretionaryIncome":{"properties":{"net_monthly_income_less_expenses":{"type":"string"},"amount_can_be_paid_toward_debt":{"type":"string"}}},"Assets":{"properties":{"cash_in_bank":{"type":"string"},"cash_on_hand":{"type":"string"},"automobiles":{"type":"array","items":{"properties":{"make":{"type":"string"},"model":{"type":"string"},"year":{"type":"string"},"resale_value":{"type":"string"}}}},"trailers_boats_campers":{"type":"string"},"us_savings_bonds":{"type":"string"},"stocks_and_other_bonds":{"type":"string"},"real_estate_owned":{"type":"string"},"other_assets":{"type":"array","items":{"properties":{"name":{"type":"string"},"amount":{"type":"string"}}}},"total_assets":{"type":"string"}}},"InstallmentContractsAndOtherDebts":{"properties":{"creditor_name":{"type":"string"},"creditor_address":{"type":"object","$ref":"#/definitions/Address"},"date_started":{"type":"string"},"purpose":{"type":"string"},"original_amount":{"type":"string"},"unpaid_balance":{"type":"string"},"amount_due_monthly":{"type":"string"},"amount_past_due":{"type":"string"}}},"TotalOfInstallmentContractsAndOtherDebts":{"properties":{"original_amount":{"type":"string"},"unpaid_balance":{"type":"string"},"amount_due_monthly":{"type":"string"},"amount_past_due":{"type":"string"}}},"AdditionalData":{"properties":{"bankruptcy":{"type":"object","properties":{"has_been_adjudicated_bankrupt":{"type":"boolean"},"date_discharged":{"type":"string"},"court_location":{"type":"string"},"docket_number":{"type":"string"}}},"additional_comments":{"type":"string"}}},"FinancialStatusReport":{"required":["personal_identification"],"properties":{"personal_identification":{"type":"object","$ref":"#/definitions/PersonalIdentification"},"personal_data":{"type":"object","$ref":"#/definitions/PersonalData"},"income":{"type":"array","items":{"$ref":"#/definitions/Income"}},"expenses":{"type":"object","$ref":"#/definitions/Expenses"},"discretionary_income":{"type":"object","$ref":"#/definitions/DiscretionaryIncome"},"assets":{"type":"object","$ref":"#/definitions/Assets"},"installment_contracts_and_other_debts":{"type":"array","items":{"$ref":"#/definitions/InstallmentContractsAndOtherDebts"}},"total_of_installment_contracts_and_other_debts":{"type":"object","$ref":"#/definitions/TotalOfInstallmentContractsAndOtherDebts"},"additional_data":{"$ref":"#/definitions/AdditionalData"},"selected_debts_and_copays":{"type":"array","items":{"properties":{"debt_type":{"type":"string"},"deduction_code":{"type":"string"},"resolution_comment":{"type":"string"},"resolution_option":{"type":"string","enum":["waiver","monthly","compromise"]},"station":{"type":"object","properties":{"facilit_y_num":{"type":"string"}}}}}}}},"FinancialStatusReportTransform":{"required":["personal_identification"],"properties":{"personal_identification":{"type":"object","$ref":"#/definitions/PersonalIdentification"},"personal_data":{"type":"object","$ref":"#/definitions/PersonalData"},"income":{"type":"array","items":{"$ref":"#/definitions/Income"}},"expenses":{"type":"object","$ref":"#/definitions/Expenses"},"discretionary_income":{"type":"object","$ref":"#/definitions/DiscretionaryIncome"},"assets":{"type":"object","$ref":"#/definitions/Assets"},"installment_contracts_and_other_debts":{"type":"array","items":{"$ref":"#/definitions/InstallmentContractsAndOtherDebts"}},"total_of_installment_contracts_and_other_debts":{"type":"object","$ref":"#/definitions/TotalOfInstallmentContractsAndOtherDebts"},"additional_data":{"$ref":"#/definitions/AdditionalData"},"selected_debts_and_copays":{"type":"array","items":{"properties":{"debt_type":{"type":"string"},"deduction_code":{"type":"string"},"resolution_comment":{"type":"string"},"resolution_option":{"type":"string","enum":["waiver","monthly","compromise","hardship-suspension"]},"hardship_timeframe":{"type":"string","enum":["within-6-months","6-to-12-months","12-to-18-months","18-to-24-months"],"description":"Required when resolution_option is hardship-suspension"},"hardship_timeframe_acknowledgement":{"type":"boolean","description":"Required and must be true when resolution_option is hardship-suspension"},"station":{"type":"object","properties":{"facilit_y_num":{"type":"string"}}}}}}}},"AddressRequiredFields":{"required":["country","city","addressLine1"],"properties":{"country":{"type":"string","example":"USA"},"addressLine1":{"type":"string","maxLength":20,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"addressLine2":{"type":"string","maxLength":20,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"addressLine3":{"type":"string","maxLength":20,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"city":{"type":"string","maxLength":30,"pattern":"(?-mix:\\A[-a-zA-Z0-9'.#]( ?[-a-zA-Z0-9'.#])*\\z)"},"state":{"type":"string","example":"OR"}}},"AddressNoRequiredFields":{"properties":{"country":{"type":"string","example":"USA"},"addressLine1":{"type":"string","maxLength":20,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"addressLine2":{"type":"string","maxLength":20,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"addressLine3":{"type":"string","maxLength":20,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"city":{"type":"string","maxLength":30,"pattern":"(?-mix:\\A[-a-zA-Z0-9'.#]( ?[-a-zA-Z0-9'.#])*\\z)"},"state":{"type":"string","example":"OR"}}},"DateRange":{"properties":{"from":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)","example":"2019-10-XX"},"to":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)","example":"XXXX-12-31"}}},"DateRangeAllRequired":{"required":["to","from"],"properties":{"from":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)","example":"2019-10-XX"},"to":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)","example":"XXXX-12-31"}}},"NewDisability":{"required":["condition","cause"],"properties":{"condition":{"type":"string"},"cause":{"type":"string","enum":["NEW","SECONDARY","WORSENED","VA"]},"classificationCode":{"type":"string"},"primaryDescription":{"type":"string"},"causedByDisability":{"type":"string"},"causedByDisabilityDescription":{"type":"string"},"specialIssues":{"type":"array","items":{"$ref":"#/definitions/SpecialIssue"}},"worsenedDescription":{"type":"string"},"worsenedEffects":{"type":"string"},"vaMistreatmentDescription":{"type":"string"},"vaMistreatmentLocation":{"type":"string"},"vaMistreatmentDate":{"type":"string"}}},"RatedDisability":{"required":["decision_code","decision_text","name","effective_date","rated_disability_id","rating_decision_id","rating_percentage","related_disability_date","special_issues"],"properties":{"decision_code":{"type":"string","example":"SVCCONNCTED"},"decision_text":{"type":"string","example":"Service Connected"},"name":{"type":"string","example":"Diabetes mellitus0"},"effective_date":{"type":"string","example":"2018-03-27T21:00:41.000+0000"},"rated_disability_id":{"type":"string","example":"0"},"rating_decision_id":{"type":"string","example":"63655"},"rating_percentage":{"type":"integer","example":"100"},"related_disability_date":{"type":"string","example":"2018-03-27T21:00:41.000+0000"},"special_issues":{"items":{"type":"object","$ref":"#/definitions/SpecialIssue"}}}},"SpecialIssue":{"required":["code","name"],"properties":{"code":{"type":"string","example":"TRM"},"name":{"type":"string","example":"Personal Trauma PTSD"}}},"Form0781":{"properties":{"remarks":{"type":"string"},"additionalIncidentText":{"type":"string"},"additionalSecondaryIncidentText":{"type":"string"},"otherInformation":{"type":"array","items":{"type":"string"}},"incidents":{"type":"array","minItems":1,"items":{"type":"object","$ref":"#/definitions/Incident"}}}},"Incident":{"required":["personalAssault"],"properties":{"personalAssault":{"type":"boolean"},"medalsCitations":{"type":"string"},"incidentDate":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)","example":"2019-10-XX"},"incidentLocation":{"type":"object","$ref":"#/definitions/IncidentLocation"},"incidentDescription":{"type":"string"},"unitAssigned":{"type":"string"},"unitAssignedDates":{"type":"object","$ref":"#/definitions/DateRange"},"personsInvolved":{"type":"array","items":{"type":"object","$ref":"#/definitions/PersonInvolved"}},"sources":{"type":"array","items":{"type":"object","$ref":"#/definitions/Source"}}}},"IncidentLocation":{"properties":{"country":{"type":"string","example":"USA"},"city":{"type":"string","maxLength":30,"pattern":"(?-mix:\\A[-a-zA-Z0-9'.#]( ?[-a-zA-Z0-9'.#])*\\z)"},"state":{"type":"string","example":"OR"},"additionalDetails":{"type":"string"}}},"PersonInvolved":{"properties":{"name":{"type":"object","properties":{"first":{"type":"string"},"middle":{"type":"string"},"last":{"type":"string"}}},"rank":{"type":"string"},"injuryDeath":{"type":"string","enum":["killedInAction","killedNonBattle","woundedInAction","injuredNonBattle","other"]},"injuryDeathOther":{"type":"string"},"injuryDeathDate":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)","example":"2019-10-XX"},"unitAssigned":{"type":"string"},"description":{"type":"string"}}},"Source":{"properties":{"name":{"type":"string"},"address":{"type":"object","properties":{"country":{"type":"string"},"addressLine1":{"type":"string","maxLength":20,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"addressLine2":{"type":"string","maxLength":20,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"city":{"type":"string","maxLength":30,"pattern":"(?-mix:\\A[-a-zA-Z0-9'.#]( ?[-a-zA-Z0-9'.#])*\\z)"},"state":{"type":"string"},"zipCode":{"type":"string","pattern":"(?-mix:^\\\\d{5}(?:([-\\\\s]?)\\\\d{4})?$)"}}}}},"Form4142":{"properties":{"limitedConsent":{"type":"string"},"providerFacility":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","$ref":"#/definitions/ProviderFacility"}}}},"ProviderFacility":{"required":["providerFacilityName","treatmentDateRange","providerFacilityAddress"],"properties":{"providerFacilityName":{"type":"string","minLength":1,"maxLength":100},"treatmentDateRange":{"type":"array","items":{"$ref":"#/definitions/DateRangeAllRequired"}},"providerFaciltiyAddress":{"type":"object","required":["street","city","country","state","postalCode"],"properties":{"street":{"type":"string","minLength":1,"maxLength":20},"street2":{"type":"string","minLength":1,"maxLength":20},"city":{"type":"string","minLength":1,"maxLength":30},"postalCode":{"type":"string","pattern":"(?-mix:^\\\\d{5}(?:([-\\\\s]?)\\\\d{4})?$)"},"country":{"type":"string","example":"USA"},"state":{"type":"string","example":"OR"}}}}},"Form526SubmitV2":{"required":["form526"],"properties":{"form526":{"type":"object","properties":{"alternateNames":{"type":"array","items":{"type":"object","$ref":"#/definitions/AlternateName"}},"atRiskHousingSituation":{"type":"string","enum":["losingHousing","leavingShelter","other"]},"attachments":{"type":"array","items":{"type":"object","$ref":"#/definitions/Attachment"}},"bankAccountNumber":{"type":"string","minLength":4,"maxLength":17},"bankAccountType":{"type":"string","enum":["Checking","Saving"]},"bankName":{"type":"string","maxLength":35},"bankRoutingNumber":{"type":"string","pattern":"(?-mix:^\\d{9}$)"},"completedFormAttachments":{"type":"array","items":{"type":"object","required":["name","attachmentId"],"properties":{"name":{"type":"string","example":"private_medical_record.pdf"},"confirmationCode":{"type":"string","example":"d44d6f52-2e85-43d4-a5a3-1d9cb4e482a1"},"attachmentId":{"type":"string"}}}},"confinements":{"type":"array","items":{"$ref":"#/definitions/DateRangeAllRequired"}},"employmentRequestAttachments":{"type":"array","items":{"type":"object","required":["name","attachmentId"],"properties":{"name":{"type":"string","example":"private_medical_record.pdf"},"confirmationCode":{"type":"string","example":"d44d6f52-2e85-43d4-a5a3-1d9cb4e482a1"},"attachmentId":{"type":"string","enum":["L115"]}}}},"form0781":{"type":"object","$ref":"#/definitions/Form0781"},"form4142":{"type":"object","$ref":"#/definitions/Form4142"},"form8940":{"type":"object","$ref":"#/definitions/Form8940"},"forwardingAddress":{"type":"object","$ref":"#/definitions/ForwardingAddress"},"hasTrainingPay":{"type":"boolean"},"homelessHousingSituation":{"type":"string","enum":["shelter","notShelter","anotherPerson","other"]},"homelessOrAtRisk":{"type":"string","enum":["no","homeless","atARisk"]},"homelessnessContact":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"pattern":"(?-mix:^([a-zA-Z0-9\\-\\/']+( ?))*$)"},"phoneNumber":{"type":"string","pattern":"(?-mix:^\\\\d{10}$)"}}},"isVaEmployee":{"type":"boolean"},"mailingAddress":{"type":"object","$ref":"#/definitions/AddressRequiredFields"},"mentalChanges":{"type":"object","$ref":"#/definitions/MentalChanges"},"militaryRetiredPayBranch":{"type":"string","enum":["Air Force","Army","Coast Guard","Marine Corps","National Oceanic and Atmospheric Administration","Navy","Public Health Service"]},"hasMilitaryRetiredPay":{"type":"boolean"},"needToLeaveHousing":{"type":"boolean"},"newPrimaryDisabilities":{"type":"array","items":{"type":"object","$ref":"#/definitions/NewDisability"}},"newSecondaryDisabilities":{"type":"array","items":{"type":"object","$ref":"#/definitions/NewDisability"}},"otherAtRiskHousing":{"type":"string","minLength":1,"maxLength":500},"otherHomelessHousing":{"type":"string"},"phoneAndEmail":{"type":"object","required":["primaryPhone","emailAddress"],"properties":{"primaryPhone":{"type":"string","pattern":"(?-mix:^\\\\d{10}$)"},"emailAddress":{"type":"string","minLength":6,"maxLength":80,"pattern":"(?-mix:^[_A-Za-z0-9-]+(\\\\.[_A-Za-z0-9-]+)*@[A-Za-z0-9-]+(\\\\.[A-Za-z0-9]+)*(\\\\.[A-Za-z]{2,})$)"}}},"privateMedicalRecordAttachments":{"type":"array","items":{"type":"object","$ref":"#/definitions/PrivateMedicalRecordAttachment"}},"ratedDisabilities":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","$ref":"#/definitions/RatedDisability"}},"secondaryAttachment":{"type":"array","items":{"type":"object","$ref":"#/definitions/SecondaryAttachment"}},"separationPayBranch":{"type":"string","enum":["VA Form 21-0781a - Statement in Support of Claim for PTSD Secondary to Personal Assault","Civilian Police Reports","Military Personnel Record","Medical Treatment Record - Government Facility","Medical Treatment Record - Non-Government Facility","DD214","Other Correspondence","Buddy/Lay Statement"]},"separationPayDate":{"type":"string"},"serviceInformation":{"type":"object","items":{"$ref":"#/definitions/ServiceInformation"}},"standardClaim":{"type":"boolean","default":false},"unemployabilityAttachments":{"type":"array","items":{"type":"object","$ref":"#/definitions/UnemployabilityAttachments"}},"vaTreatmentFacilities":{"type":"array","items":{"type":"object","$ref":"#/definitions/VATreatmentFacility"}},"waiveRetirementPay":{"type":"boolean"},"waiveTrainingPay":{"type":"boolean"}}}}},"Attachment":{"required":["name","attachmentId"],"properties":{"name":{"type":"string","example":"private_medical_record.pdf"},"confirmationCode":{"type":"string","example":"d44d6f52-2e85-43d4-a5a3-1d9cb4e482a1"},"attachmentId":{"type":"string","enum":["L015","L018","L029","L702","L703","L034","L478","L048","L049","L023","L070","L450","L451","L222","L228","L229","L102","L107","L827","L115","L117","L159","L133","L139","L149","L1839"]}}},"AlternateName":{"properties":{"first":{"type":"string","example":"John","minLength":1,"maxLength":14,"pattern":"(?-mix:^([a-zA-Z0-9\\-\\/']+( ?))+$)"},"middle":{"type":"string","example":"Jonny","minLength":1,"maxLength":14,"pattern":"(?-mix:^([a-zA-Z0-9\\-\\/']+( ?))+$)"},"last":{"type":"string","example":"Johnson","minLength":1,"maxLength":14,"pattern":"(?-mix:^([a-zA-Z0-9\\-\\/']+( ?))+$)"}}},"ForwardingAddress":{"properties":{"country":{"type":"string","example":"USA"},"addressLine1":{"type":"string","maxLength":35,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"addressLine2":{"type":"string","maxLength":35,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"addressLine3":{"type":"string","maxLength":35,"pattern":"(?-mix:^([-a-zA-Z0-9'.,&#]([-a-zA-Z0-9'.,&# ])?)+$)"},"city":{"type":"string","maxLength":30,"pattern":"(?-mix:\\A[-a-zA-Z0-9'.#]( ?[-a-zA-Z0-9'.#])*\\z)"},"state":{"type":"string","example":"OR"},"zipCode":{"type":"string","pattern":"(?-mix:^\\\\d{5}(?:([-\\\\s]?)\\\\d{4})?$)"},"effectiveDate":{"type":"object","$ref":"#/definitions/DateRange"}}},"MentalChanges":{"properties":{"depression":{"type":"boolean"},"obsessive":{"type":"boolean"},"prescription":{"type":"boolean"},"substance":{"type":"boolean"},"hypervigilance":{"type":"boolean"},"agoraphobia":{"type":"boolean"},"fear":{"type":"boolean"},"other":{"type":"boolean"},"otherExplanation":{"type":"string"},"noneApply":{"type":"boolean"}}},"PrivateMedicalRecordAttachment":{"required":["name","attachmentId"],"properties":{"name":{"type":"string"},"confirmationCode":{"type":"string"},"attachmentId":{"type":"string","enum":["L107","L023"]}}},"SecondaryAttachment":{"required":["name","attachmentId"],"properties":{"name":{"type":"string"},"confirmationCode":{"type":"string"},"attachmentId":{"type":"string","enum":["L229","L018","L034","L048","L049","L029","L023","L015"]}}},"ServiceInformation":{"required":["servicePeriods"],"properties":{"servicePeriods":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["serviceBranch","dateRange"],"properties":{"serviceBranch":{"type":"string","enum":["Air Force","Air Force Reserve","Air National Guard","Army","Army National Guard","Army Reserve","Coast Guard","Coast Guard Reserve","Marine Corps","Marine Corps Reserve","NOAA","Navy","Navy Reserve","Public Health Service"]},"dateRange":{"type":"array","items":{"$ref":"#/definitions/DateRangeAllRequired"}}}}},"separationLocation":{"type":"object","items":{"properties":{"separationLocationCode":{"type":"string","example":"98283"},"separationLocationName":{"type":"string","maxLength":256,"pattern":"(?-mix:^([a-zA-Z0-9\\/\\-'.#,*()&][a-zA-Z0-9\\/\\-'.#,*()& ]?)*$)","example":"AF Academy"}}}},"reservesNationalGuardService":{"type":"object","items":{"required":["unitName","obligationTermOfServiceDateRange"],"properties":{"unitName":{"type":"string","maxLength":256,"pattern":"(?-mix:^([a-zA-Z0-9\\-'.#][a-zA-Z0-9\\-'.# ]?)*$)"},"obligationTermOfServiceDateRange":{"type":"array","items":{"$ref":"#/definitions/DateRangeAllRequired"}},"receivingTrainingPay":{"type":"boolean"},"title10Activation":{"type":"object","items":{"properties":{"title10ActivationDate":{"type":"array","$ref":"#/definitions/DateRange"},"anticipatedSeparationDate":{"type":"array","$ref":"#/definitions/DateRange"}}}}}}}}},"UnemployabilityAttachments":{"required":["name","attachmentId"],"properties":{"name":{"type":"string"},"confirmationCode":{"type":"string"},"attachmentId":{"type":"string","enum":["L149","L023"]}}},"VATreatmentFacility":{"required":["treatmentCenterName","treatedDisabilityNames"],"properties":{"treatmentCenterName":{"type":"string","maxLength":100,"pattern":"(?-mix:^([a-zA-Z0-9\\-'.#]([a-zA-Z0-9\\-'.# ])?)+$)"},"treatmentDateRange":{"type":"array","$ref":"#/definitions/DateRange"},"treatmentCenterAddress":{"type":"object","required":["country"],"properties":{"country":{"type":"string","example":"USA"},"city":{"type":"string","maxLength":30,"pattern":"(?-mix:\\A[-a-zA-Z0-9'.#]( ?[-a-zA-Z0-9'.#])*\\z)"},"state":{"type":"string","example":"OR"}}},"treatedDisabilityNames":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}}}},"Form8940":{"properties":{"unemployability":{"type":"object","properties":{"mostIncome":{"type":"number"},"yearEarned":{"type":"string"},"job":{"type":"string"},"disabilityPreventingEmployment":{"type":"string"},"underDoctorHopitalCarePast12M":{"type":"boolean"},"doctorProvidedCare":{"type":"array","items":{"type":"object","$ref":"#/definitions/ProvidedCare"}},"hospitalProvidedCare":{"type":"array","items":{"type":"object","$ref":"#/definitions/ProvidedCare"}},"disabilityAffectedEmploymentFullTimeDate":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)"},"lastWorkedFullTimeDate":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)"},"becameTooDisabledToWorkDate":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)"},"mostEarningsInAYear":{"type":"string"},"yearOfMostEarnings":{"type":"string"},"occupationDuringMostEarnings":{"type":"string"},"previousEmployers":{"type":"array","items":{"type":"object","$ref":"#/definitions/PreviousEmployer"}},"disabilityPreventMilitaryDuties":{"type":"boolean"},"past12MonthsEarnedIncome":{"type":"number","minimum":0,"maximum":9999999.99},"currentMonthlyEarnedIncome":{"type":"number","minimum":0,"maximum":9999999.99},"leftLastJobDueToDisability":{"type":"boolean"},"leftLastJobDueToDisabilityRemarks":{"type":"string"},"receiveExpectDisabilityRetirement":{"type":"boolean"},"receiveExpectWorkersCompensation":{"type":"boolean"},"attemptedToObtainEmploymentSinceUnemployability":{"type":"boolean"},"appliedEmployers":{"type":"array","items":{"type":"object","$ref":"#/definitions/AppliedEmployer"}},"education":{"type":"string","enum":["Some elementary school","Some high school","High school diploma or GED","Some college","Associate's degree","Bachelor’s degree","Master’s degree","Doctoral degree","Other"]},"receivedOtherEducationTrainingPreUnemployability":{"type":"boolean"},"otherEducationTrainingPreUnemployability":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"dates":{"type":"object","$ref":"#/definitions/DateRange"}}}},"remarks":{"type":"string"}}}}},"ProvidedCare":{"properties":{"name":{"type":"string"},"address":{"type":"object","$ref":"#/definitions/AddressNoRequiredFields"},"dates":{"type":"string"}}},"PreviousEmployer":{"properties":{"name":{"type":"string"},"employerAddress":{"type":"object","$ref":"#/definitions/AddressNoRequiredFields"},"phone":{"type":"string","pattern":"(?-mix:^\\\\d{10}$)"},"typeOfWork":{"type":"string"},"hoursPerWeek":{"type":"number","minLength":0,"maxLength":999},"dates":{"type":"object","$ref":"#/definitions/DateRange"},"timeLostFromIllness":{"type":"string"},"mostEarningsInAMonth":{"type":"number","minimum":0},"inBusiness":{"type":"boolean"}}},"AppliedEmployer":{"properties":{"name":{"type":"string"},"address":{"type":"object","$ref":"#/definitions/AddressNoRequiredFields"},"workType":{"type":"string"},"date":{"type":"string","pattern":"(?-mix:^(\\\\d{4}|XXXX)-(0[1-9]|1[0-2]|XX)-(0[1-9]|[1-2][0-9]|3[0-1]|XX)$)"}}},"SeparationLocations":{"required":["separation_locations"],"properties":{"separation_locations":{"type":"array","items":{"required":["code","description"],"properties":{"code":{"type":"string","example":"98283"},"description":{"type":"string","example":"AF Academy"}}}}}},"JobStatus":{"required":["data"],"properties":{"data":{"type":"object","properties":{"attributes":{"type":"object","properties":{"claim_id":{"type":"integer"},"job_id":{"type":"string"},"submission_id":{"type":"integer"},"status":{"type":"string"},"ancillary_item_statuses":{"type":"array"}}},"id":{"type":"string"},"type":{"type":"string"}}}}},"RatedDisabilities":{"required":["data"],"properties":{"data":{"type":"object","properties":{"attributes":{"type":"object","required":["rated_disabilities"],"properties":{"rated_disabilities":{"items":{"type":"object","$ref":"#/definitions/RatedDisability"}}}},"id":{"type":"string","example":null},"type":{"type":"string","example":"evss_disability_compensation_form_rated_disabilities_response"}}}}},"SubmitDisabilityForm":{"required":["data"],"properties":{"data":{"type":"object","properties":{"attributes":{"type":"object","required":["job_id"],"properties":{"job_id":{"type":"string","example":"b4a577edbccf1d805744efa9"}}}}}}},"SuggestedConditions":{"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/definitions/DisabilityContention"}}}},"DisabilityContention":{"required":["id","type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"code":{"type":"integer","example":460},"medical_term":{"type":"string","example":"arteriosclerosis"},"lay_term":{"type":"string","example":"hardened arteries"}}}}},"RatingInfo":{"properties":{"disability_decision_type_name":{"type":"string","example":"Service Connected"},"service_connected_combined_degree":{"type":"integer","example":90},"user_percent_of_disability":{"type":"integer","example":90}}},"Forms":{"required":["data"],"properties":{"data":{"type":"array","items":{"properties":{"id":{"description":"JSON API identifier","type":"string","example":"VA10192"},"type":{"description":"JSON API type specification","type":"string","example":"va_form"},"attributes":{"properties":{"form_name":{"description":"Name of the VA Form","type":"string","example":"VA10192"},"url":{"description":"Web location of the form","type":"string","example":"https://www.va.gov/vaforms/va/pdf/VA10192.pdf"},"title":{"description":"Title of the form as given by VA","type":"string","example":"Information for Pre-Complaint Processing"},"last_revision_on":{"description":"The date the form was last updated","type":"string","example":"2012-01-01","format":"date"},"pages":{"description":"Number of pages contained in the form","type":"integer","example":3},"sha256":{"description":"A sha256 hash of the form contents","type":"string","example":"5fe171299ece147e8b456961a38e17f1391026f26e9e170229317bc95d9827b7"}}}}}}}},"GibctCalculatorConstants":{"required":["data","meta","links"],"properties":{"data":{"type":"array","minItems":0,"uniqueItems":true,"items":{"required":["id","type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":["null","number","string"]}}}}}},"meta":{"$ref":"#/definitions/GibctCalculatorConstantsMeta"},"links":{"$ref":"#/definitions/GibctCalculatorConstantsSelfLinks"}}},"GibctCalculatorConstantsSelfLinks":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}}},"GibctCalculatorConstantsMeta":{"type":"object","required":["version"],"properties":{"version":{"type":"null"}}},"GibctInstitutionsAutocomplete":{"required":["data","meta","links"],"properties":{"data":{"type":"array","minItems":0,"uniqueItems":true,"items":{"properties":{"id":{"type":"integer"},"value":{"type":"string"},"label":{"type":"string"}}}},"meta":{"$ref":"#/definitions/GibctInstitutionsAutocompleteMeta"},"links":{"$ref":"#/definitions/GibctInstitutionsSelfLinks"}}},"GibctInstitutionsSearch":{"required":["data","meta","links"],"properties":{"data":{"type":"array","maxItems":10,"uniqueItems":true,"items":{"type":"object","required":["id","type","attributes","links"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["institutions"]},"links":{"$ref":"#/definitions/GibctInstitutionsSelfLinks"},"attributes":{"$ref":"#/definitions/GibctInstitutionBase","properties":{"type":{"type":"string","enum":["OJT","PRIVATE","FOREIGN","CORRESPONDENCE","FLIGHT","FOR PROFIT","PUBLIC"]}}}}}},"meta":{"$ref":"#/definitions/GibctInstitutionsSearchMeta"},"links":{"$ref":"#/definitions/GibctInstitutionsSearchLinks"}}},"GibctInstitution":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"object","required":["id","type","attributes","links"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["institutions"]},"links":{"$ref":"#/definitions/GibctInstitutionsSelfLinks"},"attributes":{"$ref":"#/definitions/GibctInstitutionBase","properties":{"type":{"type":"string","enum":["OJT","PRIVATE","FOREIGN","CORRESPONDENCE","FLIGHT","FOR PROFIT","PUBLIC"]},"flight":{"type":"boolean"},"correspondence":{"type":"boolean"},"cross":{"type":["null","string"]},"ope":{"type":["null","string"]},"ope6":{"type":["null","string"]},"undergrad_enrollment":{"type":["null","integer"]},"student_veteran":{"type":"boolean"},"student_veteran_link":{"type":["null","string"]},"dodmou":{"type":"boolean"},"sec_702":{"type":["null","boolean"]},"vet_success_name":{"type":["null","string"]},"vet_success_email":{"type":["null","string"]},"credit_for_mil_training":{"type":["null","boolean"]},"vet_poc":{"type":["null","boolean"]},"student_vet_grp_ipeds":{"type":["null","boolean"]},"soc_member":{"type":["null","boolean"]},"retention_rate_veteran_ba":{"type":["null","number"]},"retention_all_students_ba":{"type":["null","number"]},"retention_rate_veteran_otb":{"type":["null","number"]},"retention_all_students_otb":{"type":["null","number"]},"persistance_rate_veteran_ba":{"type":["null","number"]},"persistance_rate_veteran_otb":{"type":["null","number"]},"graduation_rate_veteran":{"type":["null","number"]},"graduation_rate_all_students":{"type":["null","number"]},"transfer_out_rate_veteran":{"type":["null","number"]},"transfer_out_rate_all_students":{"type":["null","number"]},"salary_all_students":{"type":["null","number"]},"repayment_rate_all_students":{"type":["null","number"]},"avg_stu_loan_debt":{"type":["null","number"]},"calendar":{"type":["null","string"]},"online_all":{"type":["null","boolean"]},"p911_tuition_fees":{"type":"number"},"p911_recipients":{"type":"integer"},"p911_yellow_ribbon":{"type":["null","number"]},"p911_yr_recipients":{"type":["null","integer"]},"accredited":{"type":"boolean"},"accreditation_type":{"type":["null","string"]},"accreditation_status":{"type":["null","string"]},"ownership_name":{"type":["null","string"]},"complaints":{"type":"object","properties":{"facility_code":{"type":"integer"},"financial_by_fac_code":{"type":"integer"},"quality_by_fac_code":{"type":"integer"},"refund_by_fac_code":{"type":"integer"},"marketing_by_fac_code":{"type":"integer"},"accreditation_by_fac_code":{"type":"integer"},"degree_requirements_by_fac_code":{"type":"integer"},"student_loans_by_fac_code":{"type":"integer"},"grades_by_fac_code":{"type":"integer"},"credit_transfer_by_fac_code":{"type":"integer"},"credit_job_by_fac_code":{"type":["null","integer"]},"job_by_fac_code":{"type":"integer"},"transcript_by_fac_code":{"type":"integer"},"other_by_fac_code":{"type":"integer"},"main_campus_roll_up":{"type":"integer"},"financial_by_ope_id_do_not_sum":{"type":"integer"},"quality_by_ope_id_do_not_sum":{"type":"integer"},"refund_by_ope_id_do_not_sum":{"type":"integer"},"marketing_by_ope_id_do_not_sum":{"type":"integer"},"accreditation_by_ope_id_do_not_sum":{"type":"integer"},"degree_requirements_by_ope_id_do_not_sum":{"type":"integer"},"student_loans_by_ope_id_do_not_sum":{"type":"integer"},"grades_by_ope_id_do_not_sum":{"type":"integer"},"credit_transfer_by_ope_id_do_not_sum":{"type":"integer"},"jobs_by_ope_id_do_not_sum":{"type":"integer"},"transcript_by_ope_id_do_not_sum":{"type":"integer"},"other_by_ope_id_do_not_sum":{"type":"integer"}}}}}}},"meta":{"$ref":"#/definitions/GibctInstitutionsShowMeta"}}},"GibctInstitutionsAutocompleteMeta":{"type":"object","required":["version","term"],"properties":{"version":{"$ref":"#/definitions/GibctVersion"},"term":{"type":"string"}}},"GibctInstitutionsSearchMeta":{"type":"object","required":["version","count","facets"],"properties":{"version":{"$ref":"#/definitions/GibctVersion"},"count":{"type":"integer"},"facets":{"type":"object","required":["category","type","state","country","student_vet_group","yellow_ribbon_scholarship","principles_of_excellence","eight_keys_to_veteran_success","stem_offered","independent_study","online_only","distance_learning","priority_enrollment"],"properties":{"category":{"type":"object","required":["school","employer"],"properties":{"school":{"type":"integer"},"employer":{"type":"integer"}}},"type":{"type":"object","properties":{"correspondence":{"type":"integer"},"flight":{"type":"integer"},"foreign":{"type":"integer"},"for profit":{"type":"integer"},"ojt":{"type":"integer"},"private":{"type":"integer"},"public":{"type":"integer"}}},"state":{"$ref":"#/definitions/GibctState"},"country":{"$ref":"#/definitions/GibctCountry"},"student_vet_group":{"$ref":"#/definitions/null_boolean_counts"},"yellow_ribbon_scholarship":{"$ref":"#/definitions/null_boolean_counts"},"principles_of_excellence":{"$ref":"#/definitions/null_boolean_counts"},"eight_keys_to_veteran_success":{"$ref":"#/definitions/null_boolean_counts"}}}}},"GibctInstitutionsShowMeta":{"type":"object","required":["version"],"properties":{"version":{"$ref":"#/definitions/GibctVersion"}}},"GibctInstitutionsSearchLinks":{"type":"object","required":["self","first","prev","next","last"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":["null","string"]},"next":{"type":["null","string"]},"last":{"type":"string"}}},"GibctInstitutionBase":{"required":["name","facility_code","type","city","state","zip","country","highest_degree","locale_type","student_count","caution_flag","caution_flag_reason","created_at","updated_at","bah","tuition_in_state","tuition_out_of_state","books","student_veteran","yr","poe","eight_keys"],"properties":{"name":{"type":"string"},"facility_code":{"type":"string"},"city":{"type":["null","string"]},"state":{"type":["null","string"]},"zip":{"type":["null","string"]},"country":{"type":["null","string"]},"highest_degree":{"type":["null","integer"]},"locale_type":{"type":["null","string"]},"student_count":{"type":["null","integer"]},"caution_flag":{"type":["null","boolean"]},"caution_flag_reason":{"type":["null","string"]},"created_at":{"type":"string"},"updated_at":{"type":"string"},"bah":{"type":["null","number"]},"tuition_in_state":{"type":["null","number"]},"tuition_out_of_state":{"type":["null","number"]},"books":{"type":["null","number"]},"student_veteran":{"type":["null","boolean"]},"yr":{"type":["null","boolean"]},"poe":{"type":["null","boolean"]},"eight_keys":{"type":["null","boolean"]},"ownership_name":{"type":["null","string"]}}},"GibctInstitutionsSelfLinks":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}}},"null_boolean_counts":{"type":"object","required":["true","false"],"properties":{"true":{"type":["null","integer"]},"false":{"type":["null","integer"]}}},"GibctInstitutionProgramsAutocomplete":{"required":["data","meta","links"],"properties":{"data":{"type":"array","minItems":0,"uniqueItems":true,"items":{"properties":{"id":{"type":"integer","example":1234,"description":"Unique program ID"},"value":{"type":"string","example":"1X12345","description":"Program institution facility code"},"label":{"type":"string","example":"COMPUTER SCIENCE","description":"Program name"}}}},"meta":{"$ref":"#/definitions/GibctInstitutionProgramsAutocompleteMeta"},"links":{"type":"object","properties":{"self":{"type":"string","example":"http://localhost:3000/v0/institution_programs/autocomplete?name=code"}}}}},"GibctInstitutionProgramsSearch":{"required":["data","meta","links"],"properties":{"data":{"type":"array","maxItems":10,"uniqueItems":true,"items":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","example":"1973-01-01T05:00:00.000+00:00"},"type":{"type":"string","enum":["institution_programs"]},"attributes":{"required":["facility_code","description"],"properties":{"program_type":{"type":["null","string"],"enum":["IHL","NCD","OJT","FLGT","CORR"],"description":"The classification of the program, ex: IHL, NCD, OJT"},"description":{"type":"string","example":"COMPUTER SCIENCE","description":"Program name"},"length_in_hours":{"type":["null","string"],"example":"680","description":"Length of program (in hours)"},"length_in_weeks":{"type":["null","integer"],"example":12,"description":"Length of program (in weeks)"},"facility_code":{"type":"string","example":"1X12345","description":"Program institution facility code"},"institution_name":{"type":"string","example":"CODE PLACE","description":"Program institution name"},"city":{"type":["null","string"],"example":"ANYTOWN","description":"Program institution physical city location"},"state":{"type":["null","string"],"example":"WA","description":"Program institution physical state location"},"country":{"type":["null","string"],"example":"USA","description":"Program institution physical country location"},"preferred_provider":{"type":["null","boolean"],"example":false,"description":"Program institution preferred provider indicator;\n                                              a provider that takes on the costs of the veterans education if\n                                               the requirements are not met"},"tuition_amount":{"type":["null","integer"],"example":1000,"description":"Program tuition amount"},"va_bah":{"type":["null","number"],"example":220.0,"description":"VA Basic Allowance for Housing"},"dod_bah":{"type":["null","integer"],"example":200,"description":"DOD Basic Allowance for Housing"}}}}}},"meta":{"$ref":"#/definitions/GibctInstitutionProgramsSearchMeta"},"links":{"$ref":"#/definitions/GibctInstitutionProgramsSearchLinks"}}},"GibctInstitutionProgramsAutocompleteMeta":{"type":"object","required":["version","term"],"properties":{"version":{"$ref":"#/definitions/GibctVersion"},"term":{"type":"string","example":"code"}}},"GibctInstitutionProgramsSearchMeta":{"type":"object","required":["version","count","facets"],"properties":{"version":{"$ref":"#/definitions/GibctVersion"},"count":{"type":"integer","example":1},"facets":{"type":"object","required":["type","state","country"],"properties":{"type":{"type":"object","properties":{"ihl":{"type":"integer","example":0},"ncd":{"type":"integer","example":1},"ojt":{"type":"integer","example":0},"flgt":{"type":"integer","example":0},"corr":{"type":"integer","example":0}}},"state":{"$ref":"#/definitions/GibctState"},"country":{"$ref":"#/definitions/GibctCountry"}}}}},"GibctInstitutionProgramsSearchLinks":{"type":"object","required":["self","first","prev","next","last"],"properties":{"self":{"type":"string","example":"http://localhost:3000/v0/institution_programs/?name=code"},"first":{"type":"string"},"prev":{"type":["null","string"]},"next":{"type":["null","string"]},"last":{"type":"string","example":"http://localhost:3000/v0/institution_programs/?name=code&page=3&per_page=30"}}},"GibctYellowRibbonPrograms":{"required":["data","meta","links"],"properties":{"data":{"type":"array","maxItems":30,"uniqueItems":true,"items":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","example":"1226343"},"type":{"type":"string","enum":["yellow_ribbon_programs"],"example":"yellow_ribbon_programs"},"attributes":{"required":["city","contribution_amount","correspondence","country","degree_level","distance_learning","division_professional_school","facility_code","institution_id","insturl","latitude","longitude","name_of_institution","number_of_students","online_only","state","street_address","student_veteran","student_veteran_link","ungeocodable","year_of_yr_participation","zip"],"properties":{"city":{"type":["null","string"],"example":"Abilene","description":"The city name where the Yellow Ribbon Program is located."},"contribution_amount":{"type":["null","string"],"example":"99999.0","description":"The contribution amount in dollars."},"correspondence":{"type":["null","boolean"],"example":false,"description":"Indicates that this is only a correspondence institution."},"country":{"type":["null","string"],"example":"USA","description":"The country where the Yellow Ribbon Program is located."},"distance_learning":{"type":["null","boolean"],"example":false,"description":"Indicates that this institution offers off-campus options"},"degree_level":{"type":["null","string"],"example":"All","description":"The degree levels available to the Yellow Ribbon Program."},"division_professional_school":{"type":["null","string"],"example":"All","description":"The majors/minors of the Yellow Ribbon Program."},"facility_code":{"type":["null","string"],"example":"31000143","description":"The faciliy code of the Yellow Ribbon Program."},"institution_id":{"type":["null","integer"],"example":20405111,"description":"The institution ID the Yellow Ribbon Program belongs to."},"insturl":{"type":["null","string"],"example":"www.acu.edu","description":"The URL for the Yellow Ribbon Program's institution."},"latitude":{"type":["null","number"],"format":"double","example":32.0713829183673,"description":"Geographic coordinate"},"longitude":{"type":["null","number"],"format":"double","example":-84.2393880204082,"description":"Geographic coordinate"},"name_of_institution":{"type":["null","string"],"example":"ABILENE CHRISTIAN UNIVERSITY","description":"The name of the school."},"number_of_students":{"type":["null","integer"],"example":99999,"description":"The number of students that can receive the benefit."},"online_only":{"type":["null","boolean"],"example":false,"description":"Indicates that this institution only offers online courses."},"state":{"type":["null","string"],"example":"TX","description":"The provincial state where the Yellow Ribbon Program is located."},"street_address":{"type":["null","string"],"example":"1600 Campus Court","description":"The street address where the Yellow Ribbon Program is located."},"student_veteran":{"type":["null","boolean"],"example":false,"description":"Indicates that there is a student veterans group on campus."},"student_veteran_link":{"type":["null","string"],"example":"https://www.example.com","description":"Link to the student veterans group."},"ungeocodable":{"type":["null","boolean"],"example":false,"description":"Indicates a failure to resolve geographic coordinates."},"year_of_yr_participation":{"type":["null","string"],"example":"\"2018/2019\"","description":"The school year that this Yellow RibbonProgram data is for."},"zip":{"type":["null","string"],"example":"\"31709\"","description":"Postal code"}}}}}},"meta":{"$ref":"#/definitions/GibctYellowRibbonProgramsMeta"},"links":{"$ref":"#/definitions/GibctYellowRibbonProgramsLinks"}}},"GibctYellowRibbonProgramsMeta":{"type":"object","required":["version","count"],"properties":{"version":{"$ref":"#/definitions/GibctVersion"},"count":{"type":"integer","example":790}}},"GibctYellowRibbonProgramsLinks":{"type":"object","required":["self","first","prev","next","last"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":["null","string"]},"next":{"type":["null","string"]},"last":{"type":"string"}}},"GibctVersion":{"type":"object","required":["number","created_at","preview"],"properties":{"number":{"type":"integer","example":1},"created_at":{"type":"string","example":"2019-10-23T14:4:34.582Z"},"preview":{"type":"boolean","example":false}}},"GibctState":{"type":"object","properties":{"AK":{"type":"integer"},"AL":{"type":"integer"},"AR":{"type":"integer"},"AS":{"type":"integer"},"AZ":{"type":"integer"},"CA":{"type":"integer"},"CO":{"type":"integer"},"CT":{"type":"integer"},"DC":{"type":"integer"},"DE":{"type":"integer"},"FL":{"type":"integer"},"FM":{"type":"integer"},"GA":{"type":"integer"},"GU":{"type":"integer"},"HI":{"type":"integer"},"IA":{"type":"integer"},"ID":{"type":"integer"},"IL":{"type":"integer"},"IN":{"type":"integer"},"KS":{"type":"integer"},"KY":{"type":"integer"},"LA":{"type":"integer"},"MA":{"type":"integer"},"MD":{"type":"integer"},"ME":{"type":"integer"},"MH":{"type":"integer"},"MI":{"type":"integer"},"MN":{"type":"integer"},"MO":{"type":"integer"},"MP":{"type":"integer"},"MS":{"type":"integer"},"MT":{"type":"integer"},"NC":{"type":"integer"},"ND":{"type":"integer"},"NE":{"type":"integer"},"BH":{"type":"integer"},"NJ":{"type":"integer"},"NM":{"type":"integer"},"NV":{"type":"integer"},"NY":{"type":"integer"},"OH":{"type":"integer"},"OK":{"type":"integer"},"OR":{"type":"integer"},"PA":{"type":"integer"},"PR":{"type":"integer"},"PW":{"type":"integer"},"RI":{"type":"integer"},"SC":{"type":"integer"},"SD":{"type":"integer"},"TN":{"type":"integer"},"TX":{"type":"integer"},"UT":{"type":"integer"},"VA":{"type":"integer"},"VI":{"type":"integer"},"VT":{"type":"integer"},"WA":{"type":"integer"},"WI":{"type":"integer"},"WV":{"type":"integer"},"WY":{"type":"integer"}}},"GibctCountry":{"type":"array","items":{"type":"object","required":["name","count"],"properties":{"name":{"type":"string","example":"USA"},"count":{"type":"integer","example":1}}}},"Folders":{"required":["data","meta"],"properties":{"data":{"type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/FolderBase"}},"meta":{"$ref":"#/definitions/MetaPagination"},"links":{"$ref":"#/definitions/LinksAll"}}},"Folder":{"required":["data"],"properties":{"data":{"type":"object","$ref":"#/definitions/FolderBase"}}},"FolderBase":{"required":["id","type","attributes","links"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["folders"]},"attributes":{"type":"object","$ref":"#/definitions/FolderAttributes"},"links":{"$ref":"#/definitions/LinksSelf"}}},"FolderAttributes":{"required":["folder_id","name","count","unread_count","system_folder"],"properties":{"folder_id":{"type":"integer"},"name":{"type":"string"},"count":{"type":"integer"},"unread_count":{"type":"integer"},"system_folder":{"type":"boolean"}}},"LinksAll":{"type":"object","required":["self","first","prev","next","last"],"properties":{"self":{"type":"string"},"first":{"type":"string"},"prev":{"type":["string","null"]},"next":{"type":["string","null"]},"last":{"type":"string"}}},"LinksSelf":{"type":"object","required":["self"],"properties":{"self":{"type":"string"}}},"LinksDownload":{"type":"object","required":["download"],"properties":{"download":{"type":"string"}}},"LinksTracking":{"type":"object","required":["self","prescription","tracking_url"],"properties":{"self":{"type":"string"},"prescription":{"type":"string"},"tracking_url":{"type":"string"}}},"Messages":{"required":["data","meta"],"properties":{"data":{"type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/DataAttributes"}},"meta":{"$ref":"#/definitions/MetaSortPagination"},"links":{"$ref":"#/definitions/LinksAll"}}},"MessagesThread":{"required":["data"],"properties":{"data":{"type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/DataAttributes"}},"meta":{"$ref":"#/definitions/MetaSortPagination"},"links":{"$ref":"#/definitions/LinksAll"}}},"Message":{"required":["data"],"properties":{"data":{"type":"object","$ref":"#/definitions/DataAttributesWithRelationships"},"included":{"$ref":"#/definitions/Included"}}},"Included":{"required":["included"],"properties":{"included":{"type":"array","minItems":0,"uniqueItems":true,"items":{"required":["id","type","attributes","links"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["attachments"]},"attributes":{"type":"object","required":["message_id","name"],"properties":{"message_id":{"type":"integer"},"name":{"type":"string"}}},"links":{"$ref":"#/definitions/LinksDownload"}}}}}},"DataAttributes":{"type":"object","required":["id","type","attributes","links"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["messages","message_drafts"]},"attributes":{"$ref":"#/definitions/MessageAttributes"},"links":{"$ref":"#/definitions/LinksSelf"}}},"DataAttributesWithRelationships":{"type":"object","required":["id","type","attributes","relationships","links"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["messages","message_drafts"]},"attributes":{"$ref":"#/definitions/MessageAttributes"},"relationships":{"$ref":"#/definitions/Relationships"},"links":{"$ref":"#/definitions/LinksSelf"}}},"MessageAttributes":{"type":"object","required":["message_id","category","subject","body","attachment","sent_date","sender_id","sender_name","recipient_id","recipient_name","read_receipt"],"properties":{"message_id":{"type":"integer"},"category":{"type":"string"},"subject":{"type":"string"},"body":{"type":["null","string"]},"attachment":{"type":"boolean"},"sent_date":{"type":["null","string"]},"sender_id":{"type":"integer"},"sender_name":{"type":"string"},"recipient_id":{"type":"integer"},"recipient_name":{"type":"string"},"read_receipt":{"type":["null","string"]},"triage_group_name":{"type":["null","string"]},"proxy_sender_name":{"type":["null","string"]}}},"Relationships":{"type":"object","required":["attachments"],"properties":{"attachments":{"type":"object","required":["data"],"properties":{"data":{"type":"array","minItems":0,"uniqueItems":true,"items":{"required":["id","type"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["attachments"]}}}}}}}},"Categories":{"required":["data"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["categories"]},"attributes":{"type":"object","required":["message_category_type"],"properties":{"message_category_type":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"string"}}}}}}}},"MessageInput":{"type":"object","required":["subject","category","recipient_id","body"],"properties":{"draft_id":{"type":"integer"},"subject":{"type":"string"},"category":{"type":"string"},"recipient_id":{"type":"integer"},"body":{"type":"string"}}},"AttachmentsInput":{"type":"array"},"MetaPagination":{"type":"object","required":["pagination"],"properties":{"pagination":{"$ref":"#/definitions/Pagination"}}},"MetaFailedStationList":{"type":"object","required":["updated_at","failed_station_list"],"properties":{"updated_at":{"type":"string"},"failed_station_list":{"type":"string"}}},"MetaFailedStationListSortPagination":{"type":"object","required":["updated_at","failed_station_list","sort","pagination"],"properties":{"updated_at":{"type":"string"},"failed_station_list":{"type":["null","string"]},"pagination":{"$ref":"#/definitions/Pagination"}}},"MetaFilterSortPagination":{"type":"object","required":["filter","sort","pagination"],"properties":{"pagination":{"$ref":"#/definitions/Pagination"}}},"MetaSortPagination":{"type":"object","required":["sort","pagination"],"properties":{"pagination":{"$ref":"#/definitions/Pagination"}}},"MetaSort":{"type":"object","required":["sort"],"properties":{"pagination":{"$ref":"#/definitions/Sort"}}},"Filter":{"type":"object"},"Sort":{"type":"object"},"Pagination":{"type":"object","required":["current_page","per_page","total_pages","total_entries"],"properties":{"current_page":{"type":"integer"},"per_page":{"type":"integer"},"total_pages":{"type":"integer"},"total_entries":{"type":"integer"}}},"Prescriptions":{"required":["data","meta"],"properties":{"data":{"type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/PrescriptionBase"}},"meta":{"$ref":"#/definitions/MetaFailedStationListSortPagination"},"links":{"$ref":"#/definitions/LinksAll"}}},"Prescription":{"required":["data","meta"],"properties":{"data":{"type":"object","$ref":"#/definitions/PrescriptionBase"},"meta":{"$ref":"#/definitions/MetaFailedStationList"}}},"PrescriptionBase":{"required":["id","type","attributes","links"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["prescriptions"]},"attributes":{"type":"object","required":["prescription_id","prescription_number","prescription_name","refill_status","refill_submit_date","refill_date","refill_remaining","facility_name","ordered_date","quantity","expiration_date","dispensed_date","station_number","is_refillable","is_trackable"],"properties":{"prescription_id":{"type":"integer"},"prescription_number":{"type":"string"},"prescription_name":{"type":"string"},"prescription_image":{"type":"string"},"refill_status":{"type":"string"},"refill_submit_date":{"type":["string","null"],"format":"date"},"refill_date":{"type":"string","format":"date"},"refill_remaining":{"type":"integer"},"facility_name":{"type":"string"},"ordered_date":{"type":"string","format":"date"},"quantity":{"type":"string"},"expiration_date":{"type":"string","format":"date"},"dispensed_date":{"type":["string","null"],"format":"date"},"sorted_dispensed_date":{"type":["string","null"],"format":"date"},"station_number":{"type":"string"},"is_refillable":{"type":"boolean"},"is_trackable":{"type":"boolean"},"renewal_submitted_timestamp":{"type":["integer","null"]}}},"links":{"$ref":"#/definitions/LinksSelf"}}},"Trackings":{"required":["data","meta","links"],"properties":{"data":{"type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/Tracking"}},"meta":{"$ref":"#/definitions/MetaFailedStationListSortPagination"},"links":{"$ref":"#/definitions/LinksAll"}}},"Tracking":{"required":["id","type","attributes","links"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["trackings"]},"attributes":{"type":"object","$ref":"#/definitions/TrackingBase"},"links":{"type":"object","$ref":"#/definitions/LinksTracking"}}},"TrackingBase":{"required":["tracking_number","prescription_id","prescription_number","prescription_name","facility_name","rx_info_phone_number","ndc_number","shipped_date","delivery_service"],"properties":{"tracking_number":{"type":"string"},"prescription_id":{"type":"integer"},"prescription_number":{"type":"string"},"prescription_name":{"type":"string"},"facility_name":{"type":"string"},"rx_info_phone_number":{"type":"string"},"ndc_number":{"type":"string"},"shipped_date":{"type":"string","format":"date"},"delivery_service":{"type":"string"},"other_prescriptions":{"type":"array","items":{"$ref":"#/definitions/OtherPrescription"}}}},"OtherPrescription":{"required":["prescription_name","prescription_number","ndc_number","station_number"],"properties":{"prescription_name":{"type":"string"},"prescription_number":{"type":"string"},"ndc_number":{"type":"string"},"station_number":{"type":"string"}}},"TriageTeams":{"required":["data","meta"],"properties":{"data":{"type":"array","minItems":1,"uniqueItems":true,"items":{"$ref":"#/definitions/TriageTeamsBase"}},"meta":{"$ref":"#/definitions/MetaSort"}}},"TriageTeamsBase":{"required":["id","type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["triage_teams"]},"attributes":{"type":"object","required":["triage_team_id","name","relation_type"],"properties":{"triage_team_id":{"type":"integer"},"name":{"type":"string"},"relation_type":{"type":"string"}}}}},"IntentToFileBase":{"required":["id","creation_date","expiration_date","participant_id","source","status","type"],"properties":{"id":{"type":"string","example":"1"},"creation_date":{"type":"string","example":"2018-01-21T19:53:45.810+00:00"},"expiration_date":{"type":"string","example":"2018-02-21T19:53:45.810+00:00"},"participant_id":{"type":"integer","example":1},"source":{"type":"string","example":"EBN"},"status":{"type":"string","enum":["active","claim_recieved","duplicate","expired","incomplete","canceled"],"example":"active"},"type":{"type":"string","enum":["compensation","pension","survivor"],"example":"compensation"}}},"IntentToFiles":{"properties":{"data":{"type":"object","properties":{"attributes":{"type":"object","required":["intent_to_file"],"properties":{"intent_to_file":{"type":"array","items":{"$ref":"#/definitions/IntentToFileBase"}}}},"id":{"type":"string","example":null},"type":{"type":"string","example":"intent_to_file"}}}}},"IntentToFile":{"properties":{"data":{"type":"object","properties":{"attributes":{"type":"object","required":["intent_to_file"],"properties":{"intent_to_file":{"type":"object","$ref":"#/definitions/IntentToFileBase"}}},"id":{"type":"string","example":null},"type":{"type":"string","example":"intent_to_file"}}}}},"LetterBeneficiary":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["benefit_information","military_service"],"properties":{"benefit_information":{"type":"object","properties":{"has_non_service_connected_pension":{"type":"boolean","example":true},"has_service_connected_disabilities":{"type":"boolean","example":true},"has_survivors_indemnity_compensation_award":{"type":"boolean","example":true},"has_survivors_pension_award":{"type":"boolean","example":true},"monthly_award_amount":{"type":"number","example":123.5},"service_connected_percentage":{"type":"integer","example":2},"award_effective_date":{"type":"string","example":true},"has_adapted_housing":{"type":["boolean","null"],"example":true},"has_chapter35_eligibility":{"type":["boolean","null"],"example":true},"has_death_result_of_disability":{"type":["boolean","null"],"example":true},"has_individual_unemployability_granted":{"type":["boolean","null"],"example":true},"has_special_monthly_compensation":{"type":["boolean","null"],"example":true}}},"military_service":{"items":{"properties":{"branch":{"type":"string","example":"ARMY"},"character_of_service":{"type":"string","enum":["HONORABLE","OTHER_THAN_HONORABLE","UNDER_HONORABLE_CONDITIONS","GENERAL","UNCHARACTERIZED","UNCHARACTERIZED_ENTRY_LEVEL","DISHONORABLE"],"example":"HONORABLE"},"entered_date":{"type":"string","example":"1973-01-01T05:00:00.000+00:00"},"released_date":{"type":"string","example":"1977-10-01T04:00:00.000+00:00"}}}}}},"id":{"type":"string","example":null},"type":{"type":"string","example":"evss_letters_letter_beneficiary_response"}}}}},"Letters":{"required":["data"],"properties":{"data":{"type":"object","properties":{"attributes":{"type":"object","required":["letters","full_name"],"properties":{"letters":{"type":"array","items":{"$ref":"#/definitions/Letter"}},"full_name":{"type":"string","example":"Mark Webb"}}},"id":{"type":"string","example":null},"type":{"type":"string","example":"evss_letters_letters_response"}}}}},"Letter":{"required":["name","letter_type"],"properties":{"name":{"type":"string","example":"Proof of Service Letter"},"letter_type":{"type":"string","enum":["commissary","proof_of_service","medicare_partd","minimum_essential_coverage","service_verification","civil_service","benefit_summary","benefit_summary_dependent","benefit_verification","certificate_of_eligibility","foreign_medical_program"],"example":"proof_of_service"}}},"MaintenanceWindows":{"required":["data"],"properties":{"data":{"type":"array","items":{"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"external_service":{"type":"string"},"start_time":{"type":"string","format":"date"},"end_time":{"type":"string","format":"date"},"description":{"type":"string"}}}}}}}},"OnsiteNotification":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"template_id":{"type":"string"},"va_profile_id":{"type":"string"},"dismissed":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}},"PhoneNumber":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"number":{"type":"string","example":"4445551212"},"extension":{"type":"string","example":"101"},"country_code":{"type":"string","example":"1"},"effective_date":{"type":"string","example":"2018-03-26T15:41:37.487Z"}}}}}}},"SavedForm":{"required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"form":{"type":"string"},"submitted_at":{"type":"string"},"regional_office":{"type":"array"},"confirmation_number":{"type":"string"}}}}}}},"CSPAuthFormResponse":{"properties":{"data":{"type":"string"}},"example":"<form id=\"oauth-form\" action=\"https://idp.int.identitysandbox.gov/openid_connect/authorize\" accept-charset=\"UTF-8\" method=\"get\">\n<input type=\"hidden\" name=\"acr_values\" id=\"acr_values\" value=\"http://idmanagement.gov/ns/assurance/ial/2\" autocomplete=\"off\" />\n<input type=\"hidden\" name=\"client_id\" id=\"client_id\" value=\"urn:gov:gsa:openidconnect.profiles:sp:sso:va:dev_signin\" autocomplete=\"off\" />\n<input type=\"hidden\" name=\"nonce\" id=\"nonce\" value=\"11eb8f30f120e16ccdab1327bcf031f6\" autocomplete=\"off\" />\n<input type=\"hidden\" name=\"prompt\" id=\"prompt\" value=\"select_account\" autocomplete=\"off\" />\n<input type=\"hidden\" name=\"redirect_uri\" id=\"redirect_uri\" value=\"http://localhost:3000/sign_in/logingov/callback\" autocomplete=\"off\" />\n<input type=\"hidden\" name=\"response_type\" id=\"response_type\" value=\"code\" autocomplete=\"off\" />\n<input type=\"hidden\" name=\"scope\" id=\"scope\" value=\"profile email openid social_security_number\" autocomplete=\"off\" />\n<input type=\"hidden\" name=\"state\" id=\"state\" value=\"d940a929b7af6daa595707d0c99bec57\" autocomplete=\"off\" />\n<noscript>\n<div> <input type=”submit” value=”Continue”/> </div>\n</noscript>\n</form>\n<script nonce=\"**CSP_NONCE**\">\n(function() {\ndocument.getElementById(\"oauth-form\").submit();\n})();\n</script>\n"},"TokenResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"access_token":{"description":"Access token, used to obtain user attributes - 5 minute expiration","type":"string","example":"eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJ2YS5nb3Ygc2lnbiBpbiIsImF1ZCI6InZhbW9iaWxlIiwiY2xpZW50X2lkIjoidmFtb2JpbGUiLCJqdGkiOiJkYTllMzY5Ny0zNmYzLTRlZGMtODZmZC03YzQyNDJhMzFmZTIiLCJzdWIiOiJkOTM3NjIyMi1jMjk0LTQwZGEtODI5MC05NmNmNjExYWRmY2MiLCJleHAiOjE2NTI3MjE3OTYsImlhdCI6MTY1MjcyMTQ5Niwic2Vzc2lvbl9oYW5kbGUiOiJlNmM4NTc5ZC04MDQxLTQ4MzYtOWJmYS1mOTAwNzk2NDMzNjYiLCJyZWZyZXNoX3Rva2VuX2hhc2giOiI4YTE4ZTJjNDRjNzRiNTBlYThlY2YzZmQ4MmFjNmYwMGE5ZjNhOTJjOTI0ZjAzYzM4ZDVhOWU5YWJiOWZlMzdiIiwicGFyZW50X3JlZnJlc2hfdG9rZW5faGFzaCI6ImVlZjcxZDY1OWE5NDQ5YTA4ODE1MWM1NmFkMzgwZTA5ZThmYTQ2YTc2ODhmYWY0MmUwODNlY2UzYjUwYjVjZDgiLCJhbnRpX2NzcmZfdG9rZW4iOiI3YzhmMzYyZjQ1ODk0MzMzMTRkNmRjOGU2Mzc4ODAwZCIsImxhc3RfcmVnZW5lcmF0aW9uX3RpbWUiOjE2NTI3MjE0OTYsInZlcnNpb24iOiJWMCJ9.TMQ02cRwu6hUGI07r_wjsTbz7Z6FBQPyrSOn2tZaUL401Yd6SqzRhe4FM_LBSG6Qju7bEdbH-J5PcnWsNoLnptr27c62jxl2LOw_p-jOPJrqHK8wrTODhH6Pu58KTmklnGovBUniiyRYipu1eTehuoOc6zaZKq4IYsQOEWWWNTG_jL5_CxD2W7_bLmffxQ49UbwNfkQg3lAZcRBEbB8DYEf8ay3HEEWoeGY5LLLyUnzT9vuEtdJVttvGItQWTTC1k4_ZqNqKzpRabx3utSlv65ZAYZQqDYSV50KsI6CQj9iuBfWtz-JvhzrXvBa3CwJdPFWueaEZNZr5OyB1zFg5NQ"},"refresh_token":{"description":"Refresh token, used to refresh a session and obtain new tokens - 30 minute expiration","type":"string","example":"v1:insecure+data+A6ZXlKMWMyVnlYM1YxYVdRaU9pSmtPVE0zTmpJeU1pMWpNamswTFRRd1pHRXRPREk1TUMwNU5tTm1OakV4WVdSbVkyTWlMQ0p6WlhOemFXOXVYMmhoYm1Sc1pTSTZJbVUyWXpnMU56bGtMVGd3TkRFdE5EZ3pOaTA1WW1aaExXWTVNREEzT1RZME16TTJOaUlzSW5CaGNtVnVkRjl5WldaeVpYTm9YM1J2YTJWdVgyaGhjMmdpT2lKbFpXWTNNV1EyTlRsaE9UUTBPV0V3T0RneE5URmpOVFpoWkRNNE1HVXdPV1U0Wm1FME5tRTNOamc0Wm1GbU5ESmxNRGd6WldObE0ySTFNR0kxWTJRNElpd2lZVzUwYVY5amMzSm1YM1J2YTJWdUlqb2lOMk00WmpNMk1tWTBOVGc1TkRNek16RTBaRFprWXpobE5qTTNPRGd3TUdRaUxDSnViMjVqWlNJNklqazNObUU0WVdOaE9UZG1NRFl5TjJVM1ltUm1ZamRpTW1NMFpUbGhOMlZpSWl3aWRtVnljMmx2YmlJNklsWXdJaXdpZG1Gc2FXUmhkR2x2Ymw5amIyNTBaWGgwSWpwdWRXeHNMQ0psY25KdmNuTWlPbnQ5ZlE9PQ==.976a8aca97f0627e7bdfb7b2c4e9a7eb.V0"},"anti_csrf_token":{"description":"Anti CSRF token, used to match `refresh` calls with the `token` call that generated the refresh token used - currently disabled, this can be ignored","type":"string","example":"7c8f362f4589433314d6dc8e6378800d"}}}}},"LogoutRedirectResponse":{"type":"string","example":"https://idp.int.identitysandbox.gov/openid_connect/logout?id_token_hint=eyJraWQiOiJmNWNlMTIzOWUzOWQzZGE4MzZmOTYzYmNjZDg1Zjg1ZDU3ZDQzMzVjZmRjNmExNzAzOWYyNzQzNjFhMThiMTNjIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIzMjNlZDlmYi05ZDQxLTQwNjQtYjgyYS03NjQ3YjgzNjRlZTIiLCJpc3MiOiJodHRwczovL2lkcC5pbnQuaWRlbnRpdHlzYW5kYm94Lmdvdi8iLCJlbWFpbCI6InZldHMuZ292LnVzZXIrMTUwQGdtYWlsLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJnaXZlbl9uYW1lIjoiV0lMTEFSRCIsImZhbWlseV9uYW1lIjoiUklMRVkiLCJiaXJ0aGRhdGUiOiIxOTU5LTAyLTI1Iiwic29jaWFsX3NlY3VyaXR5X251bWJlciI6Ijc5NjAxMzE0NSIsImFkZHJlc3MiOnsiZm9ybWF0dGVkIjoiMTIzIFRlc3QgU3RyZWV0XG5XYWxkb3JmLCBNRCAyMDYwMyIsInN0cmVldF9hZGRyZXNzIjoiMTIzIFRlc3QgU3RyZWV0IiwibG9jYWxpdHkiOiJXYWxkb3JmIiwicmVnaW9uIjoiTUQiLCJwb3N0YWxfY29kZSI6IjIwNjAzIn0sInZlcmlmaWVkX2F0IjoxNjM4NTUyMDI3LCJhY3IiOiJodHRwOi8vaWRtYW5hZ2VtZW50Lmdvdi9ucy9hc3N1cmFuY2UvaWFsLzIiLCJub25jZSI6IjdmYTMyOWJkYjE5ODBkM2YwNmEwOGI1ODI3ZWVlYTE0IiwiYXVkIjoiaHR0cHM6Ly9zcWEuZWF1dGgudmEuZ292L2lzYW0vc3BzL3NhbWwyMHNwL3NhbWwyMCIsImp0aSI6Il85NmJYb3JWN2tPTjdNU1VzRUIwLWciLCJhdF9oYXNoIjoibE14VnQtSGlrUzcwQVlHYWtUX3RaUSIsImNfaGFzaCI6IlcyTU9wNVc5OFVUdzZISDE4Y0FmR3ciLCJleHAiOjE2NjUwMDI0ODYsImlhdCI6MTY2NTAwMTU4NiwibmJmIjoxNjY1MDAxNTg2fQ.U8tRWJTUNksru-ZVXvxDHSrUJvcfWKl89n96gxH3wlDquGDkxk7_JOMm6yDtHPfcuO6ij8JqKgMAhYW31Di2OnRdecdbgxz0j883KFeOYCgitv2dkSqNmQOTMXlFK170cWEpXb_oUiEPTAWy9f06XlIhrtk_kIc69SnXVh0AOJXAixTIyYbp6eUy5tMkBsa84dyM8OcvbnRmarAKSP36w1SYCLp0nX6jIXggyOvJL3FnX4UOA-w5MswboQcfGhOvAS3mYoJuoAogy1k7ybxAC04HqfqKgcbJ7TE-4xtdXAZ0qCSnEh7klqMhTJQ2iDAUdEaS_lK2dF8IR0KKGHCulA&post_logout_redirect_uri=http%3A%2F%2Flocalhost%3A3001&state=746e60841b6d736137dc190ac64b417a"},"UserAttributesResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","example":""},"type":{"type":"string","example":"users"},"attributes":{"type":"object","properties":{"uuid":{"type":"string","example":"d9376222-c294-40da-8290-96cf611adfcc"},"first_name":{"type":"string","example":"ALFREDO"},"middle_name":{"type":"string","example":"MATTHEW"},"last_name":{"type":"string","example":"ARMSTRONG"},"birth_date":{"type":"string","example":"1989-11-11"},"email":{"type":"string","example":"vets.gov.user+4@gmail.com"},"gender":{"type":"string","example":"M"},"ssn":{"type":"string","example":"111111111"},"birls_id":{"type":"string","example":"796121200"},"authn_context":{"type":"string","example":"logingov"},"icn":{"type":"string","example":"1012846043V576341"},"edipi":{"type":"string","example":"001001999"},"active_mhv_ids":{"type":"array","example":["12345","67890"]},"sec_id":{"type":"string","example":"1013173963"},"vet360_id":{"type":"string","example":"18277"},"participant_id":{"type":"string","example":"13014883"},"cerner_id":{"type":"string","example":"9923454432"},"cerner_facility_ids":{"type":"array","example":["200MHV"]},"vha_facility_ids":{"type":"array","example":["200ESR","648"]},"id_theft_flag":{"type":"boolean","example":false},"verified":{"type":"boolean","example":true},"access_token_ttl":{"type":"integer","example":300}}}}}}},"States":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["states"],"properties":{"states":{"type":"array","items":{"required":["name"],"properties":{"name":{"type":"string","example":"CA"}}}}}}}}}},"TravelPayClaims":{"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/definitions/TravelPayClaimSummary"}}}},"TravelPayClaimSummary":{"properties":{"id":{"type":"string","example":"33333333-5555-4444-bbbb-222222444444"},"claimNumber":{"type":"string","example":"TC1234123412341234"},"claimStatus":{"type":"string","enum":["Pre approved for payment","Saved","In process","Pending","On hold","In manual review","Submitted for payment","Claim paid","Incomplete","Appeal","Denied","Closed with no payment","Claim submitted","Approved for payment","Approved for payment incomplete","Payment canceled","Partial payment","Fiscal rescinded","Unspecified"],"example":"Claim paid"},"appointmentDateTime":{"type":"string","example":"2024-06-13T13:57:07.291Z"},"facilityName":{"type":"string","example":"Cheyenne VA Medical Center"},"createdOn":{"type":"string","example":"2024-06-13T13:57:07.291Z"},"modifiedOn":{"type":"string","example":"2024-06-13T13:57:07.291Z"}}},"TravelPayClaimDetails":{"properties":{"id":{"type":"string","example":"33333333-5555-4444-bbbb-222222444444"},"claimNumber":{"type":"string","example":"TC1234123412341234"},"claimStatus":{"type":"string","enum":["Pre approved for payment","Saved","In process","Pending","On hold","In manual review","Submitted for payment","Claim paid","Incomplete","Appeal","Denied","Closed with no payment","Claim submitted","Approved for payment","Approved for payment incomplete","Payment canceled","Partial payment","Fiscal rescinded","Unspecified"],"example":"Claim paid"},"appointmentDate":{"type":"string","example":"2024-06-13T13:57:07.291Z"},"claimName":{"type":"string","example":"Claim created for NOLLE BARAKAT"},"claimantFirstName":{"type":"string","example":"Nolle"},"claimantMiddleName":{"type":"string","example":"Polite"},"claimantLastName":{"type":"string","example":"Varakat"},"facilityName":{"type":"string","example":"Cheyenne VA Medical Center"},"totalCostRequested":{"type":"number","example":20.0},"reimbursementAmount":{"type":"number","example":14.52},"appointment":{"type":"object","$ref":"#/definitions/TravelPayAppointment"},"expenses":{"type":"array","items":{"$ref":"#/definitions/TravelPayExpense"}},"documents":{"type":"array","items":{"$ref":"#/definitions/TravelPayDocumentSummary"}},"createdOn":{"type":"string","example":"2024-06-13T13:57:07.291Z"},"modifiedOn":{"type":"string","example":"2024-06-13T13:57:07.291Z"}}},"TravelPayAppointment":{"properties":{"id":{"type":"string","example":"33333333-5555-4444-bbbb-222222444444"},"appointmentSource":{"type":"string","example":"VISTA"},"appointmentDateTime":{"type":"string","example":"2024-06-13T13:57:07.291Z"},"appointmentName":{"type":"string","example":"VistA - 983 CHY TEST CLINIC"},"appointmentType":{"type":"string","example":"EnvironmentalHealth"},"facilityId":{"type":"string","example":"33333333-5555-4444-bbbb-222222444444"},"facilityName":{"type":"string","example":"Cheyenne VA Medical Center"},"serviceConnectedDisability":{"type":"number","example":421750001},"currentStatus":{"type":"string","example":"CHECKED OUT"},"appointmentStatus":{"type":"string","example":"Complete"},"externalAppointmentId":{"type":"string","example":"A;3250113.083;1414"},"associatedClaimId":{"type":"string","example":"TC1234123412341234"},"associatedClaimNumber":{"type":"string","example":"TC1234123412341234"},"isCompleted":{"type":"boolean","example":true},"createdOn":{"type":"string","example":"2024-06-13T13:57:07.291Z"},"modifiedOn":{"type":"string","example":"2024-06-13T13:57:07.291Z"}}},"TravelPayExpense":{"properties":{"id":{"type":"string","example":"33333333-5555-4444-bbbb-222222444444"},"expenseType":{"type":"string","example":"Mileage"},"name":{"type":"string","example":"My trip"},"dateIncurred":{"type":"string","example":"2024-06-13T13:57:07.291Z"},"description":{"type":"string","example":"mileage-expense"},"costRequested":{"type":"number","example":20.0},"costSubmitted":{"type":"number","example":20.0}}},"TravelPayDocumentSummary":{"properties":{"documentId":{"type":"string","example":"33333333-5555-4444-bbbb-222222444444"},"filename":{"type":"string","example":"DecisionLetter.pdf"},"mimetype":{"type":"string","example":"application/pdf"},"createdon":{"type":"string","example":"2024-06-13T13:57:07.291Z"}}},"TravelPayDocumentBinary":{"properties":{"data":{"type":"string","example":"VGhpcyBpcyBhIHN0cmluZw=="}}},"UploadSupportingEvidence":{"properties":{"data":{"type":"object","properties":{"attributes":{"type":"object","required":["guid"],"properties":{"guid":{"type":"string","example":"3c05b2f0-0715-4298-965d-f733465ed80a"},"warnings":{"type":"array","description":"Present only when attachment_id is provided and the disability_526_document_validation_enabled feature flag is active. Empty array means no issues detected.","items":{"type":"string","enum":["wrong_form","unable_to_validate"]}}}},"id":{"type":"string","example":"11"},"type":{"type":"string","example":"supporting_evidence_attachments"}}}}},"UserInternalServices":{"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"services":{"type":"array","example":["gibs","facilities","hca","edu-benefits","evss-claims","appeals-status","user-profile","id-card","identity-proofed","vet360","rx","messaging","health-records","mhv-accounts","form-save-in-progress","form-prefill"],"items":{"type":"string"}},"in_progress_forms":{"type":"array","items":{"properties":{"form":{"type":"string"},"metadata":{"type":"object","properties":{"version":{"type":"integer"},"return_url":{"type":"string"},"expires_at":{"type":"integer"},"last_updated":{"type":"integer"}}},"last_updated":{"type":"integer"}}}},"profile":{"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string","example":"Abigail"},"middle_name":{"type":"string","example":"Jane"},"last_name":{"type":"string","example":"Brown"},"preferred_name":{"type":["string","null"],"example":"Abby"},"birth_date":{"type":"string","example":"1900-01-01"},"gender":{"type":"string","example":"F"},"zip":{"type":["string","null"],"description":"The user's zip code from MPI"},"multifactor":{"type":"boolean","example":true,"description":"ID.me boolean value if the signed-in 'wallet' has multifactor enabled"},"last_signed_in":{"type":"string","example":"2019-10-02T13:55:54.261Z"},"initial_sign_in":{"type":"string","example":"2019-10-02T13:55:54.261Z"},"authn_context":{"enum":["myhealthevet","myhealthevet_loa3","myhealthevet_multifactor","http://idmanagement.gov/ns/assurance/loa/1/vets","http://idmanagement.gov/ns/assurance/loa/3/vets"],"example":"myhealthevet_loa3","description":"The login method of a user."},"sign_in":{"type":"object","properties":{"service_name":{"type":"string","enum":["mhv","idme","logingov"],"example":"mhv","description":"The name of the service that the user used for the beginning of the\n                                       authentication process (username + password)"},"account_type":{"enum":["Basic","Premium"],"example":"Basic","description":"myhealthevet account_types: Basic, Premium."},"ssoe":{"type":"boolean","description":"true if the user was authenticated using SSOe"},"transactionid":{"type":"string","example":"E35imPCwyUBl/Eo4AhlCJfioOcQEWDdyjFXUJRBky1k=","description":"a unique id representing the authentication transaction with SSOe"}}},"verified":{"type":"boolean","example":true},"loa":{"type":"object","properties":{"current":{"type":"integer","format":"int32","example":3,"description":"NIST level of assurance, either 1 or 3"},"highest":{"type":"integer","format":"int32","example":3,"description":"level of assurance - During the login flow reference 'highest', otherwise, use\n                                       'current'"}}}}},"onboarding":{"type":"object","properties":{"show":{"type":"boolean","description":"Whether the client should display Veteran Onboarding information"}}},"prefills_available":{"type":"array","items":{"type":"string"}},"session":{"type":"object","properties":{"ssoe":{"type":"boolean"},"transactionid":{"type":["string","null"]}}}}}}}}},"Permission":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"permission_type":{"type":"string","example":"TextPermission"},"permission_value":{"type":"boolean","example":true}}}}}}},"ValidVAFileNumber":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"valid_va_file_number":{"type":"boolean","example":true}}}}}}},"PaymentHistory":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","properties":{"payments":{"type":"array","example":[{"pay_check_dt":"2017-12-29T00:00:00.000-06:00","pay_check_amount":"$3,261.10","pay_check_type":"Compensation & Pension - Recurring","payment_method":"Direct Deposit","bank_name":"NAVY FEDERAL CREDIT UNION","account_number":"***4567"}]},"return_payments":{"type":"array","example":[{"returned_check_issue_dt":"2012-12-15T00:00:00.000-06:00","returned_check_cancel_dt":"2013-01-01T00:00:00.000-06:00","returned_check_amount":"$50.00","returned_check_number":"12345678","returned_check_type":"CH31 VR&E","return_reason":"Other Reason"}]}}}}}}},"Vet360AddressSuggestion":{"type":"object","required":["address_line1","city","country_code_iso3","address_type"],"properties":{"address_line1":{"type":"string","example":"1493 Martin Luther King Rd","maxLength":35},"address_line2":{"type":"string","maxLength":35},"address_line3":{"type":"string","maxLength":35},"address_pou":{"type":"string","enum":["RESIDENCE","CORRESPONDENCE"],"example":"RESIDENCE"},"address_type":{"type":"string","enum":["DOMESTIC","INTERNATIONAL","OVERSEAS MILITARY"],"example":"DOMESTIC"},"city":{"type":"string","example":"Fulton","maxLength":100},"country_code_iso3":{"type":"string","example":"USA","minLength":3,"maxLength":3},"international_postal_code":{"type":"string","example":"12345"},"province":{"type":"string"},"state_code":{"type":"string","example":"MS","minLength":2,"maxLength":2},"zip_code":{"type":"string","example":"38843","minLength":5,"maxLength":5},"zip_code_suffix":{"type":"string","example":"1234","minLength":4,"maxLength":4}}},"PostVet360DomesticAddress":{"properties":{"override_validation_key":{"type":"integer"},"address_line1":{"type":"string","example":"1493 Martin Luther King Rd","maxLength":35,"pattern":"US-ASCII"},"address_line2":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"address_line3":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"address_pou":{"type":"string","enum":["RESIDENCE","CORRESPONDENCE"],"example":"RESIDENCE"},"address_type":{"type":"string","enum":["DOMESTIC","INTERNATIONAL","OVERSEAS MILITARY"],"example":"DOMESTIC"},"city":{"type":"string","example":"Fulton","maxLength":100},"country_name":{"type":"string","example":"United States","pattern":"/[a-zA-Z ]+/"},"state_code":{"type":"string","example":"MS","minLength":2,"maxLength":2,"pattern":"/[a-zA-Z ]+/"},"zip_code":{"type":"string","example":"38843","maxLength":5,"pattern":"/[0-9]+/"}},"required":["address_line1","address_pou","address_type","city","country_name","state_code","zip_code"]},"PutVet360DomesticAddress":{"properties":{"override_validation_key":{"type":"integer"},"address_line1":{"type":"string","example":"1493 Martin Luther King Rd","maxLength":35,"pattern":"US-ASCII"},"address_line2":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"address_line3":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"id":{"type":"integer","example":1},"address_pou":{"type":"string","enum":["RESIDENCE","CORRESPONDENCE"],"example":"RESIDENCE"},"address_type":{"type":"string","enum":["DOMESTIC","INTERNATIONAL","OVERSEAS MILITARY"],"example":"DOMESTIC"},"city":{"type":"string","example":"Fulton","maxLength":100},"country_name":{"type":"string","example":"United States","pattern":"/[a-zA-Z ]+/"},"state_code":{"type":"string","example":"MS","minLength":2,"maxLength":2,"pattern":"/[a-zA-Z ]+/"},"zip_code":{"type":"string","example":"38843","maxLength":5,"pattern":"/[0-9]+/"}},"required":["address_line1","address_pou","address_type","city","country_name","id","state_code","zip_code"]},"PostVet360InternationalAddress":{"properties":{"override_validation_key":{"type":"integer"},"address_line1":{"type":"string","example":"1493 Martin Luther King Rd","maxLength":35,"pattern":"US-ASCII"},"address_line2":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"address_line3":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"address_pou":{"type":"string","enum":["RESIDENCE","CORRESPONDENCE"],"example":"RESIDENCE"},"address_type":{"type":"string","enum":["DOMESTIC","INTERNATIONAL","OVERSEAS MILITARY"],"example":"INTERNATIONAL"},"city":{"type":"string","example":"Florence","maxLength":100},"country_name":{"type":"string","example":"Italy","pattern":"/[a-zA-Z ]+/"},"international_postal_code":{"type":"string","example":"12345"}},"required":["address_line1","address_pou","address_type","international_postal_code","city","country_name"]},"PutVet360InternationalAddress":{"properties":{"override_validation_key":{"type":"integer"},"address_line1":{"type":"string","example":"1493 Martin Luther King Rd","maxLength":35,"pattern":"US-ASCII"},"address_line2":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"address_line3":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"id":{"type":"integer","example":1},"address_pou":{"type":"string","enum":["RESIDENCE","CORRESPONDENCE"],"example":"RESIDENCE"},"address_type":{"type":"string","enum":["DOMESTIC","INTERNATIONAL","OVERSEAS MILITARY"],"example":"INTERNATIONAL"},"city":{"type":"string","example":"Florence","maxLength":100},"country_name":{"type":"string","example":"Italy","pattern":"/[a-zA-Z ]+/"},"international_postal_code":{"type":"string","example":"12345"}},"required":["address_line1","address_pou","address_type","id","international_postal_code","city","country_name"]},"PostVet360MilitaryOverseasAddress":{"properties":{"override_validation_key":{"type":"integer"},"address_line1":{"type":"string","example":"1493 Martin Luther King Rd","maxLength":35,"pattern":"US-ASCII"},"address_line2":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"address_line3":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"address_pou":{"type":"string","enum":["RESIDENCE","CORRESPONDENCE"],"example":"RESIDENCE"},"address_type":{"type":"string","enum":["DOMESTIC","INTERNATIONAL","OVERSEAS MILITARY"],"example":"OVERSEAS MILITARY"},"city":{"type":"string","example":"Fulton","maxLength":100},"country_name":{"type":"string","example":"United States","pattern":"/[a-zA-Z ]+/"},"state_code":{"type":"string","example":"MS","minLength":2,"maxLength":2,"pattern":"/[a-zA-Z ]+/"},"zip_code":{"type":"string","example":"38843","maxLength":5,"pattern":"/[0-9]+/"}},"required":["address_line1","address_pou","address_type","city","country_name","state_code","zip_code"]},"PutVet360MilitaryOverseasAddress":{"properties":{"override_validation_key":{"type":"integer"},"address_line1":{"type":"string","example":"1493 Martin Luther King Rd","maxLength":35,"pattern":"US-ASCII"},"address_line2":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"address_line3":{"type":"string","maxLength":35,"pattern":"US-ASCII"},"id":{"type":"integer","example":1},"address_pou":{"type":"string","enum":["RESIDENCE","CORRESPONDENCE"],"example":"RESIDENCE"},"address_type":{"type":"string","enum":["DOMESTIC","INTERNATIONAL","OVERSEAS MILITARY"],"example":"OVERSEAS MILITARY"},"city":{"type":"string","example":"Fulton","maxLength":100},"country_name":{"type":"string","example":"United States","pattern":"/[a-zA-Z ]+/"},"state_code":{"type":"string","example":"MS","minLength":2,"maxLength":2,"pattern":"/[a-zA-Z ]+/"},"zip_code":{"type":"string","example":"38843","maxLength":5,"pattern":"/[0-9]+/"}},"required":["address_line1","address_pou","address_type","city","country_name","id","state_code","zip_code"]},"PostVet360Email":{"required":["email_address"],"properties":{"email_address":{"type":"string","example":"john@example.com","minLength":6,"maxLength":255,"pattern":"/.+@.+\\..+/i"},"confirmation_date":{"type":["string","null"],"format":"date-time","example":null,"description":"Confirmation date should only be provided if the email is 'confirmed' by the user"}}},"PutVet360Email":{"required":["email_address","id"],"properties":{"id":{"type":"integer","example":1},"email_address":{"type":"string","example":"john@example.com","minLength":6,"maxLength":255,"pattern":"/.+@.+\\..+/i"},"confirmation_date":{"type":["string","null"],"format":"date-time","example":"2025-01-01T00:00:00Z","description":"Confirmation date should only be provided if the email is 'confirmed' by the user"}}},"PostVet360Telephone":{"required":["phone_number","area_code","phone_type","is_international","country_code"],"properties":{"area_code":{"type":"string","example":"303","minLength":3,"maxLength":3,"pattern":"/\\A[0-9]+\\z/","description":"The three-digit code that begins a North American Numbering Plan (NANP) phone number\n                   (U.S., Canada, and some Caribbean countries). Required when is_international is false. Set to null\n                   for non-NANP numbers."},"country_code":{"type":"string","minLength":1,"maxLength":3,"example":"1","default":"1","pattern":"/\\A[1-9][0-9]*\\z/","description":"One- to three-digit code that routes the call to the country of that phone number.\n                   Defaults to the NANP country code."},"extension":{"type":"string","example":"101","maxLength":6,"description":"One-or-more digit number that must be dialed after reaching a main number, typically at\n                   an establishment, in order to reach a specific party."},"is_international":{"type":"boolean","example":false,"default":false,"description":"Indicates phone number has a non-NANP country code."},"is_textable":{"type":"boolean","example":true,"description":"Indicates phone number is capable of receiving text messages."},"is_text_permitted":{"type":"boolean","example":true,"description":"Indicates person has granted permission to receive text messages to phone number."},"is_voicemailable":{"type":"boolean","example":true,"description":"Indicates person has granted consent to record a voice mail message on a phone number."},"phone_number":{"type":"string","example":"5551212","minLength":1,"maxLength":14,"pattern":"/\\A[0-9]+\\z/","description":"Number that follows an area code for a NANP phone number, or a country code\n                   for a non-NANP phone number."},"phone_type":{"type":"string","enum":["MOBILE","HOME","WORK","FAX","TEMPORARY"],"example":"MOBILE","description":"Describes specific type of phone number."},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z","description":"The date the source system received the last update to this bio."},"vet360_id":{"type":"integer","example":1,"description":"Unique Identifier of individual within VET360. Created by VET360 after it is validated\n                   and accepted. May be considered PII."}}},"PutVet360Telephone":{"required":["id","phone_number","area_code","phone_type","is_international","country_code"],"properties":{"id":{"type":"integer","example":1},"area_code":{"type":"string","example":"303","minLength":3,"maxLength":3,"pattern":"/\\A[0-9]+\\z/","description":"The three-digit code that begins a North American Numbering Plan (NANP) phone number\n                   (U.S., Canada, and some Caribbean countries). Required when is_international is false. Set to null\n                   for non-NANP numbers."},"country_code":{"type":"string","minLength":1,"maxLength":3,"example":"1","default":"1","pattern":"/\\A[1-9][0-9]*\\z/","description":"One- to three-digit code that routes the call to the country of that phone number.\n                   Defaults to the NANP country code."},"extension":{"type":"string","example":"101","maxLength":10,"description":"One-or-more digit number that must be dialed after reaching a main number, typically at\n                   an establishment, in order to reach a specific party."},"is_international":{"type":"boolean","example":false,"default":false,"description":"Indicates phone number has a non-NANP country code."},"is_textable":{"type":"boolean","example":true,"description":"Indicates phone number is capable of receiving text messages."},"is_text_permitted":{"type":"boolean","example":true,"description":"Indicates person has granted permission to receive text messages to phone number."},"is_voicemailable":{"type":"boolean","example":true,"description":"Indicates person has granted consent to record a voice mail message on a phone number."},"phone_number":{"type":"string","example":"5551212","minLength":1,"maxLength":14,"pattern":"/\\A[0-9]+\\z/","description":"Number that follows an area code for a NANP phone number, or a country code\n                   for a non-NANP phone number."},"phone_type":{"type":"string","enum":["MOBILE","HOME","WORK","FAX","TEMPORARY"],"example":"MOBILE","description":"Describes specific type of phone number."},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z","description":"The date the source system received the last update to this bio."},"vet360_id":{"type":"integer","example":1,"description":"Unique Identifier of individual within VET360. Created by VET360 after it is validated\n                   and accepted. May be considered PII."}}},"PostVet360Permission":{"required":["permission_type","permission_value"],"properties":{"permission_type":{"type":"string","enum":["TextPermission"],"example":"TextPermission","description":"Describes specific type of permission."},"permission_value":{"type":"boolean","example":true,"description":"Designates if Permission is granted."},"source_date":{"type":"string","format":"date-time","example":"2019-00-23T20:09:50Z","description":"The date the source system received the last update to this bio."},"vet360_id":{"type":"integer","example":1,"description":"Unique Identifier of individual within VET360. Created by VET360 after it is validated\n                   and accepted. May be considered PII."}}},"PutVet360Permission":{"required":["id","permission_type","permission_value"],"properties":{"id":{"type":"integer","example":1},"permission_type":{"type":"string","enum":["TextPermission"],"example":"TextPermission","description":"Describes specific type of permission."},"permission_value":{"type":"boolean","example":true,"description":"Designates if Permission is granted."},"source_date":{"type":"string","format":"date-time","example":"2019-00-23T20:09:50Z","description":"The date the source system received the last update to this bio."},"vet360_id":{"type":"integer","example":1,"description":"Unique Identifier of individual within VET360. Created by VET360 after it is validated\n                   and accepted. May be considered PII."}}},"PutPreferredName":{"required":["text"],"properties":{"text":{"type":"string","example":"Pat","minLength":1,"maxLength":25,"description":"Describes preferred name text."}}},"PreferredName":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"text":{"type":"string","example":"Pat"},"source_system_user":{"type":"string","example":"123498767V234859"},"source_date":{"type":"string","format":"date-time","example":"2022-04-08T15:09:23.000Z"}}}}}}},"PutGenderIdentity":{"required":["code"],"properties":{"code":{"type":"string","enum":["M","F","TM","TF","B","N","O"],"example":"F","description":"Describes gender identity code."}}},"GenderIdentity":{"properties":{"data":{"type":"object","required":["attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"code":{"type":"string","example":"F"},"name":{"type":"string","example":"Female"},"source_system_user":{"type":"string","example":"123498767V234859"},"source_date":{"type":"string","format":"date-time","example":"2022-04-08T15:09:23.000Z"}}}}}}},"Vet360ContactInformation":{"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"type":"object","properties":{"vet360_contact_information":{"type":"object","properties":{"email":{"type":"object","properties":{"id":{"type":"integer","example":323},"email_address":{"type":"string","example":"john@example.com"},"created_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"confirmation_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_end_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_start_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"updated_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"verification_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"}}},"residential_address":{"type":"object","properties":{"address_line1":{"type":"string","example":"1493 Martin Luther King Rd"},"address_line2":{"type":["string","null"]},"address_line3":{"type":["string","null"]},"address_pou":{"type":"string","example":"RESIDENCE"},"address_type":{"type":"string","enum":["DOMESTIC","INTERNATIONAL","OVERSEAS MILITARY"],"example":"DOMESTIC"},"bad_address":{"type":"boolean"},"city":{"type":"string","example":"Fulton"},"country_code_iso3":{"type":["string"],"example":"USA"},"country_code_fips":{"type":["string","null"],"example":"US"},"id":{"type":"integer","example":123},"international_postal_code":{"type":["string","null"],"example":"54321"},"latitude":{"type":["number","null"],"example":38.901},"longitude":{"type":["number","null"],"example":-77.0347},"province":{"type":["string","null"]},"state_code":{"type":"string","example":"NY"},"zip_code":{"type":"string","example":"97062"},"zip_code_suffix":{"type":["string","null"],"example":"1234"},"geocode_precision":{"type":["number","null"],"example":100.0},"geocode_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"created_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_end_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_start_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"updated_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"}}},"mailing_address":{"type":"object","properties":{"address_line1":{"type":"string","example":"1493 Martin Luther King Rd"},"address_line2":{"type":["string","null"]},"address_line3":{"type":["string","null"]},"address_pou":{"type":"string","example":"CORRESPONDENCE"},"address_type":{"type":"string","enum":["DOMESTIC","INTERNATIONAL","OVERSEAS MILITARY"],"example":"DOMESTIC"},"bad_address":{"type":"boolean"},"city":{"type":"string","example":"Fulton"},"country_code_iso3":{"type":["string"],"example":"USA"},"country_code_fips":{"type":["string","null"],"example":"US"},"id":{"type":"integer","example":123},"international_postal_code":{"type":["string","null"],"example":"54321"},"latitude":{"type":["number","null"],"example":38.901},"longitude":{"type":["number","null"],"example":-77.0347},"province":{"type":["string","null"]},"state_code":{"type":"string","example":"NY"},"zip_code":{"type":"string","example":"97062"},"zip_code_suffix":{"type":["string","null"],"example":"1234"},"geocode_precision":{"type":["number","null"],"example":100.0},"geocode_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"created_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_end_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_start_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"updated_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"}}},"mobile_phone":{"type":"object","properties":{"area_code":{"type":"string","example":"503"},"country_code":{"type":"string","example":"1"},"extension":{"type":["string","null"]},"id":{"type":"integer","example":123},"is_international":{"type":"boolean"},"is_textable":{"type":"boolean"},"is_tty":{"type":"boolean"},"is_voicemailable":{"type":"boolean"},"phone_number":{"type":"string","example":"5551234"},"phone_type":{"type":"string","example":"MOBILE"},"created_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_end_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_start_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"updated_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"}}},"home_phone":{"type":"object","properties":{"area_code":{"type":"string","example":"503"},"country_code":{"type":"string","example":"1"},"extension":{"type":["string","null"]},"id":{"type":"integer","example":123},"is_international":{"type":"boolean"},"is_textable":{"type":"boolean"},"is_tty":{"type":"boolean"},"is_voicemailable":{"type":"boolean"},"phone_number":{"type":"string","example":"5551234"},"phone_type":{"type":"string","example":"HOME"},"created_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_end_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_start_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"updated_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"}}},"work_phone":{"type":"object","properties":{"area_code":{"type":"string","example":"503"},"country_code":{"type":"string","example":"1"},"extension":{"type":["string","null"]},"id":{"type":"integer","example":123},"is_international":{"type":"boolean"},"is_textable":{"type":"boolean"},"is_tty":{"type":"boolean"},"is_voicemailable":{"type":"boolean"},"phone_number":{"type":"string","example":"5551234"},"phone_type":{"type":"string","example":"WORK"},"created_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_end_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_start_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"updated_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"}}},"temporary_phone":{"type":"object","properties":{"area_code":{"type":"string","example":"503"},"country_code":{"type":"string","example":"1"},"extension":{"type":["string","null"]},"id":{"type":"integer","example":123},"is_international":{"type":"boolean"},"is_textable":{"type":"boolean"},"is_tty":{"type":"boolean"},"is_voicemailable":{"type":"boolean"},"phone_number":{"type":"string","example":"5551234"},"phone_type":{"type":"string","example":"TEMPORARY"},"created_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_end_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_start_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"updated_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"}}},"fax_number":{"type":"object","properties":{"area_code":{"type":"string","example":"503"},"country_code":{"type":"string","example":"1"},"extension":{"type":["string","null"]},"id":{"type":"integer","example":123},"is_international":{"type":"boolean"},"is_textable":{"type":"boolean"},"is_tty":{"type":"boolean"},"is_voicemailable":{"type":"boolean"},"phone_number":{"type":"string","example":"5551234"},"phone_type":{"type":"string","example":"FAX"},"created_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_end_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"effective_start_date":{"type":["string","null"],"format":"date-time","example":"2018-04-21T20:09:50Z"},"source_date":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"},"updated_at":{"type":"string","format":"date-time","example":"2018-04-21T20:09:50Z"}}},"text_permission":{"type":"object","properties":{"id":{"type":"integer","example":123},"permission_type":{"type":"string","example":"TextPermission"},"permission_value":{"type":"boolean","example":true},"created_at":{"type":"string","format":"date-time","example":"2019-00-23T20:09:50Z"},"effective_end_date":{"type":["string","null"],"format":"date-time","example":"2019-00-23T20:09:50Z"},"effective_start_date":{"type":["string","null"],"format":"date-time","example":"2019-00-23T20:09:50Z"},"source_date":{"type":"string","format":"date-time","example":"2019-00-23T20:09:50Z"},"updated_at":{"type":"string","format":"date-time","example":"2019-00-23T20:09:50Z"}}}}}}}}}}},"Vet360Countries":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["countries"],"properties":{"countries":{"type":"array","items":{"properties":{"country_name":{"type":"string","example":"Italy"},"country_code_iso3":{"type":"string","example":"ITA"}}}}}}}}}},"Vet360States":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["states"],"properties":{"states":{"type":"array","items":{"properties":{"state_name":{"type":"string","example":"Oregon"},"state_code":{"type":"string","example":"OR"}}}}}}}}}},"Vet360Zipcodes":{"required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["zipcodes"],"properties":{"zipcodes":{"type":"array","items":{"properties":{"zip_code":{"type":"string","example":"97062"}}}}}}}}}},"SchedulingPreferences":{"required":["data"],"properties":{"data":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","example":""},"type":{"type":"string","example":"scheduling_preferences"},"attributes":{"type":"object","required":["preferences"],"properties":{"preferences":{"type":"array","items":{"type":"object","required":["item_id","option_ids"],"properties":{"item_id":{"type":"integer","example":1,"description":"Scheduling preference item identifier"},"option_ids":{"type":"array","description":"Selected options for this preference item","items":{"type":"integer","example":5}}}}}}}}}}},"SchedulingPreferencesRequest":{"required":["item_id","option_ids"],"properties":{"item_id":{"type":"integer","example":1,"description":"Scheduling preference item identifier"},"option_ids":{"type":"array","description":"Options to select for this preference item","items":{"type":"integer","example":5}}}},"Facilities":{"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/definitions/Facility"}}}},"Facility":{"properties":{"id":{"type":"string","example":"vha_999"},"type":{"type":"string","example":"va_facilities"},"attributes":{"type":"object","properties":{"address":{"type":["object","array"],"description":"Physical and mailing addresses for facilities","properties":{"physical":{"$ref":"#/definitions/FacilityAddress"},"mailing":{"$ref":"#/definitions/FacilityAddress"}}},"classification":{"type":["string","null"],"example":"VA Medical Center"},"facility_type":{"type":"string","example":"va_health_facility"},"feedback":{"type":["object","array"],"properties":{"health":{"type":"object","description":"Patient satisfaction scores for health facilities","properties":{"primaryCareRoutine":{"type":"number","format":"float","example":95.2},"primaryCareUrgent":{"type":"number","format":"float","example":89.1},"specialtyCareRoutine":{"type":"number","format":"float","example":78},"specialtyCareUrgent":{"type":"number","format":"float","example":75.3}}},"effectiveDate":{"type":"string","format":"date","example":"2017-07-01"}}},"hours":{"type":["object","array"],"description":"Hours of operation for facilities","properties":{"monday":{"type":"string","example":"800AM-430PM"},"tuesday":{"type":"string","example":"800AM-430PM"},"wednesday":{"type":"string","example":"800AM-430PM"},"thursday":{"type":"string","example":"800AM-430PM"},"friday":{"type":"string","example":"800AM-430PM"},"saturday":{"type":"string","example":"Closed"},"sunday":{"type":"string","example":"Closed"}}},"id":{"type":"string","example":"vha_999"},"lat":{"type":"number","format":"float","example":-122.5},"long":{"type":"number","format":"float","example":45.5},"mobile":{"type":["boolean","null"],"example":false},"name":{"type":"string","example":"Example VAMC"},"operatingStatus":{"type":["object","array"],"description":"Current status of facility operations.","properties":{"code":{"type":"string","example":"NORMAL"},"additionalInfo":{"type":"string","example":"Additional information about the operating status."}}},"operationalHoursSpecialInstructions":{"type":["array","null"],"items":{"type":"string"}},"phone":{"type":["object","array"],"description":"Telephone numbers for facilities","properties":{"main":{"type":["string","null"],"example":"212-555-1212"},"fax":{"type":["string","null"],"example":"212-555-1212"},"afterHours":{"type":["string","null"],"example":"212-555-1212"},"patientAdvocate":{"type":["string","null"],"example":"212-555-1212"},"enrollmentCoordinator":{"type":["string","null"],"example":"212-555-1212"},"pharmacy":{"type":["string","null"],"example":"212-555-1212"},"mentalHealthClinic":{"type":["string","null"],"example":"212-555-1212 x 123"}}},"services":{"type":["object","array"],"properties":{"other":{"type":"array","items":{"type":"string"}},"health":{"type":"array","properties":{"name":{"type":["string","null"],"example":"Dermatology"},"serviceId":{"type":["string","null"],"example":"dermatology"},"link":{"type":["string","null"],"example":"http://www.example.com"}}},"link":{"type":["string","null"],"example":"http://www.example.com"},"lastUpdated":{"type":["string","null"],"example":"2017-07-01"}}},"uniqueId":{"type":"string","example":"999"},"visn":{"type":["string","null"],"example":"17"},"website":{"type":["string","null"],"example":"http://www.example.com"}}}}},"FacilityAddress":{"type":"object","properties":{"address1":{"type":["string","null"],"example":"123 Fake Street"},"address2":{"type":["string","null"],"example":"Suite 001"},"address3":{"type":["string","null"]},"city":{"type":["string","null"],"example":"Anytown"},"state":{"type":["string","null"],"example":"NY"},"zip":{"type":["string","null"],"example":"00001"}}},"Provider":{"properties":{"id":{"type":"string","example":"40c344a12877bf2dd2828067839d71d0f6affe1e076f267fdaa1aa4927c6da88"},"type":{"type":"string","example":"provider"},"attributes":{"type":"object","properties":{"acc_new_patients":{"type":"boolean"},"address":{"type":"object","properties":{"street":{"type":"string","example":"308 Sherwood Inlet"},"city":{"type":"string","example":"Cormierton"},"state":{"type":"string","example":"MT"},"zip":{"type":"string","example":"41390"}}},"caresite_phone":{"type":"string","example":"6418432280"},"email":{"type":["string","null"]},"fax":{"type":["string","null"]},"gender":{"type":"string","example":"Female"},"lat":{"type":"number","example":-85.085761},"long":{"type":"number","example":-125.282372},"name":{"type":"string","example":"Madie Mayert"},"phone":{"type":["string","null"]},"pos_codes":{"type":["string","null"]},"pref_contact":{"type":["string","null"]},"unique_id":{"type":"integer","example":7960178946}}}}},"Specialty":{"properties":{"id":{"type":"string","example":"101Y00000X"},"type":{"type":"string","example":"specialty"},"attributes":{"type":"object","properties":{"classification":{"type":"string","example":"Counselor"},"grouping":{"type":"string","example":"Behavioral Health & Social Service Providers"},"name":{"type":"string","example":"Counselor"},"specialization":{"type":["string","null"],"example":"Clinical"},"specialty_code":{"type":"string","example":"101Y00000X"},"specialty_description":{"type":"string","example":"Definition to come..."}}}}}}}