API Reference

Explore the full API documentation for the Mati Verification platform

1. Authentication

Using an API key


                            curl
                            "-H" "Authorization: Bearer YOUR_API_KEY"
                            "-X GET" https://api.mati.com/v1/users

Replace YOUR_API_KEY with your actual API token and ensure requests are made over HTTPS

Unsuccessful Authentication

401 Unauthorized status indicates your API key is invalid or missing.

2. Identity Verification Endpoints

GET /api/v1/identity/verify

Description: Verify identity using document and selfie capture

Query Parameters

                                    {
                                      "documentPhotoUrl": "https://example.com/scan1.jpg",
                                      "facePhotoUrl": "https://example.com/selfie.jpg"
                                    }

Response Example

{
  "id": "5f62d8321c9d58001b95d10a",
  "decision": "approved",
  "score": 93.45,
  "createdAt": "2024-01-15T13:58:54.941Z",
  "result": {
    "similarity": 0.932
  }
}

Returns a verification score based on document authenticity and liveness detection

3. Rate Limiting

Mati uses a request limit system to ensure fair use and system integrity.

Tier	Requests	Duration
Free Tier	200 requests/hr	Basic
Developer	2500 requests/hr	Development
Enterprise	Custom limit	On demand
Exceeding the rate limit will result in a 429 Too many requests response

4. Error Responses

Code	Description
403	Forbidden - Invalid or missing API key
429	Your request count limit is exhausted
500	System Error - Please try again later

Webhooks

Receive live activity updates for user identity events via webhook

                    {
                      "event": "identity_verified",
                      "userId": "user_12345",
                      "status": "verified"
                    }

When your application receives a webhook event like this, you know a document verification was successful. You can fetch the full verification result using the user ID.


                            /api/v1/webhook - POST


                            curl -X POST https://api.mati.com/v1/webhook
                            -H Content-Type: application/json