AnnotateAssessmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)The request message to annotate an Assessment.
Attributes | |
|---|---|
| Name | Description |
name |
str
Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.
|
annotation |
google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation
Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent. |
reasons |
MutableSequence[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Reason]
Optional. Optional reasons for the annotation that will be assigned to the Event. |
hashed_account_id |
bytes
Optional. Unique stable hashed user identifier to apply to the assessment. This is an alternative to setting the hashed_account_id in CreateAssessment, for example when the account identifier is not yet known in the initial request. It is recommended that the identifier is hashed using hmac-sha256 with stable secret. |
transaction_event |
google.cloud.recaptchaenterprise_v1.types.TransactionEvent
Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction. |
Classes
Annotation
Annotation(value)Enum that represents the types of annotations.
Values: ANNOTATION_UNSPECIFIED (0): Default unspecified type. LEGITIMATE (1): Provides information that the event turned out to be legitimate. FRAUDULENT (2): Provides information that the event turned out to be fraudulent. PASSWORD_CORRECT (3): Provides information that the event was related to a login event in which the user typed the correct password. Deprecated, prefer indicating CORRECT_PASSWORD through the reasons field instead. PASSWORD_INCORRECT (4): Provides information that the event was related to a login event in which the user typed the incorrect password. Deprecated, prefer indicating INCORRECT_PASSWORD through the reasons field instead.
Reason
Reason(value)Enum that represents potential reasons for annotating an assessment.
Values:
REASON_UNSPECIFIED (0):
Default unspecified reason.
CHARGEBACK (1):
Indicates that the transaction had a chargeback issued with
no other details. When possible, specify the type by using
CHARGEBACK_FRAUD or CHARGEBACK_DISPUTE instead.
CHARGEBACK_FRAUD (8):
Indicates that the transaction had a
chargeback issued related to an alleged
unauthorized transaction from the cardholder's
perspective (for example, the card number was
stolen).
CHARGEBACK_DISPUTE (9):
Indicates that the transaction had a
chargeback issued related to the cardholder
having provided their card details but allegedly
not being satisfied with the purchase (for
example, misrepresentation, attempted
cancellation).
REFUND (10):
Indicates that the completed payment
transaction was refunded by the seller.
REFUND_FRAUD (11):
Indicates that the completed payment
transaction was determined to be fraudulent by
the seller, and was cancelled and refunded as a
result.
TRANSACTION_ACCEPTED (12):
Indicates that the payment transaction was
accepted, and the user was charged.
TRANSACTION_DECLINED (13):
Indicates that the payment transaction was
declined, for example due to invalid card
details.
PAYMENT_HEURISTICS (2):
Indicates the transaction associated with the
assessment is suspected of being fraudulent
based on the payment method, billing details,
shipping address or other transaction
information.
INITIATED_TWO_FACTOR (7):
Indicates that the user was served a 2FA challenge. An old
assessment with ENUM_VALUES.INITIATED_TWO_FACTOR reason
that has not been overwritten with PASSED_TWO_FACTOR is
treated as an abandoned 2FA flow. This is equivalent to
FAILED_TWO_FACTOR.
PASSED_TWO_FACTOR (3):
Indicates that the user passed a 2FA
challenge.
FAILED_TWO_FACTOR (4):
Indicates that the user failed a 2FA
challenge.
CORRECT_PASSWORD (5):
Indicates the user provided the correct
password.
INCORRECT_PASSWORD (6):
Indicates the user provided an incorrect
password.
SOCIAL_SPAM (14):
Indicates that the user sent unwanted and
abusive messages to other users of the platform,
such as spam, scams, phishing, or social
engineering.