> ## 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.

# Lookup Subscriber

> Find subscriber by phone number

<Info>
  Use this endpoint to find a subscriber by phone number instead of ID.
</Info>

## Request

<ParamField header="Authorization" type="string" required>
  `Bearer olive_live_xxx` or `Bearer eyJ...` (JWT)
</ParamField>

### Query Parameters

<ParamField query="phone_number" type="string" required>
  Phone number to search. Accepts:

  * Local format: `0771234567`
  * E.164 format: `+23279123456`
</ParamField>

***

## Response

<ResponseField name="found" type="boolean">
  Whether subscriber was found
</ResponseField>

<ResponseField name="subscriber" type="object">
  Subscriber object if found
</ResponseField>

***

## Examples

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://demo.api.vultlocal.com/api/v1/subscribers/lookup?phone_number=0771234567" \
    -H "Authorization: Bearer olive_live_xxx"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 Found theme={null}
  {
    "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"
    }
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "found": false,
    "message": "No subscriber found with this phone number"
  }
  ```
</ResponseExample>

***

## Use Cases

<CardGroup cols={2}>
  <Card title="Pre-Transfer Check" icon="arrow-right">
    Verify recipient exists before P2P transfer
  </Card>

  <Card title="Agent Cash-In" icon="plus-circle">
    Find subscriber before processing cash deposit
  </Card>
</CardGroup>

***

## Errors

| Status | Code             | Description                        |
| ------ | ---------------- | ---------------------------------- |
| 400    | `MISSING_PHONE`  | phone\_number query param required |
| 401    | `UNAUTHORIZED`   | Invalid or missing API key         |
| 404    | `NOT_FOUND`      | No subscriber with this phone      |
| 500    | `INTERNAL_ERROR` | Server error                       |


## OpenAPI

````yaml olive-openapi.json GET /subscribers/lookup
openapi: 3.0.0
info:
  description: >-
    API Gateway for OLIVE NFC Card Payment System - Comprehensive payment, card
    management, agent operations, and admin authentication. All /api/v1 routes
    require authentication using either API Key or JWT token.
  title: OLIVE NFC Card Payment API
  termsOfService: http://swagger.io/terms/
  contact:
    name: API Support
    email: support@olive.sl
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
  - url: https://olive-gateway-a6ba.onrender.com/api/v1
security: []
paths:
  /subscribers/lookup:
    get:
      tags:
        - Subscribers
      summary: Get subscriber by phone number
      description: Get subscriber details by phone number
      parameters:
        - description: Phone number
          name: phone_number
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Subscriber details
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '404':
          description: Subscriber not found
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      description: >-
        API Key for third-party integrations (WhatsApp, Smart PAY, VULT).
        Format: 'Bearer olive_live_xxxxxxxxxxxxx'
      type: apiKey
      name: Authorization
      in: header
    BearerAuth:
      description: >-
        JWT token from admin login for administrative operations. Format:
        'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
      type: apiKey
      name: Authorization
      in: header

````