Create Challenge

POST 
/api/challenges

This endpoint creates a challenge for the user to sign to verify ownership of their web3 address. By signing the message actions such as creating a funding source can be performed.

Request

application/json

Body

required

purpose stringrequired

Possible values: [claim-web3-address]

The purpose of the challenge.

network stringrequired

Possible values: [polygon-mainnet, polygon-amoy, arbitrum-sepolia, arbitrum-mainnet]

The blockchain network associated with the web3 address.

address stringrequired

The web3 address to which the challenge is directed.

Responses

200

Successful operation

application/json

Schema

Schema

id string

The unique identifier of the challenge.

purpose string

Possible values: [claim-web3-address]

The purpose of the challenge.

address string

The web3 address to which the challenge is directed.

network string

Possible values: [polygon-mainnet, polygon-amoy, arbitrum-sepolia, arbitrum-mainnet]

The blockchain network associated with the web3 address.

description string

The description of the challenge.

expiresAt string

The time the challenge expires.

createdAt string

The time the challenge was created.

message string

The message to be signed by the web3 address owner.

Example (from schema)

{
  "id": "GlSDzZHcxrSDeJbKu",
  "purpose": "claim-web3-address",
  "address": "0x123...",
  "network": "polygon-mainnet",
  "description": "To verify ownership of the web3 address....",
  "expiresAt": "2024-03-20T08:20:00.000Z",
  "createdAt": "2024-03-20T08:20:00.000Z",
  "message": "To verify ownership of the web3 address ..."
}

403

INVALID_CHAIN Chain not supported.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...