Skip to main content
POST
Find Portal Verification Codes
Scope: portal:verify

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

portalTaskId
string<uuid>
required

Body

application/json
portalConfigurationId
string<uuid>

A portal configuration belonging to a customer linked to this task.

useSavedPreferences
boolean
default:false

Explicitly narrow delivery method, mailbox and recipient using optional saved preferences. Otherwise search all authorized connected email mailboxes.

requestedAfter
string<date-time>

Time the login challenge was requested. Must be within the last ten minutes.

lookbackMinutes
enum<integer>
default:3
Available options:
3,
10

Response

Lookup outcome. An incomplete search never confirms a code.

status
enum<string>
required
Available options:
found,
pending,
ambiguous,
not_configured,
unavailable
searchedAfter
string<date-time>
required
checkedAt
string<date-time>
required
incomplete
boolean
required
candidates
object[]
required
Maximum array length: 20