PendingRegistrationService

class PendingRegistrationService

Methods

confirm	Verify the email code and finalize the registration.
create	Create a pending registration and send a verification code.

confirm(json_body, *, token)

Verify the email code and finalize the registration.

The user provides the verification code along with their desired username, name, and (optionally) password. If the username is already taken, the code is not consumed and the user can retry.

Parameters:

• json_body (ConfirmPendingRegistrationData) – The body of the request. See ConfirmPendingRegistrationData for information about the possible fields. You can provide this data as a ConfirmPendingRegistrationData or as a dictionary.

• token (str) – The pending registration identifier.

Returns:

A login response or quarantine status.

Return type:

ConfirmRegisteredResponse | ConfirmQuarantinedResponse

create(json_body)

Create a pending registration and send a verification code.

Only an email address is required. The account details (username, name, password) are provided when confirming the registration.

Parameters:

json_body (CreatePendingRegistrationData) – The body of the request. See CreatePendingRegistrationData for information about the possible fields. You can provide this data as a CreatePendingRegistrationData or as a dictionary.

Returns:

An identifier for the pending registration.

Return type:

PendingRegistrationResponse