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

# Codaclean API

> Connect your software to Codaclean: manage customers, request CODA and CODB mandates, and retrieve bank and payroll files.

<div className="cc-landing">
  <section className="cc-hero">
    <h1 className="cc-hero-title">Build on <span>codaclean</span></h1>

    <p className="cc-hero-lede">
      Connect your accounting or practice management software to Codaclean. Manage customers, request CODA and CODB mandates, and retrieve the bank and payroll files Codaclean receives for them.
    </p>

    <div className="cc-hero-actions">
      <a className="cc-btn cc-btn-primary" href="https://codaclean.be/fr-be/contact" target="_blank" rel="noopener noreferrer">Request API access <Icon icon="arrow-right" size={14} color="currentColor" /></a>
      <a className="cc-btn cc-btn-secondary" href="/api/quickstart">Quickstart</a>
    </div>

    <div className="cc-chips">
      <a className="cc-chip" href="/api/guides/sync-coda-files">Download new bank statements</a>
      <a className="cc-chip" href="/api/guides/sync-codb-files">Download new payroll files</a>
      <a className="cc-chip" href="/api/guides/onboard-customer">Onboard a customer and request mandates</a>
      <a className="cc-chip" href="/api/guides/upload-files">Upload files to Codaclean</a>
    </div>
  </section>

  <section className="cc-section">
    <div className="cc-section-head">
      <div>
        <h2 className="cc-h2">Explore the API</h2>
        <p className="cc-lede">Every endpoint comes with an interactive playground.</p>
      </div>
    </div>

    <div className="cc-grid">
      <a className="cc-card" href="/api/authentication">
        <span className="cc-card-icon">
          <Icon icon="key" size={18} />
        </span>

        <span className="cc-card-title">Authentication</span>
        <span className="cc-card-desc">An API key for your software, and an ID token for the user acting through it.</span>
        <span className="cc-card-cta">Get a token →</span>
      </a>

      <a className="cc-card" href="/api/endpoints/search-customers">
        <span className="cc-card-icon">
          <Icon icon="building" size={18} />
        </span>

        <span className="cc-card-title">Customers</span>
        <span className="cc-card-desc">Search, create, update and archive customers, with their bank accounts and payroll providers.</span>
        <span className="cc-card-cta">Customers endpoints →</span>
      </a>

      <a className="cc-card" href="/api/endpoints/search-mandates">
        <span className="cc-card-icon">
          <Icon icon="file-signature" size={18} />
        </span>

        <span className="cc-card-title">Mandates</span>
        <span className="cc-card-desc">Request CODA mandates per bank account and CODB mandates per payroll provider, then follow their status.</span>
        <span className="cc-card-cta">Mandates endpoints →</span>
      </a>

      <a className="cc-card" href="/api/endpoints/list-coda-files">
        <span className="cc-card-icon">
          <Icon icon="building-columns" size={18} />
        </span>

        <span className="cc-card-title">CODA files</span>
        <span className="cc-card-desc">List new bank statement files, download them, and acknowledge each download.</span>
        <span className="cc-card-cta">CODA endpoints →</span>
      </a>

      <a className="cc-card" href="/api/endpoints/list-codb-files">
        <span className="cc-card-icon">
          <Icon icon="users" size={18} />
        </span>

        <span className="cc-card-title">CODB files</span>
        <span className="cc-card-desc">List new payroll files delivered by payroll providers, download them, and acknowledge each download.</span>
        <span className="cc-card-cta">CODB endpoints →</span>
      </a>

      <a className="cc-card" href="/api/endpoints/list-banks">
        <span className="cc-card-icon">
          <Icon icon="list" size={18} />
        </span>

        <span className="cc-card-title">Reference data</span>
        <span className="cc-card-desc">The banks and payroll providers Codaclean can request a mandate from.</span>
        <span className="cc-card-cta">Reference endpoints →</span>
      </a>
    </div>
  </section>

  <section className="cc-section">
    <div className="cc-section-head">
      <div>
        <h2 className="cc-h2">Get started in three steps</h2>
      </div>
    </div>

    <div className="cc-steps">
      <div className="cc-step">
        <div className="cc-step-title">Get an API key</div>
        <div className="cc-step-text">Codaclean issues an API key for your software. Request one with the form.</div>
      </div>

      <div className="cc-step">
        <div className="cc-step-title">Get an ID token</div>
        <div className="cc-step-text">Exchange the user's credentials for an ID token with <code>POST /token</code>.</div>
      </div>

      <div className="cc-step">
        <div className="cc-step-title">Make your first call</div>
        <div className="cc-step-text">Call <code>GET /hello</code> to check that both credentials are accepted.</div>
      </div>
    </div>
  </section>

  <section className="cc-section">
    <div className="cc-section-head">
      <div>
        <h2 className="cc-h2">Resources</h2>
      </div>
    </div>

    <div className="cc-grid">
      <a className="cc-card" href="/api/errors">
        <span className="cc-card-icon">
          <Icon icon="triangle-exclamation" size={18} />
        </span>

        <span className="cc-card-title">Errors</span>
        <span className="cc-card-desc">Error format and the list of error codes.</span>
      </a>

      <a className="cc-card" href="/api/rate-limits">
        <span className="cc-card-icon">
          <Icon icon="gauge" size={18} />
        </span>

        <span className="cc-card-title">Rate limits</span>
        <span className="cc-card-desc">Default limits per API key, and how to get more.</span>
      </a>

      <a className="cc-card" href="/api/scopes">
        <span className="cc-card-icon">
          <Icon icon="shield-check" size={18} />
        </span>

        <span className="cc-card-title">Scopes</span>
        <span className="cc-card-desc">What your API key is allowed to do.</span>
      </a>
    </div>
  </section>

  <section className="cc-access">
    <div>
      <div className="cc-access-title">Ready to integrate?</div>
      <div className="cc-access-text">Tell us about your integration and the Codaclean team will get back to you.</div>
    </div>

    <a className="cc-btn cc-btn-primary" href="https://codaclean.be/fr-be/contact" target="_blank" rel="noopener noreferrer">Request API access</a>
  </section>
</div>
