REST Resource: projects.assessments

{
  "name": string,
  "event": {
    object (Event)
  },
  "score": number,
  "tokenProperties": {
    object (TokenProperties)
  },
  "reasons": [
    enum (ClassificationReason)
  ],
  "passwordLeakVerification": {
    object (PasswordLeakVerification)
  },
  "accountDefenderAssessment": {
    object (AccountDefenderAssessment)
  },
  "fraudPreventionAssessment": {
    object (FraudPreventionAssessment)
  }
}

string

Output only. The resource name for the Assessment in the format projects/{project_number}/assessments/{assessment_id}.

object (Event)

The event being assessed.

number

Output only. Legitimate event score from 0.0 to 1.0. (1.0 means very likely legitimate traffic while 0.0 means very likely non-legitimate traffic).

object (TokenProperties)

Output only. Properties of the provided event token.

enum (ClassificationReason)

Output only. Reasons contributing to the risk analysis verdict.

object (PasswordLeakVerification)

Information about the user's credentials used to check for leaks. This feature is part of the Early Access Program (EAP). Exercise caution, and do not deploy integrations based on this feature in a production environment.

object (AccountDefenderAssessment)

Assessment returned by account defender when a hashedAccountId is provided.

object (FraudPreventionAssessment)

Assessment returned by Fraud Prevention when TransactionData is provided.

{
  "token": string,
  "siteKey": string,
  "userAgent": string,
  "userIpAddress": string,
  "expectedAction": string,
  "hashedAccountId": string,
  "transactionData": {
    object (TransactionData)
  },
  "fraudPrevention": enum (FraudPrevention)
}

string

Optional. The user response token provided by the reCAPTCHA client-side integration on your site.

string

Optional. The site key that was used to invoke reCAPTCHA on your site and generate the token.

string

Optional. The user agent present in the request from the user's device related to this event.

string

Optional. The IP address in the request from the user's device related to this event.

string

Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with reCAPTCHA.

string (bytes format)

Optional. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret.

A base64-encoded string.

object (TransactionData)

Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Fraud Prevention and the FraudPreventionAssessment component in the response.

enum (FraudPrevention)

Optional. The Fraud Prevention setting for this Assessment.

{
  "paymentMethod": string,
  "cardBin": string,
  "cardLastFour": string,
  "currencyCode": string,
  "value": number,
  "shippingValue": number,
  "shippingAddress": {
    object (Address)
  },
  "billingAddress": {
    object (Address)
  },
  "user": {
    object (User)
  },
  "merchants": [
    {
      object (User)
    }
  ],
  "items": [
    {
      object (Item)
    }
  ],
  "gatewayInfo": {
    object (GatewayInfo)
  },
  "transactionId": string
}

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)

string

The Bank Identification Number - generally the first 6 or 8 digits of the card.

string

The last four digits of the card.

string

The currency code in ISO-4217 format.

number

The decimal value of the transaction in the specified currency.

number

The value of shipping in the specified currency. 0 for free or no shipping.

object (Address)

Destination address if this transaction involves shipping a physical item.

object (Address)

Address associated with the payment method when applicable.

object (User)

Information about the user paying/initiating the transaction.

object (User)

Information about the user or users fulfilling the transaction.

object (Item)

Items purchased in this transaction.

object (GatewayInfo)

Information about the payment gateway's response to the transaction.

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.

{
  "recipient": string,
  "address": [
    string
  ],
  "locality": string,
  "administrativeArea": string,
  "regionCode": string,
  "postalCode": string
}

string

The recipient name, potentially including information such as "care of".

string

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.

string

The town/city of the address.

string

The state, province, or otherwise administrative area of the address.

string

The CLDR country/region of the address.

string

The postal or ZIP code of the address.

{
  "accountId": string,
  "creationMs": string,
  "email": string,
  "emailVerified": boolean,
  "phoneNumber": string,
  "phoneVerified": boolean
}

string

Unique account identifier for this user. If using account defender, this should match the hashedAccountId field. Otherwise, a unique and persistent identifier for this account.

string (int64 format)

The epoch milliseconds of the user's account creation.

string

The email address of the user.

boolean

Whether the email has been verified to be accessible by the user (OTP or similar).

string

The phone number of the user, with country code.

boolean

Whether the phone number has been verified to be accessible by the user (OTP or similar).

{
  "name": string,
  "value": number,
  "quantity": string,
  "merchantAccountId": string
}

string

The full name of the item.

number

The value per item that the user is paying, in the transaction currency, after discounts.

string (int64 format)

The quantity of this item that is being purchased.

string

When a merchant is specified, its corresponding accountId. Necessary to populate marketplace-style transactions.

{
  "name": string,
  "gatewayResponseCode": string,
  "avsResponseCode": string,
  "cvvResponseCode": string
}

string

Name of the gateway service (for example, stripe, square, paypal).

string

Gateway response code describing the state of the transaction.

string

AVS response code from the gateway (available only when reCAPTCHA is called after authorization).

string

CVV response code from the gateway (available only when reCAPTCHA is called after authorization).

{
  "valid": boolean,
  "invalidReason": enum (InvalidReason),
  "createTime": string,
  "hostname": string,
  "action": string
}

boolean

Whether the provided user response token is valid. When valid = false, the reason could be specified in invalidReason or it could also be due to a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey used to generate the token was different than the one specified in the assessment).

enum (InvalidReason)

Reason associated with the response when valid = false.

string (Timestamp format)

The timestamp corresponding to the generation of the token.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string

The hostname of the page on which the token was generated.

string

Action name provided at token generation.

{
  "hashedUserCredentials": string,
  "credentialsLeaked": boolean,
  "canonicalizedUsername": string
}

string (bytes format)

Optional. Scrypt hash of the username+password that the customer wants to verify against a known password leak.

A base64-encoded string.

boolean

Output only. Whether or not the user's credentials are present in a known leak.

string

Optional. The username part of the user credentials for which we want to trigger a leak check in canonicalized form. This is the same data used to create the hashedUserCredentials on the customer side.

{
  "labels": [
    enum (AccountDefenderLabel)
  ]
}

enum (AccountDefenderLabel)

Labels for this request.

{
  "transactionRisk": number,
  "stolenInstrumentVerdict": {
    object (StolenInstrumentVerdict)
  },
  "cardTestingVerdict": {
    object (CardTestingVerdict)
  },
  "behavioralTrustVerdict": {
    object (BehavioralTrustVerdict)
  }
}

number

Probability (0-1) of this transaction being fraudulent. Summarizes the combined risk of attack vectors below.

object (StolenInstrumentVerdict)

Assessment of this transaction for risk of a stolen instrument.

object (CardTestingVerdict)

Assessment of this transaction for risk of being part of a card testing attack.

object (BehavioralTrustVerdict)

Assessment of this transaction for behavioral trust.

{
  "risk": number
}

number

Probability (0-1) of this transaction being executed with a stolen instrument.

{
  "risk": number
}

number

Probability (0-1) of this transaction attempt being part of a card testing attack.

{
  "trust": number
}

number

Probability (0-1) of this transaction attempt being executed in a behaviorally trustworthy way.