Skip to main content
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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vultlocal.com/llms.txt

Use this file to discover all available pages before exploring further.

Find an agent by their registered phone number. Useful for verifying agents before transactions.

Request

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

Query Parameters

phone_number
string
required
Phone number to search. Accepts local (0771234567) or E.164 (+23277123456)

Response

found
boolean
Whether agent was found
agent
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"
  }
}

Use Cases

Agent Verification

Verify agent identity before funding

Float Transfer

Find sub-agent before transferring float

Errors

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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

phone_number
string
required

Phone number in E.164 format

Response

OK

The response is of type object.