Skip to main content
POST
/
api
/
partner
/
sandbox
/
v1
/
lookup
Lookup User
curl --request POST \
  --url https://quickei.io/api/partner/sandbox/v1/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "email": "<string>"
}
'
{
  "lookup_token": "<string>",
  "recipient.name": "<string>",
  "recipient.currencies": [
    {}
  ]
}

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.

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

​
Parameters

​
phone
string
The recipient’s phone number (with or without + prefix). Required if email is not provided.
​
email
string
The recipient’s email address. Required if phone is not provided.

​
Example Request

By phone: 
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: 
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

{
  "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" }
      ]
    }
  }
}
​
lookup_token
string
Token identifying this recipient. Valid for 10 minutes. Pass it to the Quote or Payout endpoint.
​
recipient.name
string
Recipient’s full name.
​
recipient.currencies
array
List of wallet currencies the user holds. Use the code field when specifying the receiving currency.

​
Error Responses

StatusMessageCause
404Recipient not found.No active Quickei user matches the given phone/email
422Validation errorMissing phone or email field
401Invalid API credentials.Bad or missing Bearer token
The + prefix on phone numbers is optional. Both +237699882723 and 237699882723 will work.
Lookup tokens expire after 10 minutes. If expired, perform a new lookup.