← Release history

API 2.1.0

Upcoming · Not released

Natural response fields

One response layout for the maintained SDK line.

What changes

Plan detail at natural homesBreaking change

Paid API 2.1 profiles include available plan detail at their resource’s natural field paths. Existing explicit HTTP depth options retain their behavior. Each list item owns its fields; Weather measurements stay in current. Unavailable optional fields are omitted; included unknowns remain null.

Before
result.deep?.population
After
result.population
Complete metered answersBreaking change

Carrier and HLR return the complete selected result by default, using the existing entitlement and accounting rules. Email verification uses explicit POST /email/verify with a JSON email body. Basic GET Email remains a separate ordinary lookup.

Before
GET /email/person%40example.com?deep=true
GET /carrier/+14155552671?deep=true
result.deep.city
After
POST /email/verify
{"email":"person@example.com"}
GET /carrier/+14155552671
result.city

Update old .deep field reads before upgrading. Current SDKs target 2.1 and keep the same client factories. Earlier API contracts remain temporarily available for migration.

Existing account defaults and billing agreements are preserved. New Free accounts receive 100,000 pooled monthly requests.

Read the upgrade guide, to test a version in application code. Requests without a version follow the team setting in Settings → API version. A new release does not upgrade your existing team automatically.