API and webhooks: connect MEXUM to the systems your team already uses
1. Create an API key
In the cabinet open Account → API Keys and create a key. It is shown once; store it like a password. Send it as a bearer token:
Authorization: Bearer mxm_live_xxxxxxxxxxxxxxxx
2. Upload a document and follow the check
curl -X POST https://app.mexum.pro/documents/upload \
-H "Authorization: Bearer $MEXUM_KEY" \
-F "file=@contract.pdf" \
-F "client_task=Check retainage and payment terms"
# the response contains "task_id"
curl https://app.mexum.pro/documents/{task_id}/status \
-H "Authorization: Bearer $MEXUM_KEY"
The issued conclusion is available as a PDF from GET /documents/{task_id}/report once it has been issued. Your first check is free for 5 days after you sign up, so you can try the whole flow without a card.
3. Receive webhooks
In Account → Webhook set an HTTPS address. MEXUM sends a POST with a JSON body for these events:
check.completed: the automated check finished;check.failed: the check could not be completed;report.issued: the final conclusion was issued;ping: the test button.
{"event":"check.completed","created_at":"2026-11-20T10:15:00+00:00",
"data":{"task_id":123,"code":"AB123","status":"done","report_ready":false,
"url":"https://app.mexum.pro/cabinet/task/123"}}
The event carries only the check number, status and a link. It never contains document text, quotes or personal data. Addresses that point to private or internal networks are rejected, and redirects are not followed. A failed delivery is retried once.
4. Verify the signature
Each request has X-Mexum-Timestamp and X-Mexum-Signature. The signature is sha256= plus the HMAC-SHA256 of timestamp + "." + raw body with your signing secret (shown once when you save the webhook).
import hmac, hashlib
def valid(secret, timestamp, body, header):
mac = hmac.new(secret.encode(), timestamp.encode() + b"." + body, hashlib.sha256).hexdigest()
return hmac.compare_digest("sha256=" + mac, header)
Reject requests whose timestamp is more than a few minutes old.
Zapier, Make and project platforms
Paste the catch-hook address from Zapier or Make into the webhook field and route the event wherever you need: a message to the project channel, a row in a tracker, a task in your project platform. If you use Procore or Autodesk Construction Cloud, a webhook plus their own APIs covers most flows today. Native connectors are not available yet; tell us which workflow you need and we will prioritize it.
Related
Estimate review, plan review pre-check, loan budget review and how to read an automated check report.
Frequently asked questions
Is there a public API?
Yes. Any account can create API keys and use the same endpoints as the cabinet, including upload, status and report download.
Do webhooks contain my documents?
No. They carry the check number, status and a link to the check in the cabinet.
Is there a native Procore or Autodesk integration?
Not yet. Use webhooks and the API with the platform APIs today, and tell us which workflow you need.
How do I try it?
Sign up, use your first check free for 5 days, create an API key in the account and send a document.
