> ## Documentation Index > Fetch the complete documentation index at: https://docs.onlyfansapi.com/llms.txt > Use this file to discover all available pages before exploring further. # Poll Authentication Status (/api-reference/connect-onlyfans-account/poll-authentication-status) Poll the status of the authentication process. Eg. if 2FA is required, we will ask you for the code using the `twoFactorPending = true` in the response body. For `mobile_app` auth, the response includes `mobile_auth_session_deeplink` while the session is pending. ## OpenAPI ````yaml https://app.onlyfansapi.com/scribe-docs/openapi.yaml get /api/authenticate/{attempt_id} openapi: 3.0.3 info: title: OnlyFans API description: "" version: 1.0.0 servers: - url: https://app.onlyfansapi.com security: - default: [] tags: - name: API Keys description: "" - name: Account description: Endpoints for your linked accounts - name: Analytics - Financial description: APIs for retrieving financial analytics data - name: Analytics - Summary description: APIs for retrieving summary analytics data - name: Banking description: Operations related to user banking details, payout methods, legal and tax information, and account country settings. - name: Chargebacks description: "" - name: Chat Messages description: "" - name: Chats description: "" - name: Client Sessions description: "" - name: Connect OnlyFans Account description: "" - name: Data Exports description: APIs for managing data exports - name: Engagement / Messages description: "" - name: Fans description: APIs for managing OnlyFans fans (subscribers) - name: Fans - AI Summary description: APIs for generating and retrieving AI-powered fan profile summaries - name: Following description: APIs for managing OnlyFans followings (people you're subscribed to) - name: Free Trial Links description: APIs for managing Free Trial Links - name: Giphy description: "" - name: Link Tags description: APIs for managing tags on free trial links and tracking links - name: Mass Messaging description: "" - name: Media description: "" - name: Media Vault description: "" - name: Media Vault Lists description: "" - name: Notifications description: Endpoints for managingr account notifications - name: Payouts description: "" - name: Post Comments description: "" - name: Post Labels description: APIs for managing your post labels - name: Posts description: APIs for managing OnlyFans posts - name: Promotions description: "" - name: Public Profiles description: "" - name: Queue description: "" - name: Release Forms description: APIs for managing OnlyFans release forms - name: Saved For Later (Messages) description: "" - name: Saved For Later (Posts) description: "" - name: Settings description: "" - name: Shared Free Trial Links description: APIs for Free Trial Links that other OF creators have shared with this account. Revenue, cost, and spender data are not available for shared links. - name: Shared Tracking Links description: APIs for Tracking Links (campaigns) that other OF creators have shared with this account. Revenue, cost, and spender data are not available for shared campaigns. - name: Smart Link Postbacks description: APIs for managing Smart Link postback destinations - name: Smart Links description: APIs for managing Smart Links (Free Trial Links and Tracking Links with pooled inventory) - name: Statistics description: "" - name: Stored Free Trial Links description: Instant APIs for retrieving stored free trial links from the OnlyFansAPI Cache (free, no credits used) - name: Stored Shared Free Trial Links description: Instant APIs for retrieving stored shared Free Trial Links from the OnlyFansAPI Cache (free, no credits used) - name: Stored Shared Tracking Links description: Instant APIs for retrieving stored shared Tracking Links (campaigns) from the OnlyFansAPI Cache (free, no credits used) - name: Stored Tracking Links description: Instant APIs for retrieving stored tracking links from the OnlyFansAPI Cache (free, no credits used) - name: Stories description: APIs for managing OnlyFans stories - name: Story Highlights description: APIs for managing OnlyFans story highlights - name: Subscription Bundles description: "" - name: Tracking Links description: APIs for managing tracking links - name: Transactions description: APIs for managing OnlyFans transactions - name: User List Collections description: "" - name: Users description: APIs for fetching OnlyFans users - name: Webhooks description: "" paths: /api/authenticate/{attempt_id}: parameters: - in: path name: attempt_id description: The attempt ID of the authentication process example: auth_XXXXXXX required: true schema: type: string get: summary: Poll Authentication Status operationId: pollAuthenticationStatus description: Poll the status of the authentication process. Eg. if 2FA is required, we will ask you for the code using the `twoFactorPending = true` in the response body. For `mobile_app` auth, the response includes `mobile_auth_session_deeplink` while the session is pending. parameters: [] responses: "200": description: "" content: application/json: schema: type: object example: account: id: acct_4d3fa20f055b4cbababab0d7e400550d display_name: ipgod@gmail.com onlyfans_data: id: 123456789 ip: 127.0.0.1 csrf: abcdef123456789 name: Demo User view: f about: null email: demo@example.com wsUrl: wss://ws2.onlyfans.com/ws3/00 avatar: null header: null isAuth: true ivFlow: default upload: geoUploadArgs: preset: of_beta isDelay: true additional: user: "123456789" needThumbs: true preset_png: of_png protected_preset: of_drm canChat: true hasTags: true website: null advBlock: - subscribe_offers ivStatus: null joinDate: 2022-01-01T00:00:00+00:00 lastSeen: 2025-01-01T12:00:00+00:00 location: null paidFeed: false username: demouser123 wishlist: null hasLabels: false ivCountry: null canAddCard: true canPinPost: true creditsMax: 200 creditsMin: 10 headerSize: null isVerified: false postsCount: 0 audiosCount: 0 hasNewHints: true hasScenario: true isPerformer: false mediasCount: 0 photosCount: 0 videosCount: 0 wsAuthToken: dummy.jwt.token avatarThumbs: null canLookStory: true hasNewAlerts: false headerThumbs: null isOtpEnabled: false ivFailReason: Verification failed newTagsCount: 0 creditBalance: 0 faceIdRegular: [] isAgeVerified: true isAllowTweets: false isMakePayment: false needIVApprove: false watermarkText: OnlyFans.com/demouser123 canCreateLists: true canPayInternal: true favoritedCount: 0 favoritesCount: 0 hasPinnedPosts: false isEmailChecked: false isWantComments: true canCommentStory: true countPinnedChat: 0 isEmailRequired: false isPaywallPassed: false isRealPerformer: false isVisibleOnline: true showPostsInFeed: true subscribesCount: 0 twitterUsername: null canSendChatToAll: false isCreditsEnabled: true pinnedPostsCount: 0 subscribersCount: 0 chatMessagesCount: 0 countPriorityChat: 0 hasNotViewedStory: false hasPurchasedPosts: false hasWatermarkPhoto: true hasWatermarkVideo: true isDeleteInitiated: false isReferrerAllowed: false watermarkPosition: bottom_right archivedPostsCount: 0 isSpotifyConnected: false isTwitterConnected: false notificationsCount: 0 walletFirstRebills: false canConnectOfAccount: false connectedOfAccounts: [] hasInternalPayments: false hasNewTicketReplies: open: false closed: false solved: false isRealCardConnected: false maxPinnedPostsCount: 5 isWalletAutorecharge: false canReceiveChatMessage: false walletAutorechargeMin: 0 ageVerificationSession: url: https://age.yoti.com/age-estimation?sessionId=dummy-session-id&sdkId=dummy-sdk-id status: complete apiFlow: of3 expiredAt: 2022-11-15T00:54:42+00:00 hasSystemNotifications: false isLegalApprovedAllowed: false isPaymentCardConnected: false ageVerificationRequired: false payoutLegalApproveState: none walletAutorechargeAmount: 0 canAlternativeWalletTopUp: false enabledImageEditorForChat: true privateArchivedPostsCount: 0 isMarkdownDisabledForAbout: false avatarHeaderConverterUpload: true hasNewChangedPriceSubscriptions: false state: authenticated progress: signed_in lastAttempt: started_at: 2025-03-30T19:40:09.000000Z completed_at: 2025-03-30T19:41:44.000000Z success: true error_message: null error_code: null needs_otp: false otp_phone_ending: null properties: account: type: object properties: id: type: string example: acct_4d3fa20f055b4cbababab0d7e400550d display_name: type: string example: ipgod@gmail.com onlyfans_data: type: object properties: id: type: integer example: 123456789 ip: type: string example: 127.0.0.1 csrf: type: string example: abcdef123456789 name: type: string example: Demo User view: type: string example: f about: type: string example: null nullable: true email: type: string example: demo@example.com wsUrl: type: string example: wss://ws2.onlyfans.com/ws3/00 avatar: type: string example: null nullable: true header: type: string example: null nullable: true isAuth: type: boolean example: true ivFlow: type: string example: default upload: type: object properties: geoUploadArgs: type: object properties: preset: type: string example: of_beta isDelay: type: boolean example: true additional: type: object properties: user: type: string example: "123456789" needThumbs: type: boolean example: true preset_png: type: string example: of_png protected_preset: type: string example: of_drm canChat: type: boolean example: true hasTags: type: boolean example: true website: type: string example: null nullable: true advBlock: type: array example: - subscribe_offers items: type: string ivStatus: type: string example: null nullable: true joinDate: type: string example: 2022-01-01T00:00:00+00:00 lastSeen: type: string example: 2025-01-01T12:00:00+00:00 location: type: string example: null nullable: true paidFeed: type: boolean example: false username: type: string example: demouser123 wishlist: type: string example: null nullable: true hasLabels: type: boolean example: false ivCountry: type: string example: null nullable: true canAddCard: type: boolean example: true canPinPost: type: boolean example: true creditsMax: type: integer example: 200 creditsMin: type: integer example: 10 headerSize: type: string example: null nullable: true isVerified: type: boolean example: false postsCount: type: integer example: 0 audiosCount: type: integer example: 0 hasNewHints: type: boolean example: true hasScenario: type: boolean example: true isPerformer: type: boolean example: false mediasCount: type: integer example: 0 photosCount: type: integer example: 0 videosCount: type: integer example: 0 wsAuthToken: type: string example: dummy.jwt.token avatarThumbs: type: string example: null nullable: true canLookStory: type: boolean example: true hasNewAlerts: type: boolean example: false headerThumbs: type: string example: null nullable: true isOtpEnabled: type: boolean example: false ivFailReason: type: string example: Verification failed newTagsCount: type: integer example: 0 creditBalance: type: integer example: 0 faceIdRegular: type: array example: [] isAgeVerified: type: boolean example: true isAllowTweets: type: boolean example: false isMakePayment: type: boolean example: false needIVApprove: type: boolean example: false watermarkText: type: string example: OnlyFans.com/demouser123 canCreateLists: type: boolean example: true canPayInternal: type: boolean example: true favoritedCount: type: integer example: 0 favoritesCount: type: integer example: 0 hasPinnedPosts: type: boolean example: false isEmailChecked: type: boolean example: false isWantComments: type: boolean example: true canCommentStory: type: boolean example: true countPinnedChat: type: integer example: 0 isEmailRequired: type: boolean example: false isPaywallPassed: type: boolean example: false isRealPerformer: type: boolean example: false isVisibleOnline: type: boolean example: true showPostsInFeed: type: boolean example: true subscribesCount: type: integer example: 0 twitterUsername: type: string example: null nullable: true canSendChatToAll: type: boolean example: false isCreditsEnabled: type: boolean example: true pinnedPostsCount: type: integer example: 0 subscribersCount: type: integer example: 0 chatMessagesCount: type: integer example: 0 countPriorityChat: type: integer example: 0 hasNotViewedStory: type: boolean example: false hasPurchasedPosts: type: boolean example: false hasWatermarkPhoto: type: boolean example: true hasWatermarkVideo: type: boolean example: true isDeleteInitiated: type: boolean example: false isReferrerAllowed: type: boolean example: false watermarkPosition: type: string example: bottom_right archivedPostsCount: type: integer example: 0 isSpotifyConnected: type: boolean example: false isTwitterConnected: type: boolean example: false notificationsCount: type: integer example: 0 walletFirstRebills: type: boolean example: false canConnectOfAccount: type: boolean example: false connectedOfAccounts: type: array example: [] hasInternalPayments: type: boolean example: false hasNewTicketReplies: type: object properties: open: type: boolean example: false closed: type: boolean example: false solved: type: boolean example: false isRealCardConnected: type: boolean example: false maxPinnedPostsCount: type: integer example: 5 isWalletAutorecharge: type: boolean example: false canReceiveChatMessage: type: boolean example: false walletAutorechargeMin: type: integer example: 0 ageVerificationSession: type: object properties: url: type: string example: https://age.yoti.com/age-estimation?sessionId=dummy-session-id&sdkId=dummy-sdk-id status: type: string example: complete apiFlow: type: string example: of3 expiredAt: type: string example: 2022-11-15T00:54:42+00:00 hasSystemNotifications: type: boolean example: false isLegalApprovedAllowed: type: boolean example: false isPaymentCardConnected: type: boolean example: false ageVerificationRequired: type: boolean example: false payoutLegalApproveState: type: string example: none walletAutorechargeAmount: type: integer example: 0 canAlternativeWalletTopUp: type: boolean example: false enabledImageEditorForChat: type: boolean example: true privateArchivedPostsCount: type: integer example: 0 isMarkdownDisabledForAbout: type: boolean example: false avatarHeaderConverterUpload: type: boolean example: true hasNewChangedPriceSubscriptions: type: boolean example: false state: type: string example: authenticated progress: type: string example: signed_in lastAttempt: type: object properties: started_at: type: string example: 2025-03-30T19:40:09.000000Z completed_at: type: string example: 2025-03-30T19:41:44.000000Z success: type: boolean example: true error_message: type: string example: null nullable: true error_code: type: string example: null nullable: true needs_otp: type: boolean example: false otp_phone_ending: type: string example: null nullable: true tags: - Connect OnlyFans Account components: securitySchemes: default: type: http scheme: bearer description: Get your API Key from OnlyFansAPI Console - https://app.onlyfansapi.com/api-keys ````