Look a number up
post/lookup/numbers
Look a number up: validity and country are free; line type, carrier, caller name, reachability, SIM swap and pumping risk ask the carrier and use the plan's lookups allowance. Recent answers are reused (cached: true) and cost nothing.
Before you call
- Credential
Authorization: Bearer $KEY- Scope
voice:write- Mcp
rivier_lookup_number- Graphql
Mutation.voiceLookupNumberCreate- Sdk
lookup.number- Cli
lookup number
Request bodyapplication/json, required
- numberstringrequiredA phone number in E.164, or national with countryCode At most 40 characters.
- countryCodestringPattern: ^[A-Za-z]{2}$.
- fieldslist of stringWhat to find out. validation is free; the rest asks the carrier and uses the lookups allowance
- freshbooleanAsk the carrier again instead of reusing a recent answer
Responses
- 200application/jsonSuccess
- 400application/jsonThe request was malformed
- errorstringrequired
- messagestring
- 401application/jsonNo valid credential
- errorstringrequired
- messagestring
- 403application/jsonThe credential lacks the scope, origin or address
- errorstringrequired
- messagestring
- 429application/jsonOver the key's rate limit; see Retry-After
- errorstringrequired
- messagestring