projects

POST /v1/projects/{projectsId}/assessments/{assessmentsId}:annotate

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

Request

  • Base URL
    https://recaptchaenterprise.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/cloud-platform
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
assessmentsIdstring required

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

GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse required

Empty response for AnnotateAssessment.

Changes

No recorded changes to this operation across all 4 revisions of this API.