API Documentation

Integrate KYC verification into your Aleo application with our simple API endpoints.

Endpoints

GET/api/verify

Verify Wallet KYC Status

Query Parameters

ParameterTypeDescription
walletstringAleo wallet address to verify

Example Request

curl -X GET "https://kyc-nft.vercel.app/api/verify?wallet=aleo1..."

Example Response

{
  "verified": true,
  "expirationBlock": 123456,
  "ownerId": "abc123..."
}

Response Schema

FieldTypeDescription
verifiedbooleanWhether the wallet has valid KYC verification
expirationBlocknumberBlock number when the KYC verification expires
ownerIdstringUnique identifier of the KYC verification

Error Handling

The API uses conventional HTTP response codes to indicate the success or failure of requests.

CodeDescription
200Success
400Bad Request - Invalid wallet address
404Not Found - Wallet not found
500Internal Server Error