Skip to main content
POST
Connect with email + password

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>.

Body

application/json
auth_type
enum<string>
default:credentials
Available options:
credentials,
mobile_app
email
string<email>

Required for credentials login.

password
string

Required for credentials login.

label
string
Maximum string length: 120
remember_credentials
boolean

Seal credentials to enable later reauthentication.

proxy_country
enum<string>

Egress proxy region for the account's traffic.

Available options:
us,
uk

Response

Attempt started

attempt_id
string
state
enum<string>

Lifecycle state of the attempt.

Available options:
pending,
awaiting_mobile_session,
needs_otp,
needs_app_otp,
needs_email,
needs_face_otp,
wrong_2fa_code_retry,
completed_success,
completed_failed
account_id
string | null

Present once state is completed_success.

polling_url
string | null
verification_page_url
string | null
phone_url
string | null
embed_url
string | null
otp_channel
string | null
email_mask
string | null
next_actions
string[]