Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.

Path Parameters

domainId
string<uuid>
required

Domain id.

userId
string<uuid>
required

Test user id.

Query Parameters

force
enum<string>

Set to 1 to re-verify even when a recent result exists (use after changing the credentials).

Available options:
1

Response

An in-flight or recent verification was reused.

Outcome of a pre-scan login verification run for a saved test user.

id
string<uuid>
required
status
enum<string>
required
Available options:
pending,
running,
succeeded,
failed
created_at
string<date-time>
required
test_user_id
string<uuid> | null
failure_code
enum<string> | null

Category of the failure when status is failed.

Available options:
invalid_credentials,
login_page_not_found,
mfa_required_not_configured,
mfa_code_unavailable,
account_locked,
target_unreachable,
bot_protection,
launch_failed,
other,
null
detail
string | null

Human-readable explanation of the outcome. Never contains credentials or email contents.

started_at
string<date-time> | null
finished_at
string<date-time> | null