Skip to main content
POST
Search identifier submissions

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Body

application/json
identifiers
object[]

Identifiers to search for. Without a type, values of every type match. Mutually exclusive with the user selectors.

userIDs
string[]

User IDs (format tus-<number>). Returns the submissions of all identifiers linked to these users. Mutually exclusive with other selectors.

externalIDs
string[]

External user IDs. Returns the submissions of all identifiers linked to these users. Mutually exclusive with other selectors.

flowIDs
string[]

Flow IDs (format flw-<number>). Returns every submission made in these flows, whichever user an identifier is linked to. Mutually exclusive with other selectors.

page
integer
default:1

Page number for pagination (1-based). Defaults to 1.

Required range: x >= 1
pageSize
integer
default:25

Number of items per page. Defaults to 25, maximum 1000.

Required range: 1 <= x <= 1000

Response

Identifier submissions matching the search, ordered by submission time (newest first).

identifierID
string
required

Identifier ID (format idf-<number>)

identifierType
enum<string>
required

Identifier type as sent by the integration.

Available options:
email,
phone,
username,
unknown
identifierValue
string
required

Identifier as sent by the integration

subFlowID
string
required

Subflow of the submission (format sfl-<number>)

subFlowType
string
required

Subflow type that carried the identifier, e.g. provide-identifier

matchReason
enum<string>
required

Why the submission matched: identifier (searched identifier), ownFlow (identifier linked to a searched user, submitted in one of that user's flows), linkedIdentifier (identifier linked to a searched user, submitted in another user's flow) or flow (submitted in a searched flow).

Available options:
identifier,
ownFlow,
linkedIdentifier,
flow
createdMs
integer<int64>
required

Submission time in milliseconds since epoch

flowID
string

Flow of the submission (format flw-<number>)

flowUserID
string

User the flow is attributed to (format tus-<number>). For failed attempts this is often a temporary user.

flowUserStatus
enum<string>

Status of the flow's user: confirmed when the integration identified the user, temporary for an anonymous attempt attributed to its device. Absent when the flow has no user.

Available options:
confirmed,
temporary
linkedUserID
string

Set when this submission links the identifier to a user (format tus-<number>): the last finished submission before a successful login that verified this identifier.