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

# Dashboard

> Fundflow API architecture — resource model, data types, response envelope, and the integration patterns that make production calls reliable.

## API Architecture

Fundflow API follows RESTful principles with a clear resource-based structure. All endpoints are accessible via the base URL:

```
https://api-fundflow.venly.io/v1
```

All requests require a Bearer token in the `Authorization` header. See [Authentication](/guides/payments/authentication) for how to obtain one.

For a full endpoint cheat sheet with examples, pagination, filtering, and status codes, see the [Quick Reference](/guides/payments/quick-reference).

***

## Data Types

### Common Fields

**Identifiers:**

* `id`: UUID format (e.g., `123e4567-e89b-12d3-a456-426614174000`)

**Timestamps:**

* `createdAt`, `updatedAt`, `verifiedAt`: ISO 8601 format (e.g., `2024-01-15T10:30:00Z`)

**Amounts:**

* Decimal numbers with up to 8 decimal places
* Minimum: 0.00000001

**Versions:**

* Integer for optimistic locking
* Increments with each update

***

## Best Practices

### Security

✅ **Do:**

* Store credentials securely (environment variables, vaults)
* Use HTTPS for all requests
* Implement token refresh logic
* Validate all input data
* Log API interactions for audit

❌ **Don't:**

* Expose credentials in client-side code
* Store tokens in version control
* Share access tokens between environments
* Ignore error responses

### Performance

✅ **Do:**

* Use pagination for large datasets
* Cache reference data
* Implement connection pooling
* Use webhooks for real-time updates
* Batch operations when possible

❌ **Don't:**

* Poll frequently for status updates
* Fetch all data without pagination
* Make unnecessary API calls
* Ignore rate limits

### Error Handling

✅ **Do:**

* Handle all HTTP status codes
* Implement retry logic with backoff
* Log errors for debugging
* Provide meaningful error messages to users
* Handle version conflicts gracefully

❌ **Don't:**

* Ignore error responses
* Retry indefinitely
* Expose technical errors to end users
* Skip validation

***

## Quick Reference

<CardGroup cols={3}>
  <Card title="Getting Started" icon="rocket" href="/guides/payments/getting-started">
    Integration guide
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/Fundflow-API/company/get-company-details">
    Full API docs
  </Card>

  <Card title="Accounts" icon="building-columns" href="/guides/payments/accounts">
    Bank accounts & wallets
  </Card>

  <Card title="Transactions" icon="arrow-right-arrow-left" href="/guides/payments/transactions">
    Ramp requests
  </Card>

  <Card title="Fees" icon="percent" href="/guides/payments/fees">
    Fee structure
  </Card>

  <Card title="Security" icon="shield" href="/guides/payments/security">
    Security practices
  </Card>
</CardGroup>

***

## Support

Need help with the API?

* **Contact**: [venlyfinance.com/contact](https://venlyfinance.com/contact)
* **API Status**: Monitor system status for any issues