Skip to main content

Token Gating

The /access-control endpoint allows client applications to interact with Collab.Land's token gating engine to verify a wallet address or crypto account with a list of rules based on the token ownership.

Authentication​

The endpoint requires an API key to be passed in as the x-api-key request header. The client application needs to be approved with token-gating scope by Collab.Land.

x-api-key: <api-key>

Check roles synchronously​

Check roles for an account against a list of token gating rules and get a response from the call for the roles to be assigned or removed.

Sample Request and Response​

Check out the comprehensive API Reference

Request​

POST https://api.collab.land/access-control/check-roles

{
  "account": "0x01c20350ad8f434bedf6ea901203ac4cf7bca295",
  "rules": [
    {
      "type": "ERC721",
      "chainId": 1,
      "minToken": "1",
      "contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
      "roleId": "001"
    }
  ]
}

Response​

{
  "roles": [
    {
      "id": "001",
      "granted": true
    }
  ]
}

Check roles asynchronously with callback​

Check roles for an account against a list of token gating rules with a callback URL and get a notification via the URL as a webhook later for the roles to be assigned or removed.

Sample Request and Response​

Check out the comprehensive API Reference

Request​

POST https://api.collab.land/access-control/check-roles

{
  "account": "0x01c20350ad8f434bedf6ea901203ac4cf7bca295",
  "rules": [
    {
      "type": "ERC721",
      "chainId": 1,
      "minToken": "1",
      "contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
      "roleId": "001"
    }
  ],
  "callbackUrl": "https://my-server.my-domain.com/check-roles/notifications"
}

Response​

{
  "requestId": "<requestId>"
}

Sample notification​

POST https://my-server.my-domain.com/check-roles/notifications X-CollabLand-Signature: signature-for-the-request

{
  "requestId": "<requestId>",
  "roles": [
    {
      "id": "001",
      "granted": true
    }
  ]
}

Check roles asynchronously and poll for the result​

Check roles for an account against a list of token gating rules asynchronously, receive a requestId and use it to poll for the result.

Sample Request and Response​

Check out the comprehensive API Reference

Request​

POST https://api.collab.land/access-control/check-roles

{
  "account": "0x01c20350ad8f434bedf6ea901203ac4cf7bca295",
  "rules": [
    {
      "type": "ERC721",
      "chainId": 1,
      "minToken": "1",
      "contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
      "roleId": "001"
    }
  ],
  "async": true
}

Response​

{
  "requestId": "requestId"
}

Polling​

Sample Request and Response​

Check out the comprehensive API Reference

Request​

GET https://api.collab.land/access-control/check-roles/responses/{requestId}

Response​

{
  "requestId": "<requestId>",
  "roles": [
    {
      "id": "001",
      "granted": true
    }
  ],
  "errors": []
}