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

# Reference

> Understanding account management in WEpayments

# Account Reference

The WEpayments account system allows you to onboard new businesses and manage their verification process through our API.

## What is an Account?

An account represents a business entity that wants to use WEpayments services. Each account goes through a verification process before being approved for transactions.

## Account Lifecycle

<Steps>
  <Step title="Account Opening">
    Submit business information and documentation through the API
  </Step>

  <Step title="Verification">
    Our compliance team reviews the submitted information
  </Step>

  <Step title="Approval/Rejection">
    Account is either approved or rejected with feedback
  </Step>

  <Step title="Active">
    Approved accounts can start processing transactions
  </Step>
</Steps>

## Key Features

<CardGroup cols={2}>
  <Card title="Automated Onboarding" icon="robot">
    Programmatically create and manage accounts via API
  </Card>

  <Card title="Real-time Notifications" icon="bell">
    Receive webhook notifications for status changes
  </Card>

  <Card title="Document Management" icon="file">
    Submit and track required documentation
  </Card>

  <Card title="Compliance Ready" icon="shield-check">
    Built-in KYC/KYB verification process
  </Card>
</CardGroup>

## Account Status

### Status Flow

```mermaid theme={null}
graph LR
    A[pending] --> B[due_diligence_review]
    B --> C[active]
    B --> D[canceled]
    C --> E[inactive]
    C --> F[closed]
    
    style A fill:#fef3c7,stroke:#f59e0b,stroke-width:2px,color:#000
    style B fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#000
    style C fill:#d1fae5,stroke:#10b981,stroke-width:2px,color:#000
    style D fill:#fee2e2,stroke:#ef4444,stroke-width:2px,color:#000
    style E fill:#f3f4f6,stroke:#6b7280,stroke-width:2px,color:#000
    style F fill:#f3f4f6,stroke:#6b7280,stroke-width:2px,color:#000
```

### Status Types

<AccordionGroup>
  <Accordion title="pending">
    **Description**: First status of the process. Indicates that the account opening request has been received and is awaiting review.

    **Next Steps**: Wait for compliance team to start the review process

    **Typical Duration**: 1-2 business days
  </Accordion>

  <Accordion title="due_diligence_review">
    **Description**: Compliance is analyzing the Due Diligence (DD) and company data provided during onboarding.

    **Next Steps**: May request additional documentation if needed

    **Typical Duration**: 2-5 business days
  </Accordion>

  <Accordion title="active">
    **Description**: Account is active/approved. At this status, the webhook will send the `account_id` (MID - Merchant ID) that identifies the merchant's account.

    **Next Steps**: Start processing transactions

    **Actions Available**: All API endpoints accessible
  </Accordion>

  <Accordion title="canceled">
    **Description**: Account was canceled during the onboarding process.

    **Next Steps**: Review cancellation reason and resubmit if possible

    **Common Reasons**: Invalid documentation, incomplete information, compliance concerns
  </Accordion>

  <Accordion title="inactive">
    **Description**: Account is inactive after being previously activated.

    **Next Steps**: Contact support to understand the reason and reactivation process
  </Accordion>

  <Accordion title="closed">
    **Description**: Account has been closed.

    **Next Steps**: Account cannot be reactivated. A new account opening request is required if needed.
  </Accordion>
</AccordionGroup>

## Required Information

To open an account, you need to provide:

### Business Information

* Legal business name
* Business document (CNPJ for Brazil)
* Business email and phone
* Complete business address

### Representative Information

* Full name of legal representative
* Personal document (CPF for Brazil)
* Email and phone
* Birth date

### Additional Documents

Depending on your business type, you may need to provide:

* Articles of incorporation
* Proof of address
* Bank account information
* Business licenses

## API Endpoints

The Account API provides the following endpoints:

| Endpoint                                  | Method | Description                        |
| ----------------------------------------- | ------ | ---------------------------------- |
| `/v2/register/companies`                  | POST   | Create new account opening request |
| `/v2/register/companies/webhooks`         | POST   | Register webhook for notifications |
| `/v2/register/companies/webhooks`         | GET    | List registered webhooks           |
| `/v2/register/companies/webhooks/{event}` | PUT    | Update webhook configuration       |
| `/v2/register/companies/webhooks/{event}` | DELETE | Remove webhook                     |

## Next Steps

<CardGroup cols={2}>
  <Card title="Opening Process" icon="door-open" href="/account/opening-process">
    Learn how to create an account
  </Card>

  <Card title="Webhook Integration" icon="webhook" href="/api-reference/account/webhook/webhook-onboarding">
    Set up real-time notifications
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/account/create">
    View complete API documentation
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Learn about API authentication
  </Card>
</CardGroup>

## Need Help?

**24/7 Support Team**: Our Support, Performance & CX team is available for operational and technical assistance.

* 📚 **Help Center**: Access articles on panel usage, transactions, payments, withdrawals, reports, and more. [Visit Help Center](https://support.wepayments.com.br/)
* 💬 **Chat**: Click the chat icon in the bottom-right corner of any Help Center page
* 📱 **WhatsApp**: [+55 41 9266-7191](https://wa.me/5541926677191)
* 📧 **E-mail**: [cs@wepayments.com.br](mailto:cs@wepayments.com.br)