Response Payload Object

The response's payload will contain an array of objects containing the following values.

Property	Type	Description
email	string	The email of that user.
firstName	string	The first name of that user.
fullName	string	The combined first and last name of that user.
id	Guid	The Guid Id of that user.
lastName	string	The last name of that user.
localeISO2	string	The language of the user.
mobileCredential	Nullable Guid	The credential used when a user tries to get access using their mobile device.
phoneNumber	string	The phone number of that user
hasEnrolledFace	boolean	Whether or not that user has a face enrolled.
createdAt	DateTime	The creation date and time of that user.

🚧
Any fields returned in the response's payload that are not listed here are "empty" fields that should be ignored as they will always be the same value or will not be filled in.

📘
Note that if an error was found, then the payload will be null, however if no values were found and no error occurred, then an empty list will be returned instead.

Any status codes returned that are not provided here are generic status codes that can be found here.