Core Feature

Consent Management

Create and manage user consent flows for identity verification, data sharing, and regulatory compliance.

Create Consent

POST

/v1/service/consents/search

Initiate a new consent session with recipient lookup

Request Body

Parameter	Type	Required	Description
recipient	string	Yes	Recipient's phone number or identifier
purpose	string	Yes	Consent purpose: identity_verification, data_sharing, payment
scope	array	No	Data fields requested: name, email, phone, address
callbackUrl	string	No	Webhook URL for consent status updates
expiresIn	number	No	Expiration in minutes (default: 1440)

Create consent session

curl -X POST 'https://api.mobid.io/v1/service/consents/search' \
  -H 'Content-Type: application/json' \
  -H 'X-Mobid-Key: qk_your_api_key' \
  -d '{
    "recipient": "+1234567890",
    "purpose": "identity_verification",
    "scope": ["name", "email", "phone"]
  }'

Response

{
  "code": 200,
  "message": "Consent session created",
  "data": {
    "id": "cs_abc123",
    "status": "pending",
    "recipient": "+1234567890",
    "purpose": "identity_verification",
    "scope": ["name", "email", "phone"],
    "qrCode": "https://api.mobid.io/qr/cs_abc123",
    "expiresAt": "2025-01-16T12:00:00Z"
  }
}

Screener Data

Access screening results for consented users including compliance and risk data.

GET

/v1/service/consents/:id/screener

Get screener data for a consent

Response

{
  "code": 200,
  "data": {
    "consentId": "cs_abc123",
    "screening": {
      "riskLevel": "low",
      "pep": false,
      "sanctions": false,
      "adverseMedia": false,
      "verifiedAt": "2025-01-15T12:00:00Z"
    }
  }
}

Earnings Summary

GET

/v1/service/consents/earnings/summary

Get consent usage and earnings summary

Response

{
  "code": 200,
  "data": {
    "totalConsents": 1250,
    "approved": 1180,
    "rejected": 45,
    "pending": 25,
    "period": "2025-01"
  }
}

ℹ

Consent Lifecycle

Consents follow the lifecycle: pending → approved/rejected/expired. Once approved, consent data is available for the duration specified in the scope. Users can revoke consent at any time through the MID app.