API Documentation
Integrate KYC verification into your Aleo application with our simple API endpoints.
Endpoints
GET
/api/verify
Verify Wallet KYC Status
Query Parameters
Parameter | Type | Description |
---|---|---|
wallet | string | Aleo 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
Field | Type | Description |
---|---|---|
verified | boolean | Whether the wallet has valid KYC verification |
expirationBlock | number | Block number when the KYC verification expires |
ownerId | string | Unique identifier of the KYC verification |
Error Handling
The API uses conventional HTTP response codes to indicate the success or failure of requests.
Code | Description |
---|---|
200 | Success |
400 | Bad Request - Invalid wallet address |
404 | Not Found - Wallet not found |
500 | Internal Server Error |