Skip to Content
Human ReviewConfigure human input

Configure human input

Use a human input profile to define the answers one application needs from a reviewer. Keep it focused on the decision. The profile does not let a reviewer run application code.

Create a profile

Name the decision

Use a clear name that describes the decision, such as Payment limit review. The stable profile key and version bind every open review to the definition that created it.

Add the questions

Add only the information needed for this decision. A profile supports no more than 12 fields. Available types include approval, numbers, money, percentages, limited values, choices, identifiers, dates, short answers, knowledge, feedback, and registered payload edits.

Explain each question’s limits before the reviewer answers. Show whether an answer is required and which units, ranges, lengths, or choices are allowed. For example, identify the currency for a money field. A payload edit uses the limits of the value it can replace. Do not rely on a placeholder or browser error to explain a limit.

Dates are calendar dates in YYYY-MM-DD format. Use InteractionValidationRule.minimumDate and maximumDate for the earliest and latest date. Each is optional and accepts a DateBoundaryRule: an absolute date ({ mode: "absolute", value: "YYYY-MM-DD" }) or a whole-day offset from case creation ({ mode: "relative_to_request", offsetDays: 7 }). VeriProof resolves an offset once from the case’s persisted UTC creation date and keeps that resolved range for the life of the open review. Do not use numeric limits for a date field or date limits for another field type.

Add reviewer instructions when the criteria are reusable

Use Instructions for reviewers (optional) for the short, profile-wide criteria a reviewer should apply to every request of this kind. This is the optional reviewerGuidance profile property. It accepts up to 1,000 characters of plain text. Paragraphs and line breaks are preserved; links, markup, templates, and dynamic placeholders are not supported.

Keep an individual question’s instruction in that field’s help text. Keep the action summary, proposed action, and case-specific facts in the application context supplied when a review opens. Do not put secrets, raw payloads, credentials, URLs, or hidden reasoning in either place.

Preview the context

The preview shows the information a reviewer will use: reusable instructions, the action, its policy reason, key facts, field limits, and the response consequence. The application supplies a short summary and business facts for each request. VeriProof adds authorized policy and captured-session context. The portal labels application facts as Provided by application and VeriProof facts as Verified by VeriProof or Captured by VeriProof.

Application references are labels and correlation handles, not links or proof. Do not use a URL, portal identifier, session-step identifier, callback identifier, secret, or token. Keep private reviewer reasoning in the separate private note.

Choose what follows submission

  • Send response and resume uses resume_with_response.
  • Route to revision uses route_to_revision and must not execute the superseded protected payload.
  • Keep the application paused uses none.

The application still checks its current state and the current VeriProof policy before it performs protected work.

Validate, publish, and activate the version

Check the preview from the reviewer’s perspective: are the questions clear, and is the effect of submitting an answer explicit? Validate the draft, publish it, then activate it when the application is ready to use it.

Register safe payload replacements

A payload edit may use only replace on an existing JSON Pointer registered in the profile. Its value kind and classification must match the captured editable scope. VeriProof and the SDK reject add, remove, move, copy, unknown paths, type-confused values, credentials, tokens, and changed payload or scope digests.

A callback receipt proves the application stored the response. It does not prove the application resumed or applied a replacement.

Change a profile safely

Create the next version when the questions or application response must change. Draft, validated, published, active, superseded, and retired versions remain distinct. An open review keeps its original profile, request, context, editable-scope, protected-payload, reviewer-instruction, and resolved-date snapshot even after a newer version becomes active.

Next, operate the application callback and review the typed callback contract.

Last updated on