pl-api
    Preparing search index...

    Type Alias CreateAccountParams

    CreateAccountParams: {
        accepts_email_list?: boolean;
        agreement: boolean;
        bio?: string;
        captcha_answer_data?: string;
        captcha_solution?: string;
        captcha_token?: string;
        date_of_birth?: string;
        domain?: string;
        email: string;
        fullname?: string;
        invite_code?: string;
        locale: string;
        password: string;
        reason?: string;
        token?: string;
        username: string;
    } & ({ message: string; signature: string } | {})

    Type declaration

    • Optionalaccepts_email_list?: boolean
    • agreement: boolean

      Whether the user agrees to the local rules, terms, and policies. These should be presented to the user in order to allow them to consent before setting this parameter to TRUE.

    • Optionalbio?: string
    • Optionalcaptcha_answer_data?: string

      optional, contains provider-specific captcha data

    • Optionalcaptcha_solution?: string

      optional, contains provider-specific captcha solution

    • Optionalcaptcha_token?: string

      optional, contains provider-specific captcha token

    • Optionaldate_of_birth?: string

      String (Date), required if the server has a minimum age requirement

    • Optionaldomain?: string

      optional, domain id, if multitenancy is enabled.

    • email: string

      String. The email address to be used for login

    • Optionalfullname?: string
    • Optionalinvite_code?: string

      Invite code

    • locale: string

      String. The language of the confirmation email that will be sent.

    • password: string

      String. The password to be used for login

    • Optionalreason?: string

      String. If registrations require manual approval, this text will be reviewed by moderators.

    • Optionaltoken?: string

      invite token required when the registrations aren't public.

    • username: string

      String. The desired username for the account

    • { message: string; signature: string }
      • message: string

        EIP-4361 message

      • signature: string

        EIP-4361 signature (required if message is present)

    • {}