Acquisition of client token and domain

This section outlines the steps necessary to register on the face-auth platform, obtain a client token, and generate a domain for use with the @face-auth/face-id package.

Registration Process

To register as a new user on the face-auth platform, follow these steps:

1. Access the Registration Page: Visit app.face-auth.me to begin the registration process.
2. Complete the Registration Wizard: Upon accessing the URL, you will be guided through a wizard. You will need to provide your email address that you wish to use.
3. Email Validation: After completing the registration form you must validate your email address. A validation link will be sent to your email.

Generating the Domain

The domain is chosen by the client after the registration process. Here are some guidelines and considerations:

1. Client-Generated Domain: The domain is not generated by the face-auth platform but is instead chosen by you. While it does not need to be a valid URL format, if you have a real domain, it is recommended to use that text to ensure uniqueness.
2. Guidelines for Domain Creation:
   • The domain must be more than 3 characters long.
   • It can include the same special characters allowed in a URL.
   • It should be less than 128 characters in length.
3. Domain Validity: The domain does not need to be associated with a real website or application. However, if you choose a real domain, you must ensure that you own it.

Obtaining the Client Token

Once you have registered and validated your email, the face-auth platform will automatically generate your client token.

Here are the key details:

1. Automatic Generation: The client token is generated automatically by the system after you complete the registration, select your domain, and validate your email.
2. Security and Storage: The client token is a secret value that you must keep secure. Follow best practices for storing secret keys to ensure its safety.
3. Accessing the Client Token: Once generated, the client token cannot be retrieved again. If you forget or lose your client token, you must request a new one to be autogenerated. This new token will replace the previous one.

By following these steps, you can successfully register on the face-auth platform, obtain your client token, and generate a suitable domain for your application.