# README
Upollo Go Client
The Upollo golang library can be used identify users before they login or if they visit from multiple devices.
The Go library runs on your server and can be paired with the web or mobile library to protect logins or payments.
Usage
See upollo.ai/docs/examples/verify for an example, or the reference at upollo.ai/docs/reference/server-libraries.
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
The address is at a residential location.
No description provided by the author
No description provided by the author
The address is at a work location.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DEVICE_CLASS_BADBOT indicates the "device" is actually a bot, but one that is known for bad activity.
protolint:disable ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH DEVICE_CLASS_DESKTOP indicates the device is a desktop computer.
DEVICE_CLASS_GOODBOT indicates the "device" is actually a bot, but one that is typically allowed (such as the Googlebot web crawler).
protolint:enable ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH DEVICE_CLASS_MOBILE indicates the device is a mobile.
DEVICE_CLASS_TABLET indicates the device is a tablet.
No description provided by the author
EMAIL_INVALID_REASON_DISPOSABLE indicates the email address is a disposable email.
EMAIL_INVALID_REASON_FORMAT indicates the email address is incorrectly formatted.
EMAIL_INVALID_REASON_INVALID_DOMAIN indicates the email address is from a domain that is invalid (e.g.
EMAIL_INVALID_REASON_INVALID_USER indiciates the email address has an invalid user.
No description provided by the author
above.com.
ALIBABA.
AMAZON.
APPLE.
barracudanetworks.com.
centurylink.com.
chartercom.com.
cloudfilter.net.
mxrecord.io.
cscdns.net.
fireeyecloud.com.
frontbridge.com.
Google.
gpphosted.com.
hostedemail.com.
icloud.com.
prodigy.net.
CISCO.
mail.com.
mailcontrol.com.
mailerhost.net.
mail.ru.
messagelabs.com.
microsoft.com.
MIMECAST.
Outlook.
ppe-hosted.com.
Below here are specific providers that can be determined from MX records pphosted.
protonmail.ch.
qq.com.
self hosted occurs when the email domain and mx record domain match.
trendmicro.com.
Unspecified is returned if the email address is invalid
or if no specific email provider can be determined.
yahoodns.net.
zoho.com.
EMAIL_TYPE_COMPANY indicates the email address is from a company.
EMAIL_TYPE_DISPOSABLE indicates the email address is disposable.
EMAIL_TYPE_EDUCATION indicates the email address is from an educational instutition, e.g.
EMAIL_TYPE_NFP indicates the email address is from a non-profit.
EMAIL_TYPE_OTHER indicates the email address is of a type not captured with the other values.
EMAIL_TYPE_PUBLIC indicates the email address is publicly available, such as from Gmail, Yahoo, Hotmail etc.
No description provided by the author
EVENT_TYPE_ADD_PAYMENT_METHOD should be sent immediately after the customer has successfully added a new payment method.
Deprecated: Marked as deprecated in userwatch_public.proto.
Deprecated: Marked as deprecated in userwatch_public.proto.
EVENT_TYPE_ATTEMPT_PURCHASE should be sent immediately before a purchase.
EVENT_TYPE_ATTEMPT_REDEEM_OFFER should be sent immediately before an attempt to redeem an offer.
EVENT_TYPE_COMPLETE_PURCHASE should be sent immediately after a successful purchase.
Deprecated: Marked as deprecated in userwatch_public.proto.
EVENT_TYPE_END_SUBSCRIPTION should be sent immediately after a subscription is ended.
EVENT_TYPE_HEARTBEAT should be sent at regular intervals if no other events are sent.
EVENT_TYPE_INTERNAL is used internally and you should not use it.
EVENT_TYPE_LOGIN should be sent immediately before a login attempt.
EVENT_TYPE_LOGIN_SUCCESS should be sent immediately after a successful login.
EVENT_TYPE_PAGE_VISIT should be sent when a page or screen is loaded.
EVENT_TYPE_REDEEMED_OFFER should be sent after the customer has successfully redeemed an offer.
EVENT_TYPE_REGISTER should be sent immediately before a customer a customer attempts to register an account.
EVENT_TYPE_REGISTER_SUCCESS should be sent after the customer has successfully registered a new account.
Deprecated: Marked as deprecated in userwatch_public.proto.
Deprecated: Marked as deprecated in userwatch_public.proto.
EVENT_TYPE_START_SUBSCRIPTION should be sent immediately after a subscription has started.
No description provided by the author
Deprecated fields: do not use.
No description provided by the author
No description provided by the author
ACCOUNT_SHARING indicates that the same account is being shared by multiple people, typically on multiple devices.
ACCOUNT_SHARING_SAME_HOUSEHOLD indicates that the same account is being shared by multiple people in the same household, typically on multiple devices.
No description provided by the author
No description provided by the author
DEPRECATED.
No description provided by the author
No description provided by the author
CREDENTIAL_STUFFING indicates that the account has been used in a credential stuffing attack.
No description provided by the author
No description provided by the author
The account is using a disposable email address.
No description provided by the author
The email is invalid.
The phone number is invalid.
The type of phone is invalid.
LIMITED_DEVICE_INFORMATION indicates that the device did not have sufficient information to perform a detailed assessment.
MULTIPLE_ACCOUNTS indicates that the same person is using multiple accounts typically on the same device.
No description provided by the author
No description provided by the author
No description provided by the author
REPEATED_REDEMPTION indicates that the account has previous redeemed an offer.
REPEATED_SIGNUP indicates if the current event type is EventType_EVENT_TYPE_REGISTER and there has previously been an event of that type from this device or the email/phone has already been used.
SUSPECTED_ACCOUNT_COMPROMISE indicates that the account may have been compromised, as there is suspcious activity associated with the account.
SUSPECTED_BOT indicates that the account is suspected to be a bot.
SUSPECTED_FRAUD indicates that there is suspected fraud associated with the account.
TRIALED_ON_OTHER_ACCOUNT indicates that the person is currently or has in meaningfully recent history trialed the product using a different account.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OUTCOME_CHALLENGE indicates there is something suspcious about the user, so they should be sent a challenge (e.g.
No description provided by the author
OUTCOME_DENY indicates the user should be denied access.
No description provided by the author
No description provided by the author
OUTCOME_PERMIT indicates the user is genuine.
No description provided by the author
PHONE_INVALID_REASON_DISPOSABLE_PHONE indicates the phone number is a known disposable number.
PHONE_INVALID_REASON_INACTIVE_LINE indicates the phone line is inactive.
PHONE_INVALID_REASON_INVALID_TYPE indicates the type of phone number is not valid.
PHONE_INVALID_REASON_NUMBER_FORMAT indicates the format of the phone number is not valid.
No description provided by the author
PHONE_INVALID_REASON_VOIP indicates the phone number is a VOIP number.
PHONE_LINE_TYPE_INVALID indicates the phone line is invalid.
PHONE_LINE_TYPE_LANDLINE indicates a landline.
PHONE_LINE_TYPE_MOBILE indicates a mobile phone.
PHONE_LINE_TYPE_OTHER indicates the line is of a type not captured with the other values.
PHONE_LINE_TYPE_PREPAID indicates the phone line is a pre-paid line.
No description provided by the author
PHONE_LINE_TYPE_VOIP indicates the phone line is voice over IP (VOIP).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
Enum value maps for AddressType.
Enum value maps for AddressType.
Enum value maps for ChallengeType.
Enum value maps for ChallengeType.
Enum value maps for DeviceClass.
Enum value maps for DeviceClass.
Enum value maps for EmailInvalidReason.
Enum value maps for EmailInvalidReason.
Enum value maps for EmailProvider.
Enum value maps for EmailProvider.
Enum value maps for EmailType.
Enum value maps for EmailType.
Enum value maps for EventType.
Enum value maps for EventType.
No description provided by the author
No description provided by the author
Enum value maps for FlagType.
Enum value maps for FlagType.
Enum value maps for NullableBool.
Enum value maps for NullableBool.
Enum value maps for Outcome.
Enum value maps for Outcome.
Enum value maps for PhoneInvalidReason.
Enum value maps for PhoneInvalidReason.
Enum value maps for PhoneLineType.
Enum value maps for PhoneLineType.
Shepherd_ServiceDesc is the grpc.ServiceDesc for Shepherd service.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
Contains the results of checking the validity of an email address.
Contains the results of checking a password for leaks.
Contains the results of checking the validity of a phone number.
No description provided by the author
Information about a company.
No description provided by the author
The size of the company, as a range.
No description provided by the author
An error will be returned if creating the challenge fails (eg.
Information about a device.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An event, such as a user logging in.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Encapsulates geographical information.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnimplementedShepherdServer must be embedded to have forward compatible implementations.
Information about a user.
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
ShepherdClient is the client API for Shepherd service.
ShepherdServer is the server API for Shepherd service.
UnsafeShepherdServer may be embedded to opt out of forward compatibility for this service.
# Type aliases
The type of physical address.
No description provided by the author
No description provided by the author
A reason why the email address is not valid.
Email provider is determined by looking up MX records and extracting the domains from highest priority MX record.
The type of email address.
Events relating to general user activity in the application.
protolint:disable ENUM_FIELD_NAMES_PREFIX.
NullableBool is used to support optional booleans (i.e.
The recommended action based on Upollo's analysis.
Reasons why a phone number is invalid.
The type of phone line.