API DOCUMENTATION V2

GenderAPI.io: Migrate from V1 to V2

Migrate GenderAPI.io requests, batch jobs and phone validation from V1 to V2. Keep your API key and balance while updating fields and response parsing.

Move an integration from v1 to v2

GenderAPI.io V1 remains available. Move each integration to V2 using the same API key and credit balance. Update the route, request fields and response parsing together: V2 uses data for results and meta for request, access and billing information.

GenderAPI.io V1GenderAPI.io V2
/api, /api/email, /api/usernamePOST /api/v2/gender with type: name, email or username and value
/api/name/multi/country, /api/email/multi/country, /api/username/multi/countryPOST /api/v2/gender/batch with items; input types may be mixed
/api/phone with number and addressPOST /api/v2/phone/validate with number and country; read data.valid and data.possible
askToAIoptions.ai_mode: fallback; single requests already default to fallback
forceToGenderizeSame optional field for all three types; dataset first, then nickname-aware AI
Flat response fieldsdata for the result; meta for access and billing
probability percentageconfidence on a 0–1 scale plus confidence_kind; AI scores are not calibrated probabilities
total_namesdata.sample_count, nullable
used_credits / remaining_creditsmeta.usage.charged_credits / remaining_credits
Legacy error formatHTTP status plus Problem Details code and action
POST retriesEach retry is a new operation with normal billing

Update and verify your client

Use the v2 request and response contract for the integration you are migrating. Verify meta.access.mode, preserve JSON null results, inspect per-item batch errors and check billing before retrying. Keep v1 integrations on their existing paths until their clients have been updated.