Load user by module

This API is used to load users by module. To get this API we need to pass authentication key, eventurl, emailOrCell, module, and countryCode.

if API gets executed successfully Here is the description of response attributes, which returns in the form of JSON.

Attribute

Description

email

This is the user's email address.

phonenumber

This is the user's phone number.

countryCode

This is the user country code.

firstName

This is the user's first name.

lastName

This is the user's last name.

availableTickets

This shows the total number of raffle tickets available for purchase.

cards

id: This is the Stripe card id.
last4: This is the last four digits of the connected stripe card.
expmonth: This is the card's expiration month.
expyear: This is the card's expiration year.
defaultCard: This will return as true if the current card is the default card.
cardType: This is the card type.

cardRequired

This is the value of whether a card is required for the transaction or not.

addressRequired

This contains the user's address. It will return as true if the address is required.

Here are the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error code

Error Description

4060054

The country code is not valid.

4040100

The user is not found.

Language
Authentication
Header
Click Try It! to start a request and see the response here!