This API allows you to query microchip information. It provides two levels of detail: BASIC for a simple status check and FULL for complete reunification details.
Endpoint Details
https://staging-app-api.mypethq.io/api/v1/public-microchip-details
Headers
Common Errors
401 Unauthorized (Invalid API Key)
If the provided x-api-key is missing or invalid, the API will return this error. This applies to all requests.
{
"message": "Invalid API key"
}Request Body
Use "Type": "BASIC" to check if a microchip is registered in the database.
{
"Version": "1.0",
"Provider": {
"ProductName": "Test",
"ProductVersion": "1.0"
},
"Sender": {
"UserID": "test",
"UserEmail": "rescue@mypethq.io"
},
"RequestDetails": {
"Microchip": "982132381419618",
"Type": "BASIC"
}
}Success Response (200)
A successful response will return a Status of TRUE.
{
"ReunificationResponse": {
"Version": "1.0",
"Responder": {
"DatabaseIdentifier": "MyPet-Database"
},
"ResponseDetails": {
"Microchip": "982132381419618",
"Status": "TRUE",
"ErrorCode": ""
}
}
}Response Field Details
The following details the fields found in the ReunificationResponse object.
-
VersionstringThe version of the API response.
-
ResponderobjectContains details about the responding database (e.g.,
DatabaseIdentifier). -
ResponseDetailsobjectThe main payload. Content varies based on
BASICorFULLrequest type.-
MicrochipstringThe microchip number that was queried.
-
StatusstringIndicates the response status from the database.
Possible Values:TRUE: Microchip found and active.FALSE: Microchip not found.INFO: Informational message provided.FAIL: Query failed (e.g., bad format).ERROR: System error occurred.
-
ErrorCodestringProvides a specific code if the
StatusisFAILorERROR. -
Contactarray FULL OnlyAn array of contact objects (e.g., KEEPER, ALTERNATIVE).
-
Animalobject FULL OnlyAn object containing details about the animal (Name, Species, Breed, etc.).
-
ContactDatabasestring FULL OnlyAn informational message requiring the searcher to contact the database.
-
DatabaseLinkstring FULL OnlyA direct link to the microchip record in the MyPet app.
-
WelfareContactobject FULL OnlyDetails for the rescue backup/welfare contact.
-

