Home / API reference
API reference

Android Developer ID Status API reference

Use the Android Developer ID Status API to check a package name, validate a SHA-256 certificate fingerprint and handle every registration state safely.

Operational summary

The official server-to-server API returns a small, stable registration state for a package name or a package-and-certificate pair. It is suitable for IDEs and CI/CD, but callers must protect their own Google Cloud API key and handle quota and transient errors deliberately.

Built for: Developer-tool authors, release-platform teams and Android engineers integrating the official status service.
MethodGET packageRegistrationStatus:check
AuthenticationX-Goog-Api-Key header
Stable resultstate field

Recommended sequence

  1. Enable Android Developer ID Status API in a dedicated Google Cloud project.
  2. Restrict the API key and store it in a server-side or CI secret store.
  3. Send the package name and optional normalized SHA-256 certificate fingerprint.
  4. Branch on the state field, while treating HTTP and quota errors separately.
Field note: Do not parse Google error-message text as a stable machine contract. Use HTTP status and canonical error status, and never expose the API key in browser JavaScript.

Request and response contract

The endpoint accepts a package name in the path and an optional certificateFingerprint query parameter. Send the API key in X-Goog-Api-Key from a trusted server or CI environment.

A successful HTTP 200 response carries state. Handle INVALID_ARGUMENT and PERMISSION_DENIED as configuration failures; retry RESOURCE_EXHAUSTED, INTERNAL and UNAVAILABLE only with bounded exponential backoff.

  • Do not send the API key in a query string.
  • Do not branch on human-readable error messages.
  • Cache recent results and attach a checked timestamp.
Package and certificate request
curl --fail --silent \
  -H "X-Goog-Api-Key: $ANDROID_DEVELOPER_ID_API_KEY" \
  "https://androiddeveloperidstatus.googleapis.com/v1/packages/com.example.app/packageRegistrationStatus:check?certificateFingerprint=64_HEX_CHARACTERS"

Frequently asked questions

Is OAuth required for the Status API?

The current official guide documents API-key authentication for this status-check endpoint.

Can browser JavaScript call it directly?

It should not expose a reusable Google API key. Put the call in a protected server or CI context.

Sources and review

PkgReady summarizes operational implications but does not replace an official console or Android documentation. Reviewed 2026-08-14.