Skip to main content
GET
/
user
/
connect
Check user connection status to the paywall
curl --request GET \
  --url https://api.paywalls.ai/v1/user/connect \
  --header 'Authorization: Bearer <token>'
{
  "connected": true,
  "connectedUser": {
    "paywallKeyId": "paywall_123",
    "userId": "user_456",
    "externalUserId": "ext_user_789",
    "createdAt": "2023-10-01T12:00:00Z"
  },
  "message": "User is connected to the paywall."
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Paywall-User
string

Optional user identifier provided by the developer. Can be used instead of the user property in the request body to associate the API call with a specific end user.

Query Parameters

​
user
string

The unique identifier of the user to check connection status for.

Response

200 - application/json

User is connected to the paywall.

  • Option 1
  • Option 2

Response structure when a user is connected and authorized to be charged via the paywall.

​
connected
boolean

Boolean indicating that the user is connected and authorized.

​
connectedUser
object

Information about a user who has successfully connected to a paywall. Includes internal and external user identifiers and the associated paywall key.

​
message
string

Human-readable message confirming the connection status.