> ## Documentation Index
> Fetch the complete documentation index at: https://developer.quickei.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Lookup User

> Find a Quickei user by phone number or email

Find a Quickei user before sending a payout. Returns a `lookup_token` required for quoting and executing the payout.

## Parameters

<ParamField body="phone" type="string">
  The recipient's phone number (with or without `+` prefix). Required if `email` is not provided.
</ParamField>

<ParamField body="email" type="string">
  The recipient's email address. Required if `phone` is not provided.
</ParamField>

## Example Request

**By phone:**

```bash theme={null}
curl -X POST https://quickei.io/api/partner/sandbox/v1/lookup \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+237699882723"
  }'
```

**By email:**

```bash theme={null}
curl -X POST https://quickei.io/api/partner/sandbox/v1/lookup \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com"
  }'
```

## Success Response `200`

```json theme={null}
{
  "message": {
    "success": ["Recipient found."]
  },
  "data": {
    "lookup_token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "recipient": {
      "name": "Vaneck Duclair",
      "currencies": [
        { "code": "XAF", "symbol": "FCFA", "type": "FIAT" },
        { "code": "CAD", "symbol": "$", "type": "FIAT" }
      ]
    }
  }
}
```

<ResponseField name="lookup_token" type="string">
  Token identifying this recipient. Valid for **10 minutes**. Pass it to the [Quote](/partner-api/04-quote) or [Payout](/partner-api/05-payout) endpoint.
</ResponseField>

<ResponseField name="recipient.name" type="string">
  Recipient's full name.
</ResponseField>

<ResponseField name="recipient.currencies" type="array">
  List of wallet currencies the user holds. Use the `code` field when specifying the receiving currency.
</ResponseField>

## Error Responses

| Status | Message                  | Cause                                                |
| ------ | ------------------------ | ---------------------------------------------------- |
| `404`  | Recipient not found.     | No active Quickei user matches the given phone/email |
| `422`  | Validation error         | Missing `phone` or `email` field                     |
| `401`  | Invalid API credentials. | Bad or missing Bearer token                          |

<Info>
  The `+` prefix on phone numbers is optional. Both `+237699882723` and `237699882723` will work.
</Info>

<Warning>
  Lookup tokens expire after 10 minutes. If expired, perform a new lookup.
</Warning>