Skip to main content
GET
/
api
/
v1
/
subscribers
/
lookup
curl -X GET "https://olive-gateway-a6ba.onrender.com/api/v1/subscribers/lookup?phone_number=0771234567" \
  -H "Authorization: Bearer olive_live_xxx"
{
  "found": true,
  "subscriber": {
    "id": "sub_abc123",
    "phone_number": "+23279123456",
    "first_name": "John",
    "last_name": "Doe",
    "kyc_level": 2,
    "status": "ACTIVE",
    "balance": "125,000.00 SLE"
  }
}
Use this endpoint to find a subscriber by phone number instead of ID.

Request

Authorization
string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)

Query Parameters

phone_number
string
required
Phone number to search. Accepts:
  • Local format: 0771234567
  • E.164 format: +23279123456

Response

found
boolean
Whether subscriber was found
subscriber
object
Subscriber object if found

Examples

curl -X GET "https://olive-gateway-a6ba.onrender.com/api/v1/subscribers/lookup?phone_number=0771234567" \
  -H "Authorization: Bearer olive_live_xxx"
{
  "found": true,
  "subscriber": {
    "id": "sub_abc123",
    "phone_number": "+23279123456",
    "first_name": "John",
    "last_name": "Doe",
    "kyc_level": 2,
    "status": "ACTIVE",
    "balance": "125,000.00 SLE"
  }
}

Use Cases

Pre-Transfer Check

Verify recipient exists before P2P transfer

Agent Cash-In

Find subscriber before processing cash deposit

Errors

StatusCodeDescription
400MISSING_PHONEphone_number query param required
401UNAUTHORIZEDInvalid or missing API key
404NOT_FOUNDNo subscriber with this phone
500INTERNAL_ERRORServer error