Rivier/ Reference/ voice

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

  • numberstringrequired
    A phone number in E.164, or national with countryCode At most 40 characters.
  • countryCodestring
    Pattern: ^[A-Za-z]{2}$.
  • fieldslist of string
    What to find out. validation is free; the rest asks the carrier and uses the lookups allowance
  • freshboolean
    Ask the carrier again instead of reusing a recent answer

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown