Skip to navigation
Identity verification APIAddress

Give a presence check more time

Gives the latest presence check of the entity more days. A check that is still running has its deadline moved later. A check that ended INCONCLUSIVE because its time ran out is reopened: it runs again from now with the evidence it already holds, and is billed as usual if it then verifies. A check can be given at most 30 extra days in total.

Fires entity.address_presence_extended; a reopened check later fires its result again. The call is recorded in your audit log.

Error codes

errorStatusMeaning
invalid_input400The body failed validation.
watch_not_found404The entity does not exist or has no presence check.
not_extendable409Only a running check, or one that ended because its time ran out, can be given more time.
extension_limit409The check has already been given 30 extra days.
stopped409The check was stopped.
superseded409The entity has a newer check.
another_check_running409Another check is already running for the entity.
secret_key_required403A publishable key was used. This API accepts secret keys only.
environment_mismatch403The key belongs to an environment this host does not serve.
rate_limited429The request rate limit for this key was reached. Retry after a short wait.
rate_limit_store_unavailable503Rate 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.
daysintegerRequired1-14
How many more days to give.
reasonstringOptional
Why, kept in your audit log and never sent to webhooks. At most 500 characters.

Response

Success
watchIdstring
The identifier of the presence check.
extendedboolean
Always true.
reopenedboolean
True when a check that had ended inconclusive was put back to running.
deadlineAtdatetime
The new deadline.
extendedDaysinteger
Extra days given to this check in total.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error