Response Payload Object

Property	Type	Description
cards	An array of Card objects	An array of all the user's cards. See below for more information on the Card object.
email	string	The email of the user.
firstName	string	The first name of the user.
fullName	string	The combined first and last name of the user.
id	Guid	The Guid Id of the user.
lastName	string	The last name of the 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 the user.
hasEnrolledFace	boolean	Whether or not the user has an enrolled face.
createdAt	DateTime	The timestamp of when the user was created.

Card Object

Property	Type	Description
cardNumber	long	The card number of the card.
facilityCode	integer	The facility code of the card.
id	long	The Id of the card.
userId	Guid	The Guid Id of the user whose card it is.

🚧
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.

Controlled Errors

Error Code	Error Message
error_user_not_found	User with the provided Id was not found.

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

200200

400400