MyPet — site header
The Defra-compliant microchip database & the MyVet practice platform

Keeper reunification API

Updated on October 26, 2025
Microchip API Documentation

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

GET
https://staging-app-api.mypethq.io/api/v1/public-microchip-details
Headers
x-api-key YOUR_API_KEY_HERE
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.

  • Version string

    The version of the API response.

  • Responder object

    Contains details about the responding database (e.g., DatabaseIdentifier).

  • ResponseDetails object

    The main payload. Content varies based on BASIC or FULL request type.

    • Microchip string

      The microchip number that was queried.

    • Status string

      Indicates 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.
    • ErrorCode string

      Provides a specific code if the Status is FAIL or ERROR.

    • Contact array FULL Only

      An array of contact objects (e.g., KEEPER, ALTERNATIVE).

    • Animal object FULL Only

      An object containing details about the animal (Name, Species, Breed, etc.).

    • ContactDatabase string FULL Only

      An informational message requiring the searcher to contact the database.

    • DatabaseLink string FULL Only

      A direct link to the microchip record in the MyPet app.

    • WelfareContact object FULL Only

      Details for the rescue backup/welfare contact.

How helpful was this article?

Subscribe to our newsletter

Request more information and discount code