OnlyFans API DocumentationOnlyFans API
Account Connection

Authentication Status

Poll the status of an OnlyFans account connection attempt.

Poll the status of an authentication attempt started by Authenticate Account. Use the attempt_id returned by the authentication request, or request the polling_url directly. While authentication is in progress, state is active. Keep polling until it changes to completed. The connected account is then available in returnvalue.

https://v1.onlyfansapi.io
GET
/api/authenticate/{attemptId}
Request
curl --request GET \
  --url 'https://v1.onlyfansapi.io/api/authenticate/{attemptId}' \
  --header 'x-api-key: YOUR_API_KEY'

Headers

x-api-key*
string
Your API key. See Authentication.

Path Parameters

attemptId*
string
The attempt_id returned when the connection attempt was started.

Response Fields

FieldTypeDescription
dataobjectThe attempt.
├─ jobIdstringIdentifier of the job running the login.
├─ statestringactive while the login is in progress, completed once the account is connected.
├─ messagestringThe step the login has reached, ending at account connected.
├─ progressobjectStructured form of the same progress report.
│ └─ messagestringThe step the login has reached.
├─ emailstringThe email address the attempt is signing in with.
├─ returnvalueobjectThe result. null until the attempt finishes.
│ ├─ statusstringOutcome of the job.
│ └─ resultobjectWrapper around the connection result.
│ ├─ statusstringOutcome of the connection itself, such as success.
│ └─ result.accountobjectThe connected account.
├─ attemptsMadenumberHow many attempts the job has made.
├─ timestampnumberWhen the attempt was queued, in epoch milliseconds.
├─ processedOnnumberWhen work on the attempt started, in epoch milliseconds.
└─ finishedOnnumberWhen the attempt finished, in epoch milliseconds. Absent while it is still running.

The Account Object

Found at data.returnvalue.result.result.account once the attempt completes.

FieldTypeDescription
acct_idstringIdentifier for the connected account, prefixed acct_. Use it wherever an endpoint takes an acct_id.
idnumberInternal row ID. Not used by any endpoint.
user_idstringYour API user the account belongs to.
emailstringThe email address the account signs in with.
namestringThe label you sent as name.
country_codestringThe proxy country the account is routed through.
created_atstringISO 8601 timestamp of when the account was connected.
updated_atstringISO 8601 timestamp of the last change to the account.