Skip to main content
GET
Use this endpoint to find a subscriber by phone number instead of ID.

Request

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

Query Parameters

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

Response

boolean
Whether subscriber was found
object
Subscriber object if found

Examples


Use Cases

Pre-Transfer Check

Verify recipient exists before P2P transfer

Agent Cash-In

Find subscriber before processing cash deposit

Errors

Authorizations

Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Query Parameters

phone_number
string
required

Phone number

Response

Subscriber details

The response is of type object.