Skip to main content
POST
Lookup User
Find a Quickei user before sending a payout. Returns a lookup_token required for quoting and executing the payout.

Parameters

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

Example Request

By phone:
By email:

Success Response 200

string
Token identifying this recipient. Valid for 10 minutes. Pass it to the Quote or Payout endpoint.
string
Recipient’s full name.
array
List of wallet currencies the user holds. Use the code field when specifying the receiving currency.

Error Responses

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.