Zapier

Zapier needs no dedicated connector to use Constaia: the Webhooks by Zapier action sends the request to the API and the Catch Hook trigger receives events. If the file isn't at a downloadable URL, Code by Zapier can convert it to base64.

PrerequisitesCopy Anchor Link

• A Zapier account with access to Webhooks by Zapier (and Code by Zapier if you use the code option). Check what your plan includes.
• A test key ck_test_… from the dashboard. See Authentication.
• A previous step that provides the document: a Gmail attachment, a Google Drive file, a form (Typeform, Jotform…). Zapier usually exposes files as a downloadable https:// URL.

Option 1: Webhooks by Zapier with file_urlCopy Anchor Link

{
  "file_url": "https://files.example.com/uploads/dni.jpg",
  "filename": "dni.jpg",
  "options": {
    "expect": ["es_dni", "es_nie", "passport"],
    "checks": { "min_age_years": 18, "holder": { "full_name": "María García López" } },
    "language": "en",
    "metadata": { "source": "zapier" }
  }
}

Option 2: Code by Zapier (base64)Copy Anchor Link

If the previous step doesn't give you a URL Constaia can download (for example, it requires your session), download the file in a Code by Zapier → Run JavaScript step and send it as file_base64.

In Input Data define file_url (the file from the previous step), file_name and api_key, and use:

const file = await fetch(inputData.file_url);
if (!file.ok) throw new Error(`Could not download the file: ${file.status}`);
const base64 = Buffer.from(await file.arrayBuffer()).toString("base64");

const res = await fetch("https://api.constaia.com/v1/analyze", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${inputData.api_key}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    file_base64: base64,
    filename: inputData.file_name,
    options: { expect: "payment_receipt", checks: { expected_amount: 45 } },
  }),
});

const analysis = await res.json();
if (!res.ok) {
  throw new Error(`${analysis.error.code}: ${analysis.error.message} (${analysis.error.request_id})`);
}

return {
  id: analysis.id,
  status: analysis.status,
  verdict: analysis.verdict?.status ?? null,
  reasons: (analysis.verdict?.reasons ?? []).map((r) => r.message).join(" | "),
  amount: analysis.fields.amount?.value ?? null,
};

Return only what later steps use. Code steps have a maximum run time that depends on your Zapier plan; if your documents are long PDFs or the analysis gets close to that limit, use async: true and receive the result by webhook.

Test in test modeCopy Anchor Link

With a ck_test_… key no credits are used and the response depends on the file name (the file must be a real JPEG, PNG, WEBP, HEIC or PDF). In the JSON body set "filename" to one of these names:

For option 2 test with payment_receipt.pdf and expected_amount: 45. All scenarios in Test mode.

Receive events with Catch HookCopy Anchor Link

curl https://api.constaia.com/v1/webhook-endpoints \
  -H "Authorization: Bearer $CONSTAIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://hooks.zapier.com/hooks/catch/…","events":["analysis.completed","analysis.failed"]}'

SecurityCopy Anchor Link

• Never paste a ck_live_… key into shared Zaps or templates. Anyone who can edit the Zap can see headers and Input Data.
• Build and test the Zap with a test key; switch to the live key when you turn it on.
• Zapier keeps each run's data in the Zap history. Keep that in mind with identity documents. More in Storage and privacy.

LimitsCopy Anchor Link

• 20 MB per file; PDFs up to 30 pages synchronously and up to 200 with async: true.
• 2 requests per second per key on the free plan (10 on paid); on a 429 honour Retry-After. For many files at once use batches. See Rate limits.

Next stepsCopy Anchor Link