TextKitDocs

Look up a phone number

Carrier, line type, and caller name for any US/Canada number.

GET/v1/lookup/{phone}

Path Parameters

  • phonestringrequired

    Example: +14155550132.

Responses

  • 200Lookup

    Lookup result

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Response Fields

  • phone_numberstring
  • validboolean
  • line_typestring

    Nullable. Example: mobile.

  • carrierobject
  • carrier.namestring

    Nullable.

  • carrier.typestring

    Nullable.

  • caller_namestring

    Nullable.

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded