Approve a presence check by hand

POST

/api/identity/entities/:externalUserId/address/approve

Records that your team confirmed the address another way. The latest check of the entity, running or ended because its time ran out, becomes VERIFIED, and a workflow waiting on it continues. It is recorded as a person’s decision rather than presence evidence: it is not billed and does not count towards tenure, and entity.address_verified carries decidedBy: "reviewer".

A check that failed because its location reports were tampered with cannot be approved. The call is recorded in your audit log with the note.

Error codes

`error`	Status	Meaning
`note_required`	422	The note is missing or shorter than 10 characters.
`watch_not_found`	404	The entity does not exist or has no presence check.
`already_verified`	409	The check is already verified.
`integrity_failure`	409	The check failed on tampered location reports.
`not_approvable`	409	Only a running check, or one that ended because its time ran out, can be approved.
`secret_key_required`	403	A publishable key was used. This API accepts secret keys only.
`environment_mismatch`	403	The key belongs to an environment this host does not serve.
`rate_limited`	429	The request rate limit for this key was reached. Retry after a short wait.
`rate_limit_store_unavailable`	503	Rate limiting is temporarily unavailable. Retry shortly.

A missing or unknown key returns 401 with a plain sentence in error rather than a code.

Requires a secret (sk_) key. A publishable key receives 403 secret_key_required.

Authentication

AuthorizationBearer

Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.

Path parameters

externalUserIdstringRequired

Your own stable reference for the person or business, as sent when the entity was registered.

Request

This endpoint expects an object.

notestringRequired

Why the address is approved, at least 10 characters. Kept in your audit log, never sent to webhooks.

Response

Success

watchIdstring

The identifier of the presence check.

approvedboolean

Always true.

previousStatusenum

What the check was before it was approved.

Allowed values:

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

503

Service Unavailable Error