Getting Started

Welcome to the ezylegal API documentation. This guide will help you integrate ezylegal into your application to collect financial statements from your customers.

What is ezylegal?

ezylegal is an API-first platform that enables you to collect completed financial statements from your customers. Instead of manually chasing documents, you create a session, send your customer a link, and receive the completed form with a PDF when they're done.

Key Concepts

Sessions

A session represents a single financial statement collection request. When you create a session, ezylegal generates a unique link that you send to your customer. They complete the form at their own pace, and you're notified when it's done.

Form Types

Currently, ezylegal supports:

  • Financial Statement (financial_statement) - Comprehensive financial disclosure form

Webhooks

ezylegal notifies your application of events in real-time via webhooks. You'll receive notifications when:

  • A session is accessed for the first time
  • A form section is completed
  • The entire form is submitted
  • A PDF is generated

Integration Flow

Here's how a typical integration works:

  1. Create a Session - Call the API with customer details and form type
  2. Send the Link - Email or display the session link to your customer
  3. Customer Completes Form - They fill out the form at their own pace
  4. Receive Webhook - Get notified when the form is complete
  5. Retrieve Data - Fetch the form data and download the PDF

Authentication

All API requests require authentication using an API key. You can generate API keys from your Partner Dashboard.

curl -X POST https://api.ezy-forms.com.au/v1/sessions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Base URL

All API requests should be made to:

https://api.ezy-forms.com.au/v1

Rate Limits

The API is rate-limited to ensure fair usage:

  • Standard: 100 requests per minute
  • Burst: Up to 200 requests in a 10-second window

If you exceed these limits, you'll receive a 429 Too Many Requests response.

Next Steps