Validate Medicare
Request
Method: POST
URL: https://{{environment}}.ridx.io/dvs/v1/medicare
Headers
| Header | Value |
|---|---|
token |
{{access_token}} |
Content-Type |
application/json |
Request Body
| Property | Type | Description |
|---|---|---|
BirthDate |
String | Optional. Birth date of the card holder, format: YYYY-MM-DD |
CardExpiry |
String | Date of card expiry, format: - Blue and Yellow Card Type: YYYY-MM-DD - Green Card Type: YYYY-MM |
CardNumber |
String | Card number, min 10 characters |
CardType |
String | One of Y (Yellow), G (Green) or B (Blue) |
FullName1 |
String | Includes given name, middle initial (if any) and family name. Names should be entered exactly as printed on the card (in the same nameline). For example, if there are multiple customers listed on the card enter the person's name as shown on the card at Nameline1 of your request regardless of where the name is listed on the card. Namelines 2, 3 and 4 are used only where a person has a long name printed on the card across those multiple lines (see below). Any preceding and leading spaces (default or keyed by the user) in any name line will be discarded/ignored. Long names: Up to 59 characters (including spaces) can be printed on a Medicare card for any one person's name and may stretch across different lines without filling the space on any line to capacity. NameLine1 is mandatory but does not need to have 27 characters entered before moving on to NameLine2 and so on. |
FullName2 |
String | Long name extension (see FullName1) |
FullName3 |
String | Long name extension (see FullName1) |
FullName4 |
String | Long name extension (see FullName1) |
IndividualReferenceNumber |
Integer | IRN of the person on card being validated, appears to the left of name on the card |
Important Response Data
| Property | Type | Description |
|---|---|---|
VerifyDocumentResult |
Object | The object containing the reply |
VerificationResultCode |
String | A value of Y (Yes), N (No), D (Document Error), S (Server Error) |
VerificationRequestNumber |
String | A receipt number of the request created by RapidID |
OriginatingAgencyCode |
String | A code representing the customers unique identifier code |
ActivityId |
String | A activity process id |
attributes |
Object | An object containing the description on the response |
i:type |
String | A description on the request response |
Example Requests
Example Responses
Status: 200 OK
{
"VerifyDocumentResult": {
"attributes": {
"i:type": "MedicareResponse"
},
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"OriginatingAgencyCode": "XXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationResultCode": "Y"
},
"fieldDetails": {
"BirthDate": "Full Match",
"BirthDay": "Full Match",
"BirthMonth": "Full Match",
"BirthYear": "Full Match",
"CardDay": "Full Match",
"CardMonth": "Full Match",
"CardYear": "Full Match",
"CardExpiry": "Full Match",
"CardNumber": "Full Match",
"CardType": "Full Match",
"FullName1": "Full Match",
"FullName2": "Full Match",
"FullName3": "Full Match",
"FullName4": "Full Match",
"IndividualReferenceNumber": "Full Match",
"ExpiryDay": "Full Match",
"MediNum1": "Full Match",
"MediNum2": "Full Match",
"MediNum3": "Full Match",
"ExpiryMonth": "Full Match",
"ExpiryYear": "Full Match",
"RegistrationState": "Full Match"
},
"rapidID": "check-id"
}
Status: 200 OK
{
"VerifyDocumentResult": {
"attributes": {
"i:type": "MedicareResponse"
},
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"OriginatingAgencyCode": "XXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationResultCode": "S"
},
"fieldDetails": {
"BirthDate": "No Match",
"BirthDay": "No Match",
"BirthMonth": "No Match",
"BirthYear": "No Match",
"CardDay": "No Match",
"CardMonth": "No Match",
"CardYear": "No Match",
"CardExpiry": "No Match",
"CardNumber": "No Match",
"CardType": "No Match",
"FullName1": "No Match",
"FullName2": "No Match",
"FullName3": "No Match",
"FullName4": "No Match",
"IndividualReferenceNumber": "No Match",
"ExpiryDay": "No Match",
"MediNum1": "No Match",
"MediNum2": "No Match",
"MediNum3": "No Match",
"ExpiryMonth": "No Match",
"ExpiryYear": "No Match",
"RegistrationState": "No Match"
},
"rapidID": "check-id"
}
Status: 200 OK
{
"VerifyDocumentResult": {
"attributes": {
"i:type": "MedicareResponse"
},
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"OriginatingAgencyCode": "XXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationResultCode": "D"
},
"fieldDetails": {
"BirthDate": "No Match",
"BirthDay": "No Match",
"BirthMonth": "No Match",
"BirthYear": "No Match",
"CardDay": "No Match",
"CardMonth": "No Match",
"CardYear": "No Match",
"CardExpiry": "No Match",
"CardNumber": "No Match",
"CardType": "No Match",
"FullName1": "No Match",
"FullName2": "No Match",
"FullName3": "No Match",
"FullName4": "No Match",
"IndividualReferenceNumber": "No Match",
"ExpiryDay": "No Match",
"MediNum1": "No Match",
"MediNum2": "No Match",
"MediNum3": "No Match",
"ExpiryMonth": "No Match",
"ExpiryYear": "No Match",
"RegistrationState": "No Match"
},
"rapidID": "check-id"
}
Status: 200 OK
{
"VerifyDocumentResult": {
"attributes": {
"i:type": "MedicareResponse"
},
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"OriginatingAgencyCode": "XXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationResultCode": "S"
},
"fieldDetails": {
"BirthDate": "No Match",
"BirthDay": "No Match",
"BirthMonth": "No Match",
"BirthYear": "No Match",
"CardDay": "No Match",
"CardMonth": "No Match",
"CardYear": "No Match",
"CardExpiry": "No Match",
"CardNumber": "No Match",
"CardType": "No Match",
"FullName1": "No Match",
"FullName2": "No Match",
"FullName3": "No Match",
"FullName4": "No Match",
"IndividualReferenceNumber": "No Match",
"ExpiryDay": "No Match",
"MediNum1": "No Match",
"MediNum2": "No Match",
"MediNum3": "No Match",
"ExpiryMonth": "No Match",
"ExpiryYear": "No Match",
"RegistrationState": "No Match"
},
"rapidID": "check-id"
}
Status: 400 Bad Request
Status: 200 OK
{
"VerifyDocumentResult": {
"attributes": {
"i:type": "MedicareResponse"
},
"ActivityId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"OriginatingAgencyCode": "XXXX",
"VerificationRequestNumber": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"VerificationResultCode": "N",
"Errors": {
"Error": {
"Field": "Medicare Card Number",
"Message": "Card Number does not match.",
"Source": "Issuer"
}
}
},
"fieldDetails": {
"BirthDate": "No Match",
"BirthDay": "No Match",
"BirthMonth": "No Match",
"BirthYear": "No Match",
"CardDay": "No Match",
"CardMonth": "No Match",
"CardYear": "No Match",
"CardExpiry": "No Match",
"CardNumber": "No Match",
"CardType": "No Match",
"FullName1": "No Match",
"FullName2": "No Match",
"FullName3": "No Match",
"FullName4": "No Match",
"IndividualReferenceNumber": "No Match",
"ExpiryDay": "No Match",
"MediNum1": "No Match",
"MediNum2": "No Match",
"MediNum3": "No Match",
"ExpiryMonth": "No Match",
"ExpiryYear": "No Match",
"RegistrationState": "No Match"
},
"rapidID": "check-id"
}