> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clearline.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction to Integrations

> Register new merchant accounts and manage POS integrations

Integration endpoints allow you to programmatically onboard new merchant accounts and configure POS system integrations with ClearLine. This enables automated account setup and seamless merchant registration workflows.

## What are Integration Endpoints?

Integration endpoints handle merchant account registration and setup. Using these endpoints, you can:

* **Automated Onboarding:** Register new merchant accounts programmatically
* **Configuration Setup:** Set up POS system, location, and terminal information
* **Profile Creation:** Create merchant profiles with business details
* **Subscription Management:** Link merchants to subscription plans

## How It Works

<Steps>
  <Step title="Prepare Registration Data" icon="clipboard">
    Gather merchant information including business profile, POS configuration,
    and subscription details.
  </Step>

  <Step title="Submit Registration" icon="paper-plane">
    Call the [new registration
    endpoint](/api-reference/integrations/start-account-registration) with
    complete merchant data.
  </Step>

  <Step title="Account Created" icon="check">
    ClearLine creates the merchant account and sends setup instructions to the
    provided email.
  </Step>

  <Step title="Complete Setup" icon="user-check">
    Merchant receives email with login credentials and completes account
    activation.
  </Step>
</Steps>

## Integration Endpoint

<Card title="Start Account Registration" icon="user-plus" href="/api-reference/integrations/start-account-registration">
  Register a new merchant account with POS configuration
</Card>

## Required Information

When registering a new merchant account, you need to provide:

### Subscription Details

* Subscription plan code
* Email address for setup instructions

### POS Configuration

* POS company ID
* POS location ID
* Terminal ID
* External user ID (your system's merchant identifier)

### Business Profile

* First name and last name (contact person)
* Email and phone number
* Company name
* Business address (street, city, state, zip)
* Website (optional)

## Best Practices

<AccordionGroup>
  <Accordion title="Validate Data Before Submission" icon="shield-check" defaultOpen>
    Verify all required fields are complete and properly formatted before
    calling the registration endpoint to avoid errors.
  </Accordion>

  <Accordion title="Use Unique External IDs" icon="fingerprint">
    Provide unique external user IDs to easily map ClearLine accounts back to
    your system for ongoing management.
  </Accordion>

  <Accordion title="Handle Email Delivery" icon="envelope">
    Inform merchants to check their email (including spam folder) for setup
    instructions after registration.
  </Accordion>

  <Accordion title="Store Registration Response" icon="database">
    Save the response data linking your merchant ID to the ClearLine account for
    future API operations.
  </Accordion>

  <Accordion title="Implement Error Handling" icon="triangle-exclamation">
    Handle registration errors gracefully - duplicate accounts, invalid
    subscription codes, or missing required fields.
  </Accordion>
</AccordionGroup>

## Use Cases

**POS Resellers:** Automatically onboard new restaurant or retail clients as they sign up for your POS system.

**Partner Integrations:** Register merchants from your platform into ClearLine's marketing system as part of your service offering.

**White-Label Solutions:** Create merchant accounts with your branding and subscription plans.

**Bulk Onboarding:** Programmatically migrate existing merchant base to ClearLine platform.

## Next Steps

<CardGroup cols={2}>
  <Card title="Registration API Reference" icon="code" href="/api-reference/integrations/start-account-registration">
    View complete API specification
  </Card>

  <Card title="New Account Registration Guide" icon="book-open" href="/pos-integration/new-account-registration">
    Step-by-step implementation guide
  </Card>

  <Card title="Authentication Setup" icon="key" href="/api-reference/authentication/introduction">
    Learn how to authenticate for integration operations
  </Card>

  <Card title="POS Settings" icon="gear" href="/api-reference/settings/introduction">
    Configure settings for registered accounts
  </Card>
</CardGroup>
