MID API Documentation

Base URL & Authentication

All API requests should be made to the following base URL:

https://api.mobid.io/v1

Authenticate using your API key in the X-Mobid-Key header:

curl -X GET 'https://api.mobid.io/v1/health' \
  -H 'X-Mobid-Key: qk_your_api_key_here'

Quick Start Guide

Get up and running in minutes:

curl -X GET 'https://api.mobid.io/v1/health' \
  -H 'X-Mobid-Key: qk_your_api_key'

API Reference

Explore the complete API across these categories:

SDK Examples

const response = await fetch('https://api.mobid.io/v1/service/consents/search', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-Mobid-Key': process.env.MID_API_KEY
  },
  body: JSON.stringify({
    recipient: '+1234567890',
    purpose: 'identity_verification',
    scope: ['name', 'email', 'phone']
  })
});

const session = await response.json();
console.log('Consent session:', session.data);

Webhook Events

Configure webhook endpoints in your dashboard to receive real-time notifications:

Rate Limits

Error Handling

MID uses conventional HTTP response codes. Codes in the 2xx range indicate success. 4xx indicate client errors. 5xx indicate server errors (rare).

{
  "code": "invalid_parameter",
  "message": "The 'recipient' field is required",
  "data": null
}