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

Body application/json

purposestringrequired
Allowed values:claim-web3-address
The purpose of the challenge.
networkstringrequired
Allowed values:algorand-mainnetalgorand-testnetarbitrum-mainnetarbitrum-sepoliabase-mainnetbase-sepoliaethereum-sepoliapolygon-amoypolygon-mainnetsei-mainnetsei-testnetxahau-mainnetxahau-testnetmonad-mainnetmonad-testnet
The blockchain network associated with the web3 address.
addressstringrequired
The web3 address to which the challenge is directed.

Response

Successful operation.

Body application/json

idstring
The unique identifier of the challenge.
purposestring
Allowed values:claim-web3-address
The purpose of the challenge.
addressstring
The web3 address to which the challenge is directed.
networkstring
Allowed values:polygon-mainnetpolygon-amoyarbitrum-mainnetarbitrum-sepoliabase-mainnetbase-sepoliasei-mainnetsei-testnetmonad-mainnetmonad-testnet
The blockchain network associated with the web3 address.
descriptionstring
The description of the challenge.
expiresAtstring
The time the challenge expires.
createdAtstring
The time the challenge was created.
messagestring
The message to be signed by the web3 address owner.

INVALID_CHAIN Chain not supported.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl https://api.immersve.com/api/challenges \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "purpose": "claim-web3-address",
  "network": "algorand-mainnet",
  "address": "0x123..."
}'

curl https://api.immersve.com/api/challenges \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "purpose": "claim-web3-address",
  "network": "algorand-mainnet",
  "address": "0x123..."
}'

curl https://api.immersve.com/api/challenges \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "purpose": "claim-web3-address",
  "network": "algorand-mainnet",
  "address": "0x123..."
}'

curl https://api.immersve.com/api/challenges \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "purpose": "claim-web3-address",
  "network": "algorand-mainnet",
  "address": "0x123..."
}'

curl https://test.immersve.com/api/challenges \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "purpose": "claim-web3-address",
  "network": "algorand-mainnet",
  "address": "0x123..."
}'

curl https://test.immersve.com/api/challenges \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "purpose": "claim-web3-address",
  "network": "algorand-mainnet",
  "address": "0x123..."
}'

curl https://test.immersve.com/api/challenges \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "purpose": "claim-web3-address",
  "network": "algorand-mainnet",
  "address": "0x123..."
}'

curl https://test.immersve.com/api/challenges \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "purpose": "claim-web3-address",
  "network": "algorand-mainnet",
  "address": "0x123..."
}'

Example Response

{
  "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 ..."
}

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