FAV3 Check API

FAV3 API DOC

Reference for error codes returned by the FAV3 Check API.

HTTP Status Codes

Code Status Description
200 OK Check performed successfully (result in body)
400 Bad Request Invalid request format
403 Forbidden Authentication failed or expired token
422 Unprocessable Entity Validation error (e.g., invalid phone format)
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Server error
502 Bad Gateway Upstream API error
504 Gateway Timeout Upstream API timeout

Authentication Errors (403)

Error Message Description
Could not validate credentials Invalid or expired token
Access forbidden for role User role lacks permission

Validation Errors (422)

Error Message Description
Invalid phone number format Phone format invalid (+<code >-<number> required)
Unsupported country prefix Country not in system

Upstream API Errors (502/504)

These errors occur when communicating with VelaMobile Middleware V2:

Error Message Description
MW2 API error Error from upstream middleware
Connection to internal API service timed out. Timeout connecting to upstream
Error connecting to internal API service. Network error connecting to upstream

Check API Specific Responses

The Check API returns 200 OK with detailed messages even for "failure" cases (not a favorite):

Is Favorite Message Description
false Given number is not in favorites Valid check, number not found
false Subscriber is not active Subscriber suspended or disconnected
false No eligible active plan found Subscriber has no valid plan