---
title: "POST /v1/{+name}:annotate"
method: POST
path: "/v1/{+name}:annotate"
tags: ["projects"]
---

# POST /v1/{+name}:annotate

`POST /v1/{+name}:annotate`

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

## Path parameters

- `name` string, required

## Request body

- GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest — The request message to annotate an Assessment.
  - `transactionEvent` GoogleCloudRecaptchaenterpriseV1TransactionEvent — Describes an event in the lifecycle of a payment transaction.
    - `eventType` 'TRANSACTION_EVENT_TYPE_UNSPECIFIED' | 'MERCHANT_APPROVE' | 'MERCHANT_DENY' | 'MANUAL_REVIEW' | 'AUTHORIZATION' | 'AUTHORIZATION_DECLINE' | 'PAYMENT_CAPTURE' | 'PAYMENT_CAPTURE_DECLINE' | 'CANCEL' | 'CHARGEBACK_INQUIRY' | 'CHARGEBACK_ALERT' | 'FRAUD_NOTIFICATION' | 'CHARGEBACK' | 'CHARGEBACK_REPRESENTMENT' | 'CHARGEBACK_REVERSE' | 'REFUND_REQUEST' | 'REFUND_DECLINE' | 'REFUND' | 'REFUND_REVERSE' — Optional. The type of this transaction event.
    - `eventTime` string, google-datetime — Optional. Timestamp when this transaction event occurred; otherwise assumed to be the time of the API call.
    - `reason` string — Optional. The reason or standardized code that corresponds with this transaction event, if one exists. For example, a CHARGEBACK event with code 6005.
    - `value` number, double — Optional. The value that corresponds with this transaction event, if one exists. For example, a refund event where $5.00 was refunded. Currency is obtained from the original transaction data.
  - `reasons` string[] — Optional. Reasons for the annotation that are assigned to the event.
  - `accountId` string — 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.
  - `hashedAccountId` string, byte — 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.
  - `phoneAuthenticationEvent` GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent — Details on a phone authentication event
    - `eventTime` string, google-datetime — Optional. The time at which the multi-factor authentication event (challenge or verification) occurred.
    - `phoneNumber` string — Required. Phone number in E.164 format for which a multi-factor authentication challenge was initiated, succeeded, or failed.
  - `annotation` 'ANNOTATION_UNSPECIFIED' | 'LEGITIMATE' | 'FRAUDULENT' | 'PASSWORD_CORRECT' | 'PASSWORD_INCORRECT' — Optional. The annotation that is 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.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/recaptchaenterprise.md) · [All operations](https://skmtc.net/google/apis/recaptchaenterprise/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/recaptchaenterprise/versions/3b5248d3ca31/schema)