Skip to main content

Introduction

Easy to use VeriMe API to be able to get answers you need.

Getting Started​

Get started by exploring our API documentation and interactive examples.

What you'll need​

  • A VeriMe API key (sign up at verime.coop)
  • Basic understanding of REST APIs
  • A tool like curl, Postman, or your favorite HTTP client

Quick Start​

Make your first API call to check a verification:

Production Environment​

curl -X POST https://verime.coop/api/v1/verifications/check \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "researcher@university.edu",
    "policy_id": "pol_basic_verification"
  }'

Sandbox Environment​

Test your integration safely in our sandbox environment:

curl -X POST https://sandbox.verime.coop/api/v1/verifications/check \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "researcher@university.edu",
    "policy_id": "pol_basic_verification"
  }'
Testing in Sandbox

Use the sandbox environment at sandbox.verime.coop to test your integration without affecting production data. Get your sandbox API key from your VeriMe dashboard.

What Matters to You is What Matters to Us​

Let us know what you think! Your feedback helps us build better tools for the research community.

Powered by Open Technology​

We use open API specifications and want to make it as easy as possible to put it in your hands.

  • OpenAPI Specification - Our API is fully documented using OpenAPI 3.0
  • Open Standards - Built on REST principles and industry best practices
  • Developer First - Designed to be intuitive and easy to integrate
  • Transparent - Clear documentation, examples, and community support

Next Steps​

📖 Interactive API Reference

Explore the complete OpenAPI Specification with interactive examples and schema documentation.

📚 API Guides

Read detailed guides in the API Documentation section.

🏗️ Understanding Architecture

Learn how VeriMe works in our Architecture Overview.

💡 Example Use Cases

Coming soon: Real-world examples of VeriMe integration patterns.