POST Verify collateral removal

Validates if the market maker's collateral removal request is valid.

POSThttps://newapi.native.org/lend/v1/lend/verify-collateral-removal

Header parameters

Body

application/json

recipient*string

The address of the market maker or the settler

Pattern: ^0x[a-fA-F0-9]{40}$

chain*enum

Native blockchain name, eg: ethereum, bsc, etc

Example: "ethereum"

ethereumbscbsc_testnetsepoliapolygonmumbaiarbitrumavalanchemantlezetachain_athens3basemantascrollzetachainlineazklinkmorph_testnetmorph_holesky_testnetmantle_sepolia_testnetpolygon_amoy_testnetavalanche_fuji_testnetberachain_bartio_testnet

tokens*array of TokenAmount (object)

The tokens to be removed as collateral

trader*string

The address of the trader

Pattern: ^0x[a-fA-F0-9]{40}$

Response

201500

Success

Body

application/json

id*string

recipient*string

chain*object

tokens*array of string

totalCollateralRemovedUsd*number

trader*string

nonce*string

requestAt*string (date-time)

enableAt*string (date-time)

expiresAt*string (date-time)

type*string

Request

JavaScriptCurlPython

const response = await fetch('https://newapi.native.org/lend/v1/lend/verify-collateral-removal', {
    method: 'POST',
    headers: {
      "apiKey": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "recipient": "text",
      "chain": "ethereum",
      "tokens": [
        {
          "tokenAddress": "text",
          "amount": "text"
        }
      ],
      "trader": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "recipient": "text",
  "tokens": [
    "text"
  ],
  "totalCollateralRemovedUsd": 0,
  "trader": "text",
  "nonce": "text",
  "requestAt": "2024-11-21T06:58:33.694Z",
  "enableAt": "2024-11-21T06:58:33.694Z",
  "expiresAt": "2024-11-21T06:58:33.694Z",
  "type": "text"
}

Success response

{
    "id": "673a69b0-06db-4309-b0f1-6582435b80ca",
    "nonce": "6885024828728157",
    "recipient": "0x9B85B4A413Efe69684290816a3E814B4aA1EFf63",
    "chain": "base",
    "tokens": [
        {
            "tokenAddress": "0x5d55432c6aAeDB4D34523B2744e959F03aEffFE3",
            "amount": "10000000000000000000"
        }
    ],
    "totalCollateralRemovedUsd": 9.778953854000001e-12,
    "trader": "0x9B85B4A413Efe69684290816a3E814B4aA1EFf63",
    "requestAt": "2024-01-31T09:17:41.847Z",
    "enableAt": "2024-01-31T09:22:41.847Z",
    "expiresAt": "2024-01-31T09:23:41.847Z",
    "type": "collateralRemoval"
}

Error responses

// Invalid token
{
    "statusCode": 400,
    "message": "Collateral does not exist for token 0x12345",
    "error": "Bad Request"
}

// Insufficient collateral
{
    "statusCode": 400,
    "message": "Collateral amount is not enough for token 0x5d55432c6aAeDB4D34523B2744e959F03aEffFE3",
    "error": "Bad Request"
}

// Invalid mm
{
    "statusCode": 404,
    "message": "MM Settings not found",
    "error": "Not Found"
}