MID API Documentation

About the MID API

The MID (Mobile Identity) API enables developers to integrate secure identity verification, biometric authentication, and digital signing capabilities into their applications. Built on modern REST principles, our API provides simple, consistent interfaces for complex identity operations.

Key Capabilities

API Fundamentals

Base URL

All API requests are made to:

https://api.mobid.io/v1

Authentication

The MID API uses OAuth 2.0 with client credentials for authentication. You’ll need to obtain an access token before making API calls.

curl -X POST https://api.mobid.io/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"client_id":"your-client-id","client_secret":"your-client-secret","grant_type":"client_credentials"}'

Rate Limits

API requests are rate limited to ensure system stability:

• Standard Plan: 100 requests per minute
• Professional Plan: 1,000 requests per minute
• Enterprise Plan: Custom limits available

Response Format

All API responses use JSON format with consistent structure:

{
  "success": true,
  "data": {
    // Response data
  },
  "meta": {
    "request_id": "req_1234567890",
    "timestamp": "2025-10-16T12:00:00Z"
  }
}

Quick Start

Core APIs

SDKs and Libraries

npm install @mid/api-client

pip install mid-api-client

composer require invexia/mid-api

Mobile SDKs

Integration Patterns

Web Applications

For web applications, use our JavaScript SDK with server-side verification:

1. Frontend: Initialize authentication session and display QR code
2. Mobile App: User scans QR code and completes authentication
3. Backend: Receive webhook notification and verify result
4. Frontend: Update UI based on authentication status

Mobile Applications

For mobile applications, use our native SDKs for seamless integration:

1. Initialize: Set up MID SDK in your mobile app
2. Authenticate: Call authentication methods directly
3. Verify: Receive immediate authentication results
4. Continue: Proceed with authenticated user session

Server-to-Server

For server-side integrations without user interaction:

1. Authenticate: Use client credentials flow
2. Verify: Submit identity documents for verification
3. Monitor: Check verification status via polling or webhooks
4. Process: Handle verification results in your business logic

Security & Compliance

Data Privacy

We follow privacy-by-design principles:

• Minimal Data: Only collect data necessary for verification
• Local Storage: Biometric data stored locally on user devices
• Data Retention: Configurable retention policies
• User Control: Users can request data deletion at any time

Support & Resources

Community Resources

• Developer Forum  - Ask questions and share solutions
• GitHub  - View code samples and contribute
• Status Page  - Monitor API uptime and incidents
• Changelog - Stay updated with latest API changes

Rate Limits & Quotas

The MID API implements rate limiting to ensure fair usage and system stability:

Rate Limits

Rate Limit Headers

All API responses include rate limit information:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1634567890

Handling Rate Limits

When you exceed rate limits, the API returns a 429 Too Many Requests response:

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Please try again later.",
    "retry_after": 60
  }
}

Changelog

v1.0.0 - October 16, 2025

New Features:

• Initial release of MID API v1
• Authentication sessions with biometric verification
• Identity verification with document upload
• Digital signing workflows
• Webhook notifications
• OAuth 2.0 authentication

SDKs:

• JavaScript/Node.js SDK v1.0.0
• Python SDK v1.0.0
• iOS SDK v1.0.0
• Android SDK v1.0.0

View Complete Changelog