projects

Changed on

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

post/v1/{+name}:annotate

Request

  • Base URL: https://recaptchaenterprise.googleapis.com
  • URL: https://recaptchaenterprise.googleapis.com/v1/{+name}:annotate
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

namestring required

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

Request body

accountIdstring

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.

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.

hashedAccountIdstring 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.

reasonsstring[]

Optional. Reasons for the annotation that are assigned to the event.

Response

Successful response

Changes

  • b6a26222d14fRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status