Skip to navigation
RebateRight APIDVA

Veteran Verification

Is this patient a DVA veteran, and what card do they hold?

That is the question this endpoint answers, for one patient at a time, from personal details alone or against a known DVA file number.

This endpoint verifies a patient’s veteran status with the Department of Veterans’ Affairs (DVA) in real time.

Two verification types are supported:

  • PVP. Submit personal details only: name, date of birth and sex. DVA returns the veteran’s file number and card type.
  • PVV. Include veteranMembership.veteranNumber to verify against a known DVA file number.

For card types, entitlement codes, the DVA file number format and the status codes, see DVA claims.

Authentication

x-api-keystring
API Key authentication via header
x-minor-idstring

Your Minor ID is 3 uppercase letters followed by 5 digits, such as MDE00000. Send the Minor ID exactly as issued. A malformed value returns 400 with the text The Minor ID is not valid. on every endpoint.

Headers

x-minor-idstringRequired

The Minor ID of the clinic you act for. See Keys, Minor ID and environments.

Request

This endpoint expects an object.
patientobjectRequired

Response

OK
correlationIdstringOptional
veteranStatusobjectOptional

Errors

400
Bad Request Error