Confirm a section has been reviewed
confirm_capture_reviewRecord your user’s confirmation that they have REVIEWED a whole section and it is complete — the entire previous-year comparative column, or the entire disclosure set. A review confirmation is your user’s professional assertion, recorded as authorised by them. Before calling this, show them what you are confirming — the whole comparative, or the whole disclosure set — and get their explicit go-ahead. Never confirm a review that has not happened. Saving figures or text does NOT complete these two sections and never has; only this confirmation does. The confirmation is pinned to the exact set that was reviewed, so ANY later save to that section withdraws it — if a confirmation appears not to stick, the next step is to re-review and confirm again, never to retry. Confirming again after such a change supersedes the earlier confirmation: it is marked withdrawn (it stays on the record) and the response names what was withdrawn. Re-confirming also invalidates any finalise approval you already hold. Only two sections take a review confirmation: the previous-year comparative and the disclosure set. Every other section is answered by saving its rows, or by declare_capture_na. Datavrn notifies the member you name that this was recorded in their name. Generate a fresh version after your last capture change — finalisation checks the version’s frozen capture state, not today’s.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| client_id | Yes | The entity (client) id — from list_clients. | |
| period_id | Yes | ||
| reason_code | Yes | ||
| template_id | Yes | ||
| capture_kind | Yes | ||
| on_behalf_of | No | The email address your user signs in to Datavrn with. This records who authorised the change alongside the connection that made it. REQUIRED on an API-key connection — ask your user for it, do not guess. On an OAuth connection leave it out: the change is recorded as authorised by the member who connected; if you do supply it, it must be that member. |