Skip to content

Authentication

The CallerID API uses JWT (JSON Web Tokens) for authentication. Each token has an associated number of credits that are consumed with each search.

Obtaining Tokens

Tokens are obtained through the store. Each token includes:

  • Initial credits: Number of available searches
  • Remaining credits: Searches you can still perform
  • JWT Token: Text string that identifies and authenticates your token

Using the Token

The token is sent only in the request body, not in headers:

{
  "api_key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "query": "34600000001"
}

Credit Consumption

  • Each successful search consumes 1 credit
  • If a token has no credits, the search will be rejected
  • Remaining credits are returned in each response

Validation

The token is validated on each request. If the token is invalid or has no credits, you will receive an error:

{
  "detail": "Invalid token"
}

or

{
  "detail": "No credits remaining"
}

Security

  • Do not share your tokens publicly
  • Tokens are unique and non-transferable
  • Each token has a credit limit to prevent abuse