Skip to content

Describes the server's account creation requirements and capabilities. Implemented by PDS.

GET
/xrpc/com.atproto.server.describeServer

Success

object
inviteCodeRequired

If true, an invite code must be supplied to create an account on this instance.

boolean
phoneVerificationRequired

If true, a phone verification token must be supplied to create an account on this instance.

boolean
availableUserDomains
required

List of domain suffixes that can be used in account handles.

Array<string>
links

URLs of service policy documents.

object
privacyPolicy
string format: uri
termsOfService
string format: uri
contact

Contact information

object
email
string
did
required
string format: did