Welcome to the FAV3 Check API documentation. This API allows authorized clients to check DID numbers, verify favorites, and look up customers by DID.

Base URL

Production: https://api.fav3.velamobile.com

All API endpoints are prefixed with /v1. For example: https://api.fav3.velamobile.com/v1/check/did.

Authentication

The API uses OAuth2 Password Bearer flow. Most endpoints require a valid Bearer Token in the Authorization header.

Authorization: Bearer <your_access_token>

To obtain a token, use the Login endpoint.

Features

• DID Check: Pass a DID number and caller number to get the customer's US number and favorite status
• Check Favorites: Verify if a target number is in a customer's favorites list
• Customer Lookup: Look up which customer a DID is assigned to
• Plan Validation: Automatic validation against VelaMobile Middleware V2

Rate Limiting

The API enforces rate limits per IP address to ensure stability. The limits are configured based on the endpoint's purpose:

• Exceeded: Returns 429 Too Many Requests
• Response: {"detail": "Rate limit exceeded: ..."}

Response Format

All responses are in JSON format. Success typically returns 200 OK. Errors return 4xx or 5xx codes with a JSON body detailing the error:

{
  "detail": "Error description here"
}