Class AnnotateAssessmentRequest (1.19.1)

Version 1.19.1

• 1.26.0 (latest)
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.0
• 1.21.2
• 1.20.0
• 1.19.1
• 1.18.1
• 1.17.1
• 1.16.1
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.0
• 1.9.0
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.1
• 1.2.0
• 1.1.2
• 1.0.0
• 0.4.2
• 0.3.3
• 0.2.1
• 0.1.0

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. Reasons for the annotation that are assigned to the event.
account_id	str Optional. A stable account identifier to apply to the assessment. This is an alternative to setting account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.
hashed_account_id	bytes Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting hashed_account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.
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.