1. Partner API v2
  2. Roadmap
Coming in 2.x — not available yet (returns 404)

Coming in 2.x

Specified so you can plan for them; not available yet. Every operation here returns 404 until it ships.
6 planned operations2 resources
WebhooksPush notifications when things change, instead of polling.
Reported emailsThe feed of real emails your clients’ users report.
MCP serverThis same API, exposed to AI assistants.

These are additive: nothing already shipped changes when they ship. Their endpoints are listed in this reference so you can plan for them, and return 404 until they ship.

Phishing

1 plannedLive Phishing endpoints
GET/v2/clients/{client_id}/phishing/reported
Coming in 2.x — not available yet (returns 404)Will requirereadscopeCursor-paginatedReturns Page of ReportedEmail

Emails users flagged with the Report Phishing button that were not simulations, with the triage outcome. This is the feed a SOC or PSA would want for ticketing. Fields marked draft depend on the triage data the client's mailbox integration provides.

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

sincestring (date-time)

Only records at or after this time (RFC 3339).

untilstring (date-time)

Only records before this time (RFC 3339).

classificationstring

Triage outcome for a reported real email. Draft; depends on the mailbox integration.

One ofphishingspamsafepending
limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/phishing/reported" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of ReportedEmail
dataarray of ReportedEmail
Show item properties(9)
idstring
user_idstring
client_idstring
reported_atstring (date-time)
subjectstring
senderstring (email)
classificationstring

Triage outcome for a reported real email. Draft; depends on the mailbox integration.

One ofphishingspamsafepending
classified_atstring (date-time)Nullable
mailbox_actionstringNullable

Draft. What the mailbox integration did with the message.

One ofnonemoved_to_junkdeleted
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean

Webhooks

5 plannedNew in 2.x
GET/v2/webhooks
Coming in 2.x — not available yet (returns 404)Will requirereadscopeCursor-paginatedReturns Page of Webhook

No parameters. Send the request with your API key.

curl "https://app.infimasecapis.com/v2/webhooks" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of Webhook
dataarray of Webhook
Show item properties(8)
idstring
urlstring (uri)
eventsarray of string
Each one ofclient.createduser.createduser.updateduser.deactivatedphishing.result.updatedphishing.email.reportedtraining.assignment.completedtraining.assignment.overduepolicy.acknowledgeddark_web.exposure.foundsync.completedsync.failedreport.ready
client_idsarray of string
descriptionstringNullable
statusstring

disabled after 24 hours of failed deliveries.

One ofactivepauseddisabled
created_atstring (date-time)
last_delivery_atstring (date-time)Nullable
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
POST/v2/webhooks
Coming in 2.x — not available yet (returns 404)Will requirewritescopeReturns Webhook

Subscribes an HTTPS endpoint to events. The subscription inherits the key's client access; narrow it further with client_ids. Each delivery is a POST with a JSON WebhookEvent body and an X-INFIMA-Signature header (t=<unix ts>,v1=<hex HMAC-SHA256> over t + "." + body using the secret returned once at creation). Respond 2xx within 10 seconds; failures retry with backoff for 24 hours.

Proposed events:

eventfires when
client.createda client is provisioned
user.created, user.updated, user.deactivateda user record changes, including via directory sync
phishing.result.updateda simulation advances (opened, clicked, reported, credentials submitted, attachment opened)
phishing.email.reporteda user reports a real email
training.assignment.completeda user passes a course
training.assignment.overduean assignment passes its due date without completion
policy.acknowledgeda user signs a policy
dark_web.exposure.founda new exposure is detected for a user
sync.completed, sync.faileda directory sync run finishes
report.readya generated report is available

Returns 201: Created. `secret` is only returned here.

Request bodyapplication/json

urlstring (uri)Required
eventsarray of stringRequired
Each one ofclient.createduser.createduser.updateduser.deactivatedphishing.result.updatedphishing.email.reportedtraining.assignment.completedtraining.assignment.overduepolicy.acknowledgeddark_web.exposure.foundsync.completedsync.failedreport.ready
client_idsarray of string

Restrict to these clients. Omit for every client the key can access.

descriptionstring
curl -X POST "https://app.infimasecapis.com/v2/webhooks" \
  -H "X-API-Key: $INFIMA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://hooks.example.com/infima",
    "events": [
      "client.created"
    ],
    "client_ids": [
      "3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10"
    ],
    "description": "Open a ticket when a user submits credentials"
  }'
Response objectWebhook
idstring
urlstring (uri)
eventsarray of string
Each one ofclient.createduser.createduser.updateduser.deactivatedphishing.result.updatedphishing.email.reportedtraining.assignment.completedtraining.assignment.overduepolicy.acknowledgeddark_web.exposure.foundsync.completedsync.failedreport.ready
client_idsarray of string
descriptionstringNullable
statusstring

disabled after 24 hours of failed deliveries.

One ofactivepauseddisabled
created_atstring (date-time)
last_delivery_atstring (date-time)Nullable
secretstring
GET/v2/webhooks/{webhook_id}
Coming in 2.x — not available yet (returns 404)Will requirereadscopeReturns Webhook

Path parameters

webhook_idstringRequired

Webhook subscription id.

curl "https://app.infimasecapis.com/v2/webhooks/8b9c0d1e-2f3a-4b4c-9d5e-6f7a8b9c0d1e" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectWebhook
idstring
urlstring (uri)
eventsarray of string
Each one ofclient.createduser.createduser.updateduser.deactivatedphishing.result.updatedphishing.email.reportedtraining.assignment.completedtraining.assignment.overduepolicy.acknowledgeddark_web.exposure.foundsync.completedsync.failedreport.ready
client_idsarray of string
descriptionstringNullable
statusstring

disabled after 24 hours of failed deliveries.

One ofactivepauseddisabled
created_atstring (date-time)
last_delivery_atstring (date-time)Nullable
Errors404Not found within the key's accessError envelope →
DELETE/v2/webhooks/{webhook_id}
Coming in 2.x — not available yet (returns 404)Will requirewritescope

Path parameters

webhook_idstringRequired

Webhook subscription id.

curl -X DELETE "https://app.infimasecapis.com/v2/webhooks/8b9c0d1e-2f3a-4b4c-9d5e-6f7a8b9c0d1e" \
  -H "X-API-Key: $INFIMA_API_KEY"
Errors404Not found within the key's accessError envelope →
POST/v2/webhooks/{webhook_id}/test
Coming in 2.x — not available yet (returns 404)Will requirewritescope

Delivers a ping event to the endpoint and reports the response.

Returns 200: Delivery attempted

Path parameters

webhook_idstringRequired

Webhook subscription id.

curl -X POST "https://app.infimasecapis.com/v2/webhooks/8b9c0d1e-2f3a-4b4c-9d5e-6f7a8b9c0d1e/test" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectObject
deliveredboolean
status_codeinteger
duration_msinteger