Create confirm
Records presence at a checkpoint: who confirmed it, the method, where they stood, and the photo key if one was taken.
POST /v1/patrol/point/{name}/confirm
| Address | https://api.hanzo.ai/v1/patrol/point/{name}/confirm |
| Method | POST |
| Operation | post_patrol_point_by_name_confirm |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Records presence at a checkpoint: who confirmed it, the method, where they stood, and the photo key if one was taken. A confirmation after the window shuts is recorded late rather than refused — the visit happened, and a report that hides it is worth nothing.
An officer confirms their own round and no other, by the same rule a position report and every incident act are held to: the checkpoint belongs to a tour, the tour names a unit, and the unit names its officer. The record carries the actor, so it says who claimed the visit and not merely that somebody did.
Request
6 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes | Name is the checkpoint's document name, from the path. |
lat | body | number (double) | — | Lat is the latitude the confirmation was taken at. |
lon | body | number (double) | — | Lon is the longitude the confirmation was taken at. |
method | body | string | — | Method is how presence was proved: tag, scan, fence, manual or photo. |
name | body | string | — | Name is the checkpoint's document name, from the path. |
photo | body | string | — | Photo is the object key of a photo taken there, never the bytes. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | patrol.patrolCheckpointOut | ok |
default | problem-details | refused |
200 body — 14 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | patrol.patrolCheckpoint | — | |
data.actor | body | string | — | Actor is who confirmed it. |
data.at | body | string | — | At is when it was confirmed, or empty. |
data.close | body | string | — | Close is when that window shuts. |
data.lat | body | number (double) | — | Lat is the latitude the confirmation was taken at. |
data.lon | body | number (double) | — | Lon is the longitude the confirmation was taken at. |
data.method | body | string | — | Method is how it was confirmed: tag, scan, fence, manual or photo. |
data.name | body | string | — | Name is the checkpoint's document name and the segment /v1/patrol/point/{name}/confirm addresses it by. |
data.open | body | string | — | Open is when the window to confirm it opens. |
data.photo | body | string | — | Photo is the object key of the photo taken, or empty. |
data.site | body | string | — | Site is the site to attend. |
data.state | body | string | — | State is pending, done, late or skipped. |
data.tag | body | string | — | Tag is the tag or marker to read there. |
data.tour | body | string | — | Tour is the round this checkpoint belongs to. |
Failure carries the platform error shape — see Errors.
Examples
hanzo patrol point confirm <name>import { Configuration, PatrolApi } from 'hanzoai';
const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postPatrolPointByNameConfirm({ name: 'name', lat: 0, lon: 0 });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).post_patrol_point_by_name_confirm(name='name', lat=0, lon=0)cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.PatrolAPI.PostPatrolPointByNameConfirm(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, patrol_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = patrol_api::post_patrol_point_by_name_confirm(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new PatrolApi(client).postPatrolPointByNameConfirm();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/patrol/point/<name>/confirm \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"lat": 0,
"lon": 0
}'MCP declares no tool for patrol — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?