IdentityCheckyr

API Documentation

Complete reference for IdentityCheckyr REST API

REST API
OAuth 2.0
OpenAPI 3.0

Getting Started

Base URL

https://api.identitycheckyr.com/v1

Authentication

All API requests require authentication via API key in the Authorization header:

Authorization Header

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.identitycheckyr.com/v1/users
curl

Response Format

All responses are JSON formatted with consistent error handling:

Success Response

{
  "success": true,
  "data": {
    "id": "user_123",
    "email": "user@example.com",
    "name": "John Doe"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z"
  }
}
json

Error Response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email address is required",
    "details": {
      "field": "email",
      "constraint": "required"
    }
  }
}
json

Need Help?

Quick Start Guide

Step-by-step tutorial to get started

Get Started

Community Forum

Ask questions and share knowledge

Support

Get help from our support team