social.coves.actor.signup Documentation (EN)

main procedure

Input

Encodingapplication/json

email string Required

Email address for account recovery and notifications

maxLength: 320 bytes

handle stringhandle Required

Requested handle for the account (e.g., alice.coves.dev)

inviteCode string Optional

Invite code (required if instance has invite-only registration)

maxLength: 128 bytes

password string Required

Account password (must meet strength requirements)

maxLength: 512 bytes

Output

Encodingapplication/json

accessJwt string Required

Access token for authenticated requests

did stringdid Required

The DID of the newly created account

handle stringhandle Required

The handle of the newly created account

refreshJwt string Required

Refresh token for obtaining new access tokens

Errors

InvalidHandle Handle does not meet format requirements

HandleNotAvailable The requested handle is already taken

InvalidInviteCode The provided invite code is invalid or expired

InvalidEmail The email address is invalid

WeakPassword Password does not meet strength requirements

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "handle",
        "email",
        "password"
      ],
      "properties": {
        "email": {
          "type": "string",
          "maxLength": 320,
          "description": "Email address for account recovery and notifications"
        },
        "handle": {
          "type": "string",
          "format": "handle",
          "description": "Requested handle for the account (e.g., alice.coves.dev)"
        },
        "password": {
          "type": "string",
          "maxLength": 512,
          "description": "Account password (must meet strength requirements)"
        },
        "inviteCode": {
          "type": "string",
          "maxLength": 128,
          "description": "Invite code (required if instance has invite-only registration)"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidHandle",
      "description": "Handle does not meet format requirements"
    },
    {
      "name": "HandleNotAvailable",
      "description": "The requested handle is already taken"
    },
    {
      "name": "InvalidInviteCode",
      "description": "The provided invite code is invalid or expired"
    },
    {
      "name": "InvalidEmail",
      "description": "The email address is invalid"
    },
    {
      "name": "WeakPassword",
      "description": "Password does not meet strength requirements"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "did",
        "handle",
        "accessJwt",
        "refreshJwt"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "The DID of the newly created account"
        },
        "handle": {
          "type": "string",
          "format": "handle",
          "description": "The handle of the newly created account"
        },
        "accessJwt": {
          "type": "string",
          "maxLength": 8192,
          "description": "Access token for authenticated requests"
        },
        "refreshJwt": {
          "type": "string",
          "maxLength": 8192,
          "description": "Refresh token for obtaining new access tokens"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Register a new account on the Coves instance. Creates account on PDS and indexes in AppView."
}