Whitelist Proxy Contracts

Authorize your DApp User's Proxy Contracts

If you have implemented native meta transactions via external contract wallet approach like gnosis or argent, you need to whitelist all proxy contracts registered in your DApp before using meta transaction APIs.

This guide will help you whitelist, list and update the status of the whitelisted proxy contracts.

Before using this API, make sure you have generated an access token from the dashboard which is visible in you View DApp section on dashboard.

post
/api/v1/dapp/whitelist/proxy-contracts

https://api.biconomy.io/api/v1/dapp/whitelist/proxy-contracts
Whitelist proxy addresses. Only whitelisted proxy addresses will be authorized to do meta transactions.
Request
Response
Request
Headers
Authorization
required
string
Token present on the dashboard for your DApp after you have generated token. This is specific to DApp registered and should be in the format "User <token generated>"
Body Parameters
addresses
required
array
An array of proxy contract addresses for whitelisting for your dapp.
Response
200: OK
Proxy contracts whitelisted successfully.
{
"code": 200,
"message": "Proxy contracts whitelisted successfully"
}
400: Bad Request
No proxy address found in the request
{
"code": 400,
"message": "No proxy address found in the request"
}
401: Unauthorized
Invalid/missing dapp token in request
{
"code": 401,
"message": "Token is required in the request header"
}

get
/api/v1/dapp/whitelist/proxy-contracts

https://api.biconomy.io/api/v1/dapp/whitelist/proxy-contracts
Get a list of whitelisted proxy contracts.
Request
Response
Request
Headers
Authorization
required
string
Token present on the dashboard for your Dapp after you have generated token. It should be in the format "User <token generated>"
Response
200: OK
Proxy addresses fetched successfully.
{
"code": 200,
"message": "Proxy addresses fetched successfully",
"total": 5,
"addresses": [ {
address : "",
status : true
} ]
}
401: Unauthorized
Invalid/ missing dapp token in the request
{
"code": 401,
"message": "Token is required in the request header"
}

patch
/api/v1/dapp/whitelist/proxy-contracts

https://api.biconomy.io/api/v1/dapp/whitelist/proxy-contracts
Make your proxy contracts status active or inactive via this api. Only active proxy contracts will be allowed to relay meta transactions.
Request
Response
Request
Headers
Authorization
required
string
Token present on the dashboard for your Dapp after you have generated token. This is specific to DApp registered and should be in the format "User <token generated>"
Body Parameters
status
required
boolean
Either 0 or 1. 0 => Inactive 1 => active
address
required
string
Address for changing the status.
Response
200: OK
Address status updated successfully
{
"code": 200,
"message": "Address status updated successfully"
}
400: Bad Request
Either invalid address format or invalid status parameter
{
"code": 400,
"message": "Contract address format is invalid"
}
or
{
"code": 400,
"message": "Address status should be a number of either 0 or 1"
}
401: Unauthorized
Invalid / missing dapp token in the request.
{
"code": 401,
"message": "Token is required in the request header"
}
404: Not Found
Contract address does exist.
{
"code": 404,
"message": "Contract address does not exist"
}