DEIS API documentation: integrating compliance into your existing systems

The DEIS API allows software developers to integrate privacy-compliant lookups directly into existing business applications — CRMs, loan origination systems, fleet management platforms, and more.

Authentication

API access uses bearer token authentication. Generate an API key in Settings → API Keys. Each key is scoped to your business account and inherits the permissions of the user who created it.

Endpoints

POST /api/v1/lookup — Run a lookup. Required fields: data source, query, IPP3A pathway, and justification.

GET /api/v1/lookup/:id — Retrieve a lookup result by ID.

GET /api/v1/evidence — Query the evidence log. Supports filtering by date range, data source, individual, and pathway.

POST /api/v1/contacts — Create or update a contact.

GET /api/v1/contacts — List contacts.

Rate limits

API requests are rate-limited to 60 requests per minute per API key. Bulk lookup endpoints have separate, higher limits.

Webhooks

DEIS can send webhook notifications when lookups complete, notifications are delivered, or correction requests are received. Configure webhooks in Settings → API Keys → Webhooks.

SDKs

We provide a TypeScript SDK that wraps the REST API. Install it with npm install @deis/sdk. The SDK handles authentication, request signing, and response parsing.