API Reference

Welcome to the Streampli API documentation. Our protocol enables financial institutions to securely exchange KYC verification proofs without exposing underlying PII data.

Authentication

The Streampli API uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard.

                # Authorization Header
                Authorization: Bearer sk_live_51Mx...
            

Identities

POST Verify Identity

Submit a new identity verification proof to the network. This does not upload PII; it uploads a cryptographic hash and the verification metadata.

                POST /v1/identities/verify
                {
                 "national_id_hash": "sha256:e3b0c442...",
                 "verification_type": "biometric_kyc",
                 "provider": "metamap",
                 "verified_at": "2025-11-27T14:30:00Z"
                }
            

Response

                {
                 "id": "idt_123456789",
                 "status": "active",
                 "network_sync": "completed",
                 "token_reward": 0.60
                }
            

GET Retrieve Status

Check if an identity exists in the network and retrieve its current verification status.

GET /v1/identities/{hash}/status