curl -X GET "https://demo.api.vultlocal.com/api/v1/agents/lookup?phone_number=0771234567" \
-H "Authorization: Bearer olive_live_xxx"
{
"found": true,
"agent": {
"id": "agent_abc123",
"type": "super_agent",
"business_name": "ABC Money Services",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+23277123456",
"status": "active",
"location": "Freetown CBD"
}
}
{
"found": false,
"message": "No agent found with this phone number"
}
Agents
Lookup Agent
Find agent by phone number
GET
/
agents
/
lookup
curl -X GET "https://demo.api.vultlocal.com/api/v1/agents/lookup?phone_number=0771234567" \
-H "Authorization: Bearer olive_live_xxx"
{
"found": true,
"agent": {
"id": "agent_abc123",
"type": "super_agent",
"business_name": "ABC Money Services",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+23277123456",
"status": "active",
"location": "Freetown CBD"
}
}
{
"found": false,
"message": "No agent found with this phone number"
}
Find an agent by their registered phone number. Useful for verifying agents before transactions.
Request
string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)Query Parameters
string
required
Phone number to search. Accepts local (
0771234567) or E.164 (+23277123456)Response
boolean
Whether agent was found
object
Agent object if found
Examples
curl -X GET "https://demo.api.vultlocal.com/api/v1/agents/lookup?phone_number=0771234567" \
-H "Authorization: Bearer olive_live_xxx"
{
"found": true,
"agent": {
"id": "agent_abc123",
"type": "super_agent",
"business_name": "ABC Money Services",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+23277123456",
"status": "active",
"location": "Freetown CBD"
}
}
{
"found": false,
"message": "No agent found with this phone number"
}
Use Cases
Agent Verification
Verify agent identity before funding
Float Transfer
Find sub-agent before transferring float
Errors
| Status | Code | Description |
|---|---|---|
| 400 | MISSING_PHONE | phone_number query param required |
| 401 | UNAUTHORIZED | Invalid API key |
| 404 | NOT_FOUND | No agent with this phone |
| 500 | INTERNAL_ERROR | Server error |
⌘I