DOCUMENTATION / IDEMPOTENCY

Idempotency

OpenAPI 3.1 ↗

Use idempotency keys for CompanyProof verification requests. Retry requests without creating unintended duplicate proofs or credit usage.

BASE URLhttps://companyproof.ai/v2JSON · Bearer authentication

SAFE RETRIES

One logical verification, one proof.

Send an Idempotency-Key on every write. Keys must contain 8–128 characters from A–Z a–z 0–9 . _ : - and are scoped to your account and API-key environment.

  1. 01
    First request

    The proof is created, claim credits are consumed and the response is 201.

  2. 02
    Same key, same request

    The stored proof is returned with 200 and Idempotent-Replayed: true. No additional credits are consumed.

  3. 03
    Same key, changed request

    The request is rejected with 409 idempotency_conflict.