Home → API Documentation → Login / Password Reset → api/Login

4.1. api/Login

This API call is used to log in a user and validate their credentials.

Parameters To Submit

All parameters are required and cannot be empty.

Parameter	Parameter Help	Parameter Data Type
emailaddress	Contact’s email address.	String – Max 250 chars
password	Contact’s password. Must convert String to Base64 encrypted format.	String – Max 150 chars

 

Return Response

The API call ResponseMessage will return the following fields of data.

Field	Field Help
uid	The contact’s uid that has the provided email address associated with their contact record.
EmailAddress	The contact’s email address.
FirstName	The contact’s first name that has the provided email address associated with their contact record.
LastName	The contact’s last name that has the provided email address associated with their contact record.
KnownAs	What the contact is known by provided the email address associated with their contact record.
Company	The company that the contact who is associated with the provided email address is a part of.
WebAdmin	Whether the contact is a website administrator.
LoginVerified	True/False value indicating if the email address has been verified.
ConsentReceived	Whether the contact has consented to the terms and conditions. Refer to api/UserActions with calltype UserConsent.
UserStatus	The membership status of the company the contact is associated with.
AllowLogin	Can be custom-configured as required.
ValidationVal	If LoginVerified is false, this Val is required as part of api/Validation. Will return as NULL if LoginVerified is already true.
ValidationID	If LoginVerified is false, this ID is required as part of api/Validation. Will return as NULL if LoginVerified is already true.

 

If a user's LoginVerified value returns false, you must verify the email address associated with the contact is correct and pass ValidationID and ValidationVal as part of api/Validation.

More information can be found here on the validation process.