Skip to main content
Adding an OnlyFans creator through the API takes two parts:
  1. You (or your code, or your AI assistant) create the creator in OnlyX and get her one-time setup link. It is the same link the dashboard copies with Copy setup link.
  2. The creator opens the link in a browser on her iPhone, Mac or Windows computer and signs in to OnlyFans herself in the OnlyX Login app: password, two-factor code, captcha, and OnlyFans’ face (selfie) check with the camera of that device.
Then you poll the connection until it says connected, and OnlyX syncs her inbox, fans, vault and earnings. This is the dashboard’s Connect with App method, the only one the API can start on its own. The dashboard has two more, described below. The step-by-step help your team follows in the dashboard is in the Help Center’s Connecting OnlyFans accounts section, and the pages written for the creator herself are in For creators.
The API never accepts OnlyFans passwords, two-factor codes or selfies. This is by design. With the setup link she types her login into OnlyFans’ own sign-in page, inside the app on her own device, and the app hands OnlyX the signed-in session, not her password. Do not collect her login, and do not ask an AI assistant to collect it.

Three ways to connect

In the dashboard, the sign-in window (on the Creators page: Add creator → Connect, or the Sign in / Reconnect button on her card) has three tabs. Only owners, admins and supervisors can open it. The API gives you the link two of them use, but every sign-in happens on a person’s screen: Which one to use:
  • She has an iPhone, a Mac or a Windows computer: Connect with App, as in this guide. Nobody on your team needs her password.
  • You hold her login and OnlyFans will not ask for her face: Connect here is quickest, but it exists only in the dashboard.
  • Her only device is an Android phone (OnlyX Login does not exist for Android or iPad): Connect with proxy, or she opens the setup link on any Mac or Windows computer.
Whichever method connects her, her link is used up and GET /v1/creators/{creatorId}/connection reports connected, so the polling in step 5 works for all three. The Help Center compares the methods in more detail in Connecting OnlyFans accounts.
Telegram creators connect differently. They have no OnlyFans sign-in and no link to send: your team adds them in the dashboard and connects either a ready managed Telegram account or her own number, with a code Telegram sends her. The API lists them with platform: "telegram", but POST /v1/creators adds only OnlyFans creators, and a connect link for a Telegram creator is refused with 409 CREATOR_NOT_CONNECTABLE. See Telegram creators in the Help Center.

Before you start

  • Scopes: creators:write (create the creator and the link) and creators:read (poll the connection).
  • The creator needs:
    • an iPhone, a Mac or a Windows computer to run OnlyX Login. The iPhone app is a TestFlight beta, installed through Apple’s free TestFlight app. On an Android phone, an iPad or a Linux computer her page shows Sign in from one of these and asks her to open the link on one of those three instead. If her only device is an Android phone, use Connect with proxy;
    • her OnlyFans email and password;
    • access to her two-factor method (authenticator app, SMS or email);
    • to be the account owner, in person, for OnlyFans’ face check;
    • a few quiet minutes, somewhere with good light.
  • She does not need an OnlyX account. The link is all she needs.

Step 1: Create the creator

POST /v1/creators with an Idempotency-Key header (required). If the request times out, send it again with the same key: you get the same creator back instead of a second one. Any other field is refused with 400 VALIDATION_ERROR. The credential must have access to every creator in the workspace: a key limited to some creators cannot add creators (403 INSUFFICIENT_SCOPE).
Response 201
The AI is on by default (aiEnabled: true) but does nothing until she is connected. You can set up her AI persona and AI content while you wait. Your team also sees her on the dashboard’s Creators page from now on, and can connect her from there with any of the three methods. POST /v1/creators/{creatorId}/connect-link returns her one-time setup link. No body is needed.
Response 201
The url is the link the dashboard copies with Copy setup link (in the ⋯ menu on her card on the Creators page, or on the Connect with App tab of the sign-in window). The API and the dashboard share it: whichever asks first creates it, and the other gets the same link back. Her sign-in involves up to three links. Only the first comes from the API: Send her the setup link, not an app sign-in link: it lasts a day, and her page makes a fresh app sign-in link whenever she needs one. The app accepts only app sign-in links, so the setup link’s web address never works inside the app. How the setup link behaves:
  • It is valid for 24 hours (expiresAt).
  • There is one live link per creator. Calling POST again while a link is active returns the same link, and so does Copy setup link in the dashboard, so re-sending it is safe and never breaks the one she already has.
  • It is used up the moment her account connects, whichever of the three methods connected it (status: "used").
  • You can revoke it at any time with DELETE /v1/creators/{creatorId}/connect-link (204); that revokes every unused link for the creator. Then POST again for a fresh one. The dashboard has no button to cancel a link, so this is the only way to kill one before it expires.
  • opens counts visits and hand-outs, and lastOpenedAt records the latest. Each load of her page counts, and so does each app sign-in link or proxy connection the page hands out, so one visit on an iPhone, Mac or Windows computer usually adds 2 (the page prepares an app sign-in link as it loads). The page’s own status checks while she waits do not count. If opens rises before you sent the link, or while she says she has not opened it, someone else has it: revoke it and send a new one.
  • You can create up to 20 connect links per hour per workspace.
  • A creator that cannot be connected through a link gets 409 CREATOR_NOT_CONNECTABLE, and no link is created: a Telegram creator or a test creator (no OnlyFans account behind her), or one whose status is final (not_a_creator or duplicate).
Treat the URL like a password. Anyone who has it can sign an OnlyFans account into this creator. Send it only to her, do not post it in shared channels, and do not log it. The API marks the response cache-control: no-store.
GET /v1/creators/{creatorId}/connect-link shows the current link, with status: "none" (and url, expiresAt, createdAt and lastOpenedAt all null, opens 0) if none was ever created. status is one of active, used, expired, revoked, none; url is null unless the link is active. Send the URL any way you normally reach her: SMS, WhatsApp, Telegram, Instagram DM or email. A message that works:
Hi Mia! Here is your secure link to connect your OnlyFans to our team’s inbox tool: <link>. Open it in the web browser on your iPhone, Mac or Windows computer (not inside the OnlyX Login app). The page walks you through installing OnlyX Login and signing in to OnlyFans yourself. We never see your password. Have your 2FA ready, and do it somewhere with good light, because OnlyFans may ask for a quick selfie check. The link works for 24 hours.
The Help Center’s For creators section is written for the creator herself (the OnlyX Login app on each device, and the Happ steps for the proxy method); you can send her its pages along with the link. If her only device is an Android phone, send her the proxy link instead (url with /proxy on the end, or Copy proxy link in the dashboard), and have someone on your team follow the proxy steps in Connecting OnlyFans accounts: they sign her in from the dashboard’s Connect here tab once her page shows her phone is on the network.

Step 4: She signs in (her side)

This is what she sees and does with the setup link. Share it with her if she gets stuck.
1

She opens the link in a browser

On an iPhone, a Mac or a Windows computer, the page is headed Sign in to OnlyFans, with her @handle and how long the link has left, and offers the OnlyX Login app for that device. Any other device (an Android phone, an iPad, a Linux computer) shows Sign in from one of these and asks her to open the same link on an iPhone, a Mac or a Windows computer.
2

She installs OnlyX Login, the first time only

  • Mac or Windows: she presses Download for Mac or Download for Windows and follows the short install steps on the page (on Windows, if “Windows protected your PC” appears, she presses More info, then Run anyway). Then she opens OnlyX Login once.
  • iPhone: the app is a TestFlight beta. She installs Apple’s free TestFlight app, taps Get the app (TestFlight) on the page, then Accept and Install in TestFlight, and opens OnlyX Login once. Its first screen says “Waiting for your link”, which is expected.
3

She opens her sign-in in the app

Back on the page, she presses Open in OnlyX Login and chooses Open when her browser or iPhone asks.
  • Mac or Windows: this button is the only way in. The desktop app has no “Paste your link” button, even though the page mentions one. If nothing opens, she opens OnlyX Login once from Applications (Mac) or the Start menu (Windows), then presses Open in OnlyX Login again.
  • iPhone only: chat apps often refuse to open app links. If tapping does nothing, she taps Copy app sign-in link on the page, opens OnlyX Login and taps Paste your link.
The app sign-in link the button uses works once, and for 15 minutes. If the app says the link has expired, she goes back to her page (the setup link lasts 24 hours) and presses Get a new app sign-in link.
4

She signs in to OnlyFans

OnlyFans’ own sign-in page opens inside the app. She enters her OnlyFans email and password there. The app hands OnlyX the signed-in session, not her password.
5

She completes two-factor authentication

If her account uses two-factor authentication (2FA), she enters the code from her authenticator app or SMS. If OnlyFans emails her a code, she opens her email and types it in.
6

She solves any captcha

OnlyFans sometimes shows a captcha (“verify you are human”). She solves it in the app.
7

She completes OnlyFans' face (selfie) check

OnlyFans may ask her to prove she is the account owner with a selfie or face scan. She allows camera access when asked, and follows OnlyFans’ on-screen steps inside the app, with the camera of the phone or computer she is signing in on. It has to be her, the person OnlyFans verified when she opened the account. Nobody can do this step for her.
8

The app says Connected

Once OnlyFans lets her in, the app hands the signed-in OnlyFans session (not her password) to OnlyX and shows Connected, and her page switches to “You’re connected”. She can close the app; nothing keeps running on her device. Keeping the app installed makes a future sign-in quicker.
A smooth sign-in takes a few minutes. Email codes, a captcha and a retried face check can stretch it much longer, so do not give up on her too early. The same steps, written for her, are in the Help Center’s For creators section.

Step 5: Poll the connection

GET /v1/creators/{creatorId}/connection tells you where she is. Poll it no more than once every 10 seconds while she is signing in (the API allows one call per 5 seconds per creator per key, and answers faster calls with 429). If she is not actively signing in, poll every few minutes instead.
Response 200 (while she signs in)
Response 200 (connected, syncing)
message is a human-readable sentence you can show to your team (for example Connected. once she is connected and the sync is complete). Branch your code on status and nextStep, never on message: Stop polling on connected, not_a_creator or duplicate, and when the link has expired without her opening it. The statuses are the same whichever method she connects with, so this loop also sees a sign-in your team does in the dashboard.

Step 6: Sync

After connected, OnlyX reads her OnlyFans data in the background. sync.phase moves through: sync.progress is a rough 0 to 100 percentage (or null), and sync.steps lists what is running now in plain labels (status is pending, running, done, failed or skipped). Step keys can change as OnlyX improves the sync, so show label rather than branching on key. Before she connects, sync is {"phase": null, "progress": null, "steps": []}. A large account can take hours to reach complete; you do not need to wait for it to start working.

Full script: create and wait

This script adds a creator, prints the setup link to send, and waits until she is connected (by any of the three methods), then reports sync progress. It retries safely: the Idempotency-Key is generated once, and 429 responses are honored.

The face check

OnlyFans sometimes asks the person signing in to prove she is the account owner with a selfie or face scan. It is the step most likely to go wrong, and only two of the three methods can pass it:
  • Connect with App (the setup link): she does it inside OnlyX Login, with the camera of the iPhone, Mac or Windows computer she is signing in on. The iPhone app is a TestFlight beta; if an iPhone sign-in stalls at the face check, a Mac or Windows computer, or the proxy method, is the way round it.
  • Connect with proxy: your team forwards the verification link or QR code that OnlyFans shows in the dashboard’s streamed browser, and she opens it in Safari or Chrome on the phone that has Happ turned on. It can pass there because her phone and the account’s browser then share one internet address.
Connect here cannot pass it: the browser streamed into the dashboard has no camera. If a face check appears there, switch the same sign-in window to Connect with App or Connect with proxy. The Help Center explains the check for your team in Connecting OnlyFans accounts and for her in For creators. Share these with her before she starts:
  • Good, even light on her face. Face a window or a lamp; do not sit with a bright window behind her.
  • Nothing covering her face: no sunglasses, hat, mask or heavy filter. Hold the phone at eye level and follow the prompts slowly.
  • It must be the account owner, the same person OnlyFans verified when the account was opened. A manager, assistant or friend cannot do it for her.
  • Finish it where it started. With the setup link, the check has to happen inside OnlyX Login: do not open OnlyFans’ verification page in a separate browser or on another device, and keep the app open in the foreground until it says Connected. With the proxy link, she keeps Happ on until the check is done.
  • Do not retry again and again. OnlyFans may limit how many face checks an account can start. If it fails twice, stop and try again later or the next day.
  • Allow camera access when the app or her device asks. If she refused it by mistake on an iPhone, she switches it on in Settings › OnlyX Login › Camera and opens her link again. OnlyX does not record the check.

What the API cannot do

These are deliberate limits, so that the API never handles an OnlyFans login:
  • It cannot sign in for her. There is no field for an OnlyFans password, a two-factor code, an email code, a captcha answer or a selfie, and there never will be.
  • It cannot run Connect here or the proxy sign-in. Both happen in the dashboard’s sign-in window, by a person.
  • It cannot hand out an app sign-in link. Her setup page makes those, and so does the dashboard’s Connect with App tab.
  • It cannot complete OnlyFans’ face check or captcha. She does both, on her device.
  • It cannot resolve the verification state. Someone on your team does that in the dashboard (Verify on OnlyFans), or she signs in again through her setup link if OnlyFans wants her face.
  • It cannot add or connect Telegram creators. Your team does that in the dashboard (see Telegram creators).
  • It cannot delete or disconnect a creator in v1. Use the dashboard.

Troubleshooting

The app is not installed yet, has never been opened, or her browser or chat app blocked the hand-off. On a Mac or Windows computer she installs the app from the page, opens OnlyX Login once from Applications (Mac) or the Start menu (Windows), and presses Open in OnlyX Login again. On an iPhone she taps Copy app sign-in link on the page, opens OnlyX Login and taps Paste your link.
OnlyX Login runs on iPhone, Mac and Windows only, so her page shows Sign in from one of these. She can open the same link on any Mac or Windows computer, including a friend’s, as long as she signs in herself. Or use Connect with proxy: send her the proxy link (url with /proxy on the end) to open on her phone, and your team signs her in from the dashboard.
In the app, she signs out inside the sign-in window and signs in again with the right account; she does not need a new link. If a fan account or an account that is already a creator in your workspace got through, the status says so (not_a_creator or duplicate).
Stop retrying. Improve the light, remove anything covering her face, and make sure the account owner is doing it inside OnlyX Login. If OnlyFans says there were too many attempts, wait until the next day. Her link lasts 24 hours; if it expires meanwhile, create a new one.
Check opens on her connect link first: 0 means she has not opened it yet. If she has, she may be stuck on an email code, a captcha or the face check: ask her what the app shows. If she gave up, she can open the same link again while it is active.
OnlyFans wants a check on the account before it lets OnlyX work. Someone on your team opens the creator in app.onlyx.ai, presses Verify on OnlyFans and completes what OnlyFans shows. If OnlyFans wants her face, that streamed browser cannot pass it: send her the setup link so she signs in again on her own device, or use the proxy method. When it is done, the status returns to connected.
Someone signed in with an OnlyFans fan account. Delete the creator in the dashboard, add her again, and remind her to use the account she posts from.
That OnlyFans account is already a creator in your workspace (duplicateOfCreatorId). Keep working with that one and delete the duplicate in the dashboard with Delete this copy. Do not sign in again on the copy.
OnlyFans signed the account out, which happens from time to time, and the dashboard shows Signed out. Your team can press Reconnect in the dashboard and use any of the three methods, or you create a connect link and send it to her; the sign-in is the same as the first time.
The creator has no OnlyFans account to sign in to (a Telegram creator or a test creator), or her status is final (not_a_creator, duplicate). Telegram creators are connected in the dashboard: see Telegram creators.
OnlyX cannot place a new creator this minute. Wait a few minutes and retry with the same Idempotency-Key.

Doing this from your AI assistant

With the OnlyX MCP server connected, you can ask: “Add a new creator called Mia Rose, handle miarose, and give me her connect link.” The assistant calls add_creator and create_connect_link, and can check back later with get_connection_status. It will never ask for her password: the only thing it produces is the setup link you send her. The onboard_a_creator prompt runs the whole flow. Like the API, the assistant cannot do a Connect here or proxy sign-in; those happen in the dashboard.