Lookup an existing user
This GET endpoint is used to lookup whether a user with the provided email and first name exists in the MassPay system. <br> To use this endpoint, you need to provide the email, first_name, and internal_user_id as Query parameters in the URL. <br> The endpoint will then search for the user based on the provided information and return a JSON response indicating whether the user exists or not. If the user exists, the response will also contain the user's details, user_token, first_name, last_name and internal_user_id.
Query parameters
User's email address. Required if First Name is provided
User's first name. Required if email is provided
A client-defined identifier for the user. This is the unique ID assigned to the user on your system. Max 75 characters. Allows letters, numbers, and + , - . / _ ~ |. Required if email and first name are not provided
Headers
Unique key to prevent duplicate processing
Response
Found a matching user
Example response
{
"user_token": "usr_f4741aa2-9f39-4358-8247-2409e3fc2715",
"internal_user_id": "4324-rOzk"
}