Deep responses

Add ?deep=true to request additional fields for the same lookup. Those fields live in a nested deep object. The route and its core fields stay the same.

No ?deep=true

The deep key is omitted.

deep: {}

Requested, but no extra fields are included for this endpoint, plan, or key type.

deep: { ... }

Additional fields are included. Individual values may still be null.

An empty object is truthy in JavaScript. Check the field you need explicitly, such as response.deep?.deliverable === true. The presence of deep alone does not mean a check succeeded.

Plan deep is included on paid plans for endpoints such as geography profiles, Name, Industry, IP, Useragent, Domain, Weather, Vehicle, Provider and Tariff. Email and VAT deep use metered allowances, including the Free plan's included checks. These can return a quota error when no allowance is available.

Phone core returns validation and formats; ?deep=true adds numbering-plan location on every plan. Time, Date, Currency, Language, Emoji, Bank, Card, Company and Point also offer optional detail on every plan. Carrier and HLR deep add detail within the same metered lookup, with no second unit. Use Carrier for the serving carrier, Caller for caller ID, or HLR for last-observed network status. Each is a separate metered lookup.