Registration (sign-up) page

• Create a brand new client record.
• Merge the input into an existing lead when the existing record is still in an early handling stage.
• Keep the existing active client unchanged, while storing the new input as a follow-up sales opportunity.

Page Structure

1. Browser Page Title

2. Page Header

3. Page Fields

4. User Consent (I Agree) Checkboxes

• [Accept Commercial Info to Cellphone]: Displayed as a checkbox to the user. It saves the current Date and Time in Hyper and sets the [Question to use cell phone] field value to 1 (Website Form).
• [Accept Commercial Info to Email]: Displayed as a checkbox to the user. It saves the current Date and Time in Hyper and sets the [Question to use Email] field value to 1 (Website Form).
• [Accept Commercial Info Checkbox]: Provides dual consent via a single question. Displays one checkbox to the user but updates all four related fields mentioned above.
• [Agree to Terms Checkbox]: Represents the "Website Terms and Conditions". Displayed as a checkbox to the user and saves the Date and Time in Hyper.

5. Security CAPTCHA

Passing Values on Initial Page Load

GET /RegisterClient?LeadSupplier=CompanyWebsite&gclid=Cj0...Y8z&utm_source=google&utm_medium=cpc&utm_campaign=summer24&utm_term=in_quotes&utm_content=red_banner HTTP/1.1
Host: example.com
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64)
Accept: text/html
Referer: https://www.google.com/

Form Submission

1. Verify that String field values match the acceptable languages defined in the global CRM configuration.
2. Ensure all mandatory fields are filled out.
3. If an Email field is included, verify that the address format is valid. This includes running a DNS MX test for private domains.
4. If a Phone Number field is included, confirm it contains only digits and is between 9 and 13 characters long.
5. If a Birthday field is included, verify that the client's age meets the minimum requirement set in
   [Website Accept Client Age above # years]
   .
6. If a Password field is included, it must be at least 8 characters long, containing at least 2 digits and 3 letters.
   When using exclusively English characters, combining uppercase and lowercase letters is mandatory.
7. If an ID Number field is included, perform a logical validation test when applicable (e.g., the Luhn algorithm).
   The test relies on the
   [Country Issuing ID]
   client field if available; otherwise, it defaults to the
   [Country]
   field.
   If both fields are empty, the system assumes the client resides in the organization's or branch's operating country.
8. If a Confirm Password field is included, ensure its value matches the Password field exactly.
9. If a Confirm Email field is included, ensure its value matches the Email field (this check is not case-sensitive).
10. Validate the CAPTCHA test (default or Google reCAPTCHA). If validation fails, reload the HTML page with the entered field values, allowing the user to try again.
11. Perform a WAF (Web Application Firewall) check to see if this exact input (JSON or form) was already posted within the last hour. If true, abort and return Error Code 30.

12. Duplicity Check

    1. Search for existing clients matching the provided Email Address, Phone Number, or ID Number.
       If the index module fails to respond, halt the entire process and return Error Code 24.
    2. In the RARE case that a client record is found with a matching ID but a different Email or Phone Number,
       halt the process and redirect the user to the
       'login'
       page with the following popup message:
       'You have already registered before with different details. Please contact customer service to correct the registration.'
    3. If duplicity is found, perform a secondary check on the client's "Handling Status".
       IF the status is < 4 (0-3), the first found record is MERGED with the newly registered data.
       Any field that cannot be merged is pushed into the [hyp_Sale Opportunity Web Input] table to prevent data loss.
    4. IF the status is > 3 (4-6), ALL new data is pushed directly into the [hyp_Sale Opportunity Web Input] table.
    In cases C and D, a New Sale Opportunity is created to facilitate client follow-up.
    
    

13. Create a New Client Record

    1. Populate specific
       [hyp_Clients]
       table fields:
       Set
       [Docs & Forms Language]
       to the current session language.
       Set
       [Use Currency by Default]
       to the default bookkeeping currency.
       Set the
       [Lead Status]
       field to 1 (Newly Created) and
       [Last Lead Input]
       to NOW (UTC).
    2. Determine which Agency to assign to this client, using the following priorities:
       • IF either
         [Default Sales Agent]
         or
         [Default Relationship Manager]
         fields were provided, assign the client to that agent's agency!
       • IF
         [Agency]
         was provided (not null), assign the client to it.
       • Use the default field value if defined in the Matrix.
       • Fallback to the default agency for this API instance (every Domain is linked to a 'Hyper User' or 'Server-side Agency').
    3. Set the
       [Created on]
       field to the current local time based on the agency's timezone.
    4. IF the "Accept Commercial Info" OR "Accept Commercial Info to Cellphone" checkbox was submitted as true/1:
       Set
       [Accept Commercial Info to Cell phone]
       to the current local time, and set
       [Question to use cell phone]
       to 1 (Website Form).
    5. IF the "Accept Commercial Info" OR "Accept Commercial Info to Email" checkbox was submitted as true/1:
       Set
       [Accept Commercial Info to Email]
       to the current local time, and set
       [Question to use Email]
       to 1 (Website Form).
    6. Configure
       [hyp_Clients Website Ext. Record]
       fields:
       • Set
         [Last Registration Step]
         and
         [Registration Complete Until Step]
         to 1 (Page 1).
       • Set
         [First Reg. Page Date]
         to Today. Set
         [Account Status]
         to 1 (Pending Approval).
       • Generate an
         [API Password]
         .
         IF the Matrix includes the
         [Password]
         field under the
         [hyp_Clients]
         table, copy it to
         [Portal Password]
         .
       • IF the "Agree to Terms and Conditions" checkbox was submitted as true/1, set
         [Agree to Terms check-box]
         to Today.
    
    This concludes the client creation phase. The data is now saved to the database. The process continues to Step #15.

14. Merging Data with Client LEAD   (Status 0-3)

    1. Copy each newly posted field to the base tables
       [hyp_Clients]
       and
       [hyp_Clients Record Extension]
       ONLY when the target field is EMPTY!
       Otherwise, push the posted field into the [hyp_Sale Opportunity Web Input] table.
    2. Update specific
       [hyp_Clients]
       table fields:
       • Change
         [Docs & Forms Language]
         to the current session language.
       • IF empty, set
         [Use Currency by Default]
         to the default bookkeeping currency.
       • IF
         [Handling Status] = 3
         (Not Interested), reset it to 0 (New).
       • Set the
         [Lead Status]
         field to 2 (HOT Lead) or 3 (Interested Again), depending on the current client status.
    3. Complete any empty fields in the
       [hyp_Clients Website Ext. Record]
       table to meet the standards outlined in Section 12.F.
    This concludes the merge phase. The data is now saved to the database. The process continues to Steps #15 and #16.

15. Handling Data when Client is Confirmed / Active   (Status 4-6)

    Push all posted fields into the [hyp_Sale Opportunity Web Input] table.
    Set the
    [hyp_Clients.Lead Status]
    field to 3 (Interested Again).
16. A new Sale Opportunity is created at this point. It includes a link to the Client Number (new or existing) and populates empty fields using the Client record (e.g., phone, email, sales agent).
    This step executes regardless of whether the previous step (client create/update) failed due to a database error.

17. Email/Phone Verification

    Based on the
    [Website Account Verification]
    field in the Hyper "...Web API" settings, the portal sends a verification link.
    Approving this verification updates the
    [EMail Verification Status]
    and
    [Phone Verification Status]
    fields within the "hyp_Clients Website Ext. Record" table.

18. Seamless Login when Client Already Exists

    1. Depending on the 'Website Login System' field (server-side settings), for passwordless logins ('ID + Email + OTP'), the user is redirected to the
       'Login_2FA'
       page.
    2. If the password entered in the registration form differs from the one already stored in the account,
       the user is redirected to the
       'PasswordRecovery'
       page and shown this popup message:
       'You have already registered before with different details. Please use the password recovery tool to re-enter your account.'
    3. If the user successfully reaches this point, they are transferred to either the
       'Login_2FA'
       page OR the
       'Portal'
       .