Skip to main content
POST
/
v1
/
connect
/
client-sessions
Create an embeddable connect session
curl --request POST \
  --url https://api.onlyfanskit.dev/v1/connect/client-sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "client_reference_id": "<string>",
  "remember_credentials": true
}
'
{
  "attempt_id": "<string>",
  "account_id": "<string>",
  "polling_url": "<string>",
  "verification_page_url": "<string>",
  "phone_url": "<string>",
  "embed_url": "<string>",
  "otp_channel": "<string>",
  "email_mask": "<string>",
  "next_actions": [
    "<string>"
  ],
  "client_session_id": "<string>",
  "client_reference_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onlyfanskit.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
display_name
string
Maximum string length: 120
​
client_reference_id
string
Maximum string length: 120
​
proxy_country
enum<string>

Egress proxy region for the account's traffic.

Available options:
us,
uk
​
remember_credentials
boolean

Response

201 - application/json

Client session created

​
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[]
​
client_session_id
string
​
client_reference_id
string | null