You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/recaptchaenterprise_v1.projects.assessments.html
+140Lines changed: 140 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -157,9 +157,79 @@ <h3>Method Details</h3>
157
157
"hashedAccountId": "A String", # Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
158
158
"siteKey": "A String", # Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
159
159
"token": "A String", # Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
160
+
"transactionData": { # Transaction data associated with a payment protected by reCAPTCHA Enterprise. All fields are optional. # Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.
161
+
"billingAddress": { # Structured address format for billing and shipping addresses. # Address associated with the payment method when applicable.
162
+
"address": [ # The first lines of the address. The first line generally contains the street name and number, and further lines may include information such as an apartment number.
163
+
"A String",
164
+
],
165
+
"administrativeArea": "A String", # The state, province, or otherwise administrative area of the address.
166
+
"locality": "A String", # The town/city of the address.
167
+
"postalCode": "A String", # The postal or ZIP code of the address.
168
+
"recipient": "A String", # The recipient name, potentially including information such as "care of".
169
+
"regionCode": "A String", # The CLDR country/region of the address.
170
+
},
171
+
"cardBin": "A String", # The Bank Identification Number - generally the first 6 or 8 digits of the card.
172
+
"cardLastFour": "A String", # The last four digits of the card.
173
+
"currencyCode": "A String", # The currency code in ISO-4217 format.
174
+
"gatewayInfo": { # Details about the transaction from the gateway. # Information about the payment gateway's response to the transaction.
175
+
"avsResponseCode": "A String", # AVS response code from the gateway (available only when reCAPTCHA Enterprise is called after authorization).
176
+
"cvvResponseCode": "A String", # CVV response code from the gateway (available only when reCAPTCHA Enterprise is called after authorization).
177
+
"gatewayResponseCode": "A String", # Gateway response code describing the state of the transaction.
178
+
"name": "A String", # Name of the gateway service (for example, stripe, square, paypal).
179
+
},
180
+
"items": [ # Items purchased in this transaction.
181
+
{ # Line items being purchased in this transaction.
182
+
"merchantAccountId": "A String", # When a merchant is specified, its corresponding account_id. Necessary to populate marketplace-style transactions.
183
+
"name": "A String", # The full name of the item.
184
+
"quantity": "A String", # The quantity of this item that is being purchased.
185
+
"value": 3.14, # The value per item that the user is paying, in the transaction currency, after discounts.
186
+
},
187
+
],
188
+
"merchants": [ # Information about the user or users fulfilling the transaction.
189
+
{ # Details about a user's account involved in the transaction.
190
+
"accountId": "A String", # Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account.
191
+
"creationMs": "A String", # The epoch milliseconds of the user's account creation.
192
+
"email": "A String", # The email address of the user.
193
+
"emailVerified": True or False, # Whether the email has been verified to be accessible by the user (OTP or similar).
194
+
"phoneNumber": "A String", # The phone number of the user, with country code.
195
+
"phoneVerified": True or False, # Whether the phone number has been verified to be accessible by the user (OTP or similar).
196
+
},
197
+
],
198
+
"paymentMethod": "A String", # The payment method for the transaction. The allowed values are: * credit-card * debit-card * gift-card * processor-{name} (If a third-party is used, for example, processor-paypal) * custom-{name} (If an alternative method is used, for example, custom-crypto)
199
+
"shippingAddress": { # Structured address format for billing and shipping addresses. # Destination address if this transaction involves shipping a physical item.
200
+
"address": [ # The first lines of the address. The first line generally contains the street name and number, and further lines may include information such as an apartment number.
201
+
"A String",
202
+
],
203
+
"administrativeArea": "A String", # The state, province, or otherwise administrative area of the address.
204
+
"locality": "A String", # The town/city of the address.
205
+
"postalCode": "A String", # The postal or ZIP code of the address.
206
+
"recipient": "A String", # The recipient name, potentially including information such as "care of".
207
+
"regionCode": "A String", # The CLDR country/region of the address.
208
+
},
209
+
"shippingValue": 3.14, # The value of shipping in the specified currency. 0 for free or no shipping.
210
+
"transactionId": "A String", # Unique identifier for the transaction. This custom identifier can be used to reference this transaction in the future, for example, labeling a refund or chargeback event. Two attempts at the same transaction should use the same transaction id.
211
+
"user": { # Details about a user's account involved in the transaction. # Information about the user paying/initiating the transaction.
212
+
"accountId": "A String", # Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account.
213
+
"creationMs": "A String", # The epoch milliseconds of the user's account creation.
214
+
"email": "A String", # The email address of the user.
215
+
"emailVerified": True or False, # Whether the email has been verified to be accessible by the user (OTP or similar).
216
+
"phoneNumber": "A String", # The phone number of the user, with country code.
217
+
"phoneVerified": True or False, # Whether the phone number has been verified to be accessible by the user (OTP or similar).
218
+
},
219
+
"value": 3.14, # The decimal value of the transaction in the specified currency.
220
+
},
160
221
"userAgent": "A String", # Optional. The user agent present in the request from the user's device related to this event.
161
222
"userIpAddress": "A String", # Optional. The IP address in the request from the user's device related to this event.
162
223
},
224
+
"fraudPreventionAssessment": { # Assessment for Fraud Prevention. # Assessment returned by Fraud Prevention when TransactionData is provided.
225
+
"cardTestingVerdict": { # Information about card testing fraud, where an adversary is testing fraudulently obtained cards or brute forcing their details. # Assessment of this transaction for risk of being part of a card testing attack.
226
+
"risk": 3.14, # Probability (0-1) of this transaction attempt being part of a card testing attack.
227
+
},
228
+
"stolenInstrumentVerdict": { # Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase. # Assessment of this transaction for risk of a stolen instrument.
229
+
"risk": 3.14, # Probability (0-1) of this transaction being executed with a stolen instrument.
230
+
},
231
+
"transactionRisk": 3.14, # Probability (0-1) of this transaction being fraudulent. Summarizes the combined risk of attack vectors below.
232
+
},
163
233
"name": "A String", # Output only. The resource name for the Assessment in the format "projects/{project}/assessments/{assessment}".
164
234
"privatePasswordLeakVerification": { # Private password leak verification info. # The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials.
165
235
"encryptedLeakMatchPrefixes": [ # Output only. List of prefixes of the encrypted potential password leaks that matched the given parameters. They must be compared with the client-side decryption prefix of `reencrypted_user_credentials_hash`
@@ -218,9 +288,79 @@ <h3>Method Details</h3>
218
288
"hashedAccountId": "A String", # Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.
219
289
"siteKey": "A String", # Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
220
290
"token": "A String", # Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
291
+
"transactionData": { # Transaction data associated with a payment protected by reCAPTCHA Enterprise. All fields are optional. # Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.
292
+
"billingAddress": { # Structured address format for billing and shipping addresses. # Address associated with the payment method when applicable.
293
+
"address": [ # The first lines of the address. The first line generally contains the street name and number, and further lines may include information such as an apartment number.
294
+
"A String",
295
+
],
296
+
"administrativeArea": "A String", # The state, province, or otherwise administrative area of the address.
297
+
"locality": "A String", # The town/city of the address.
298
+
"postalCode": "A String", # The postal or ZIP code of the address.
299
+
"recipient": "A String", # The recipient name, potentially including information such as "care of".
300
+
"regionCode": "A String", # The CLDR country/region of the address.
301
+
},
302
+
"cardBin": "A String", # The Bank Identification Number - generally the first 6 or 8 digits of the card.
303
+
"cardLastFour": "A String", # The last four digits of the card.
304
+
"currencyCode": "A String", # The currency code in ISO-4217 format.
305
+
"gatewayInfo": { # Details about the transaction from the gateway. # Information about the payment gateway's response to the transaction.
306
+
"avsResponseCode": "A String", # AVS response code from the gateway (available only when reCAPTCHA Enterprise is called after authorization).
307
+
"cvvResponseCode": "A String", # CVV response code from the gateway (available only when reCAPTCHA Enterprise is called after authorization).
308
+
"gatewayResponseCode": "A String", # Gateway response code describing the state of the transaction.
309
+
"name": "A String", # Name of the gateway service (for example, stripe, square, paypal).
310
+
},
311
+
"items": [ # Items purchased in this transaction.
312
+
{ # Line items being purchased in this transaction.
313
+
"merchantAccountId": "A String", # When a merchant is specified, its corresponding account_id. Necessary to populate marketplace-style transactions.
314
+
"name": "A String", # The full name of the item.
315
+
"quantity": "A String", # The quantity of this item that is being purchased.
316
+
"value": 3.14, # The value per item that the user is paying, in the transaction currency, after discounts.
317
+
},
318
+
],
319
+
"merchants": [ # Information about the user or users fulfilling the transaction.
320
+
{ # Details about a user's account involved in the transaction.
321
+
"accountId": "A String", # Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account.
322
+
"creationMs": "A String", # The epoch milliseconds of the user's account creation.
323
+
"email": "A String", # The email address of the user.
324
+
"emailVerified": True or False, # Whether the email has been verified to be accessible by the user (OTP or similar).
325
+
"phoneNumber": "A String", # The phone number of the user, with country code.
326
+
"phoneVerified": True or False, # Whether the phone number has been verified to be accessible by the user (OTP or similar).
327
+
},
328
+
],
329
+
"paymentMethod": "A String", # The payment method for the transaction. The allowed values are: * credit-card * debit-card * gift-card * processor-{name} (If a third-party is used, for example, processor-paypal) * custom-{name} (If an alternative method is used, for example, custom-crypto)
330
+
"shippingAddress": { # Structured address format for billing and shipping addresses. # Destination address if this transaction involves shipping a physical item.
331
+
"address": [ # The first lines of the address. The first line generally contains the street name and number, and further lines may include information such as an apartment number.
332
+
"A String",
333
+
],
334
+
"administrativeArea": "A String", # The state, province, or otherwise administrative area of the address.
335
+
"locality": "A String", # The town/city of the address.
336
+
"postalCode": "A String", # The postal or ZIP code of the address.
337
+
"recipient": "A String", # The recipient name, potentially including information such as "care of".
338
+
"regionCode": "A String", # The CLDR country/region of the address.
339
+
},
340
+
"shippingValue": 3.14, # The value of shipping in the specified currency. 0 for free or no shipping.
341
+
"transactionId": "A String", # Unique identifier for the transaction. This custom identifier can be used to reference this transaction in the future, for example, labeling a refund or chargeback event. Two attempts at the same transaction should use the same transaction id.
342
+
"user": { # Details about a user's account involved in the transaction. # Information about the user paying/initiating the transaction.
343
+
"accountId": "A String", # Unique account identifier for this user. If using account defender, this should match the hashed_account_id field. Otherwise, a unique and persistent identifier for this account.
344
+
"creationMs": "A String", # The epoch milliseconds of the user's account creation.
345
+
"email": "A String", # The email address of the user.
346
+
"emailVerified": True or False, # Whether the email has been verified to be accessible by the user (OTP or similar).
347
+
"phoneNumber": "A String", # The phone number of the user, with country code.
348
+
"phoneVerified": True or False, # Whether the phone number has been verified to be accessible by the user (OTP or similar).
349
+
},
350
+
"value": 3.14, # The decimal value of the transaction in the specified currency.
351
+
},
221
352
"userAgent": "A String", # Optional. The user agent present in the request from the user's device related to this event.
222
353
"userIpAddress": "A String", # Optional. The IP address in the request from the user's device related to this event.
223
354
},
355
+
"fraudPreventionAssessment": { # Assessment for Fraud Prevention. # Assessment returned by Fraud Prevention when TransactionData is provided.
356
+
"cardTestingVerdict": { # Information about card testing fraud, where an adversary is testing fraudulently obtained cards or brute forcing their details. # Assessment of this transaction for risk of being part of a card testing attack.
357
+
"risk": 3.14, # Probability (0-1) of this transaction attempt being part of a card testing attack.
358
+
},
359
+
"stolenInstrumentVerdict": { # Information about stolen instrument fraud, where the user is not the legitimate owner of the instrument being used for the purchase. # Assessment of this transaction for risk of a stolen instrument.
360
+
"risk": 3.14, # Probability (0-1) of this transaction being executed with a stolen instrument.
361
+
},
362
+
"transactionRisk": 3.14, # Probability (0-1) of this transaction being fraudulent. Summarizes the combined risk of attack vectors below.
363
+
},
224
364
"name": "A String", # Output only. The resource name for the Assessment in the format "projects/{project}/assessments/{assessment}".
225
365
"privatePasswordLeakVerification": { # Private password leak verification info. # The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials.
226
366
"encryptedLeakMatchPrefixes": [ # Output only. List of prefixes of the encrypted potential password leaks that matched the given parameters. They must be compared with the client-side decryption prefix of `reencrypted_user_credentials_hash`
0 commit comments