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*
stringYour API key. See Authentication.
Path Parameters
attemptId*
stringThe
attempt_id returned when the connection attempt was started.Response Fields
| Field | Type | Description |
|---|---|---|
data | object | The attempt. |
├─ jobId | string | Identifier of the job running the login. |
├─ state | string | active while the login is in progress, completed once the account is connected. |
├─ message | string | The step the login has reached, ending at account connected. |
├─ progress | object | Structured form of the same progress report. |
│ └─ message | string | The step the login has reached. |
├─ email | string | The email address the attempt is signing in with. |
├─ returnvalue | object | The result. null until the attempt finishes. |
│ ├─ status | string | Outcome of the job. |
│ └─ result | object | Wrapper around the connection result. |
│ ├─ status | string | Outcome of the connection itself, such as success. |
│ └─ result.account | object | The connected account. |
├─ attemptsMade | number | How many attempts the job has made. |
├─ timestamp | number | When the attempt was queued, in epoch milliseconds. |
├─ processedOn | number | When work on the attempt started, in epoch milliseconds. |
└─ finishedOn | number | When 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.
| Field | Type | Description |
|---|---|---|
acct_id | string | Identifier for the connected account, prefixed acct_. Use it wherever an endpoint takes an acct_id. |
id | number | Internal row ID. Not used by any endpoint. |
user_id | string | Your API user the account belongs to. |
email | string | The email address the account signs in with. |
name | string | The label you sent as name. |
country_code | string | The proxy country the account is routed through. |
created_at | string | ISO 8601 timestamp of when the account was connected. |
updated_at | string | ISO 8601 timestamp of the last change to the account. |