<aside> 💡 Permissionless badge: no need to provide these apis Backend-authorized badges: both Check API and Claim API are required. Gifted badges: only Check API is required.

</aside>

Check Eligibility For Minting Badge

  1. method: GET

  2. url: {{pathname}}/check?badge={{badgeContractAddress}}&recipient={{walletAddress}}

  3. contentType: data/json

  4. responseSchema

    // eligible
    {
    	code: 1,
    	message: "success",
    	eligibility: true
    }
    
    // not eligible
    {
    	code: 0,
    	message: "why the recipient is not eligible",
    	eligibility: false
    }
    
    // error
    // http code is not 200
    

Claim Badge

  1. method: GET

  2. url: {{pathname}}/claim?badge={{badgeContractAddress}}&recipient={{walletAddress}}

  3. contentType: data/json

  4. responseSchema

    // success
    {
    	code: 1,
    	message: "success",
    	tx: ...
    }
    
    // failure
    {
    	code: 0,
    	message: "some msg",
    }
    
    // error
    // http code is not 200
    

CORS

Please ensure the provided API supports the cross-origin requirements.

Sepolia

Mainnet