API Reference

Complete reference for Fairway's compliance and identity APIs

Authentication

All API requests require authentication using your API key:

Authorization: Bearer YOUR_API_KEY

Eligibility Verification

GET /v1/eligibility/[address]

Check if an address meets compliance requirements

Parameters

  • address - ADA or EVM address to verify

Response

{
  "eligible": true,
  "reason": "KYC1_OK",
  "epoch": 391,
  "compliance_level": "institutional",
  "expires_at": "2024-12-31T23:59:59Z"
}

Identity Tokens

POST /v1/identity/mint

Mint a new identity token after KYC verification

Request Body

{
  "user_address": "addr1...",
  "kyc_provider": "jumio",
  "compliance_level": "retail",
  "jurisdiction": "US"
}

Policy Engine

POST /v1/policy/evaluate

Evaluate compliance policies against user credentials

Request Body

{
  "policy_id": "institutional_kyc_v1",
  "user_credentials": {
    "identity_token": "...",
    "jurisdiction": "US",
    "accredited_investor": true
  }
}

Error Codes

CodeDescription
KYC1_MISSINGNo KYC verification found
KYC1_EXPIREDKYC verification has expired
SANCTIONS_HITAddress flagged in sanctions screening
JURISDICTION_BLOCKEDUser jurisdiction not permitted