Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.younegotiate.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Real-World Example

ABC Collections signs up for YouNegotiate for the first time. The owner enters their name, email, password, accepts the terms, and completes the required verification checks on the registration form. The system creates the company in a created state, creates the first creditor user, sends the verification email, and logs the user in. The user is not ready for normal portal work yet. They still need to verify the email address, complete the company profile, verify the business name and TIN through Middesk, choose a membership plan, submit billing details, and activate the membership payment. After that, required setup items such as merchant processing, pay terms, import headers, terms, and About Us content control whether login opens the Set Up Wizard or the Performance Dashboard.

​
Registration And Activation Flow

  1. Public registration: The creditor submits name, email, password, recaptcha, and terms acceptance. Partner registration codes and creditor profile codes can prefill or link the account when present. Gate: a company and first creditor user are created.
  2. Email verification: The app sends the verification email after registration. Gate: main creditor routes require a verified email.
  3. Company profile: The creditor confirms company identity, business hours, business category, address, website, and contact details. Gate: required profile fields must be complete.
  4. Business verification: The creditor enters the legal business name and Tax ID/TIN/EIN. The app sends name and TIN to Middesk and stores the profile as verified only when Middesk returns tin.verified. Gate: the account profile cannot continue without verified TIN status.
  5. Membership plan: The creditor chooses an active membership plan. Gate: the company receives an inactive membership record for the selected plan.
  6. Billing and payment: Billing details are tokenized with Basis Theory, payment is created through Tilled, and a membership transaction is stored. Gate: successful payment activates the membership and marks the company profile step complete.
  7. Setup wizard: Required operational setup is checked after login. Gate: if required setup remains, show the Set Up Wizard; otherwise show the Performance Dashboard.

​
Required Setup After Registration

Required before the user should be sent to the dashboard:
  • Merchant payment processor: The company must be active or have a verified merchant processor. Tilled onboarding may require extra documents when verification needs more information.
  • Pay Term Offers: Required pay-term percentages and first-payment timing must be configured before account workflows are ready.
  • Terms & Conditions: A default Terms & Conditions profile must exist for the creditor company.
  • Import Header Profiles: A CSV/import header profile must exist so uploaded account files can be mapped safely.
  • About Us Profile: A default About Us profile must exist for consumer-facing creditor information.
Optional items still shown in the wizard:
  • Sub Accounts: Optional setup for account separation inside the creditor company.
  • SFTP: Optional setup for automated file transfer.
  • Logo Profile & Embed Code: Optional branding and embed setup.

​
Visual Flow

​
How It Should Work

  • A new creditor should register from the public page with valid name, email, password, recaptcha, and terms acceptance.
  • Registration should support an optional partner registration code and optional creditor profile code without allowing one creditor to attach to another creditor’s data.
  • Registration should create the company first, then create the first creditor user for that company, fire the registered event, send the verification email, and log the user in.
  • Email verification should remain a hard gate before normal authenticated creditor routes.
  • Company profile completion should collect the business identity, contact information, address, business hours, category, website, and required attestation.
  • Business identity should be verified by sending legal name and TIN to Middesk and requiring a verified TIN result before the account profile continues.
  • Membership setup should create an inactive company membership when the creditor chooses a plan.
  • Billing setup should tokenize card or bank details with Basis Theory, process the membership payment through Tilled, and store a successful membership transaction before activating the membership.
  • A returning creditor should be redirected to the Set Up Wizard when required setup steps remain.
  • A returning creditor should be redirected to the Performance Dashboard only after required setup is complete.

​
How It Should Not Work

  • It should not create a creditor user without the required registration details.
  • It should not allow an already logged-in user to use the public login/register pages as a new session.
  • It should not treat an unverified email address as ready for normal creditor portal access.
  • It should not mark the business profile complete when Middesk has not verified the submitted TIN.
  • It should not activate membership without a successful payment result or valid payment token.
  • It should not send a creditor into dashboard activity when required setup is still incomplete.
  • It should not allow imports, offers, notices, or consumer-facing workflows before pay terms, import headers, terms, and About Us defaults are ready.
  • It should not let a user access another creditor’s company after login.

​
Developer Notes

  • RegisterPage creates the company with CompanyStatus::CREATED, creates the first user, logs the user in, sends email verification, and redirects through the normal intended route.
  • LoginPage and RedirectIfAuthenticatedController use SetupWizardService::getRemainingStepsCount() to decide whether the user lands on the Set Up Wizard or the Performance Dashboard.
  • CheckProfileCompleted redirects incomplete company profiles to the account profile flow before protected portal areas are available.
  • ActivePlan redirects companies without an active membership to membership settings.
  • CompanyProfile verifies name and TIN through Middesk and only sets is_verified_tin when Middesk returns a verified TIN result.
  • MembershipPlan creates the inactive membership record; BillingDetails activates it only after Basis Theory token conversion and a successful Tilled payment response.
  • SetupWizardService should stay aligned with the required setup section above. If required setup changes in the app, update this page and the setup wizard page together.
  • routes/creditor/auth.php
  • routes/creditor/index.php
  • app/Livewire/Creditor/Auth/RegisterPage.php
  • app/Livewire/Creditor/Auth/LoginPage.php
  • app/Livewire/Creditor/Forms/Auth/RegisterForm.php
  • app/Http/Controllers/RedirectIfAuthenticatedController.php
  • app/Http/Middleware/CheckProfileCompleted.php
  • app/Http/Middleware/ActivePlan.php
  • app/Livewire/Creditor/AccountProfile/CompanyProfile.php
  • app/Livewire/Creditor/AccountProfile/MembershipPlan.php
  • app/Livewire/Creditor/AccountProfile/BillingDetails.php
  • app/Services/SetupWizardService.php
  • app/Livewire/Creditor/SetupWizardPage.php
Last modified on May 25, 2026