Get prerequisites

This endpoint returns the requisite blockchain transactions required to permit the action (ex. creation of a new Immersve Card). It also indicates if everything is in order before instructing the client of any blockchain transactions. Insufficient KYC and AML status may trigger an error response.

Path Parameters

• action string required

  Possible values: [create-card, withdraw]

application/json

Request Body required

• chainId string

  Chain ID (see https://chainlist.org/)

• amount string

  The amount to be locked in the smart contract denominated in the major unit.

• token string

  Possible values: [USDC]

  The asset or token the amount is denominated in.

Responses

• 200
• 403

---

User is allowed to perform action. Client should be able to request transactions from the user wallet to Immersve wallet The client needs to parse transaction info and convert it to the chain-specific calls

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• requiredTransactions object[]

  Array [

  type string

  Possible values: [erc20_approval, smart_contract_write]

  params object

  oneOf

  • erc20_approval
  • smart_contract_write

  ---

  spender string

  The address of the spender of the ERC-20 approval

  amount string

  The approval amount

  token string

  contractAddress string

  The address of the smart contract

  abi string

  The ABI of the smart contract

  method string

  Smart contract method

  params object

  Smart contract call params

• ]

{
  "requiredTransactions": [
    {
      "type": "erc20_approval",
      "params": {
        "spender": "string",
        "amount": "string",
        "token": "string"
      }
    }
  ]
}

{
  "requiredTransactions": [
    {
        "type": "erc20_approval",
        "params": {
            "spender": "0xCf0ed659452b092750D9BB54c33c0025b6853aa4",
            "amount": {
                "total": 320.22,
                "token": "USDC"
            }
        }
    },
    {
        "type": "smart_contract_write",
        "params": {
            "contractAddress": "0xCf0ed659452b092750D9BB54c33c0025b6853aa4",
            "method": "depositAndCreateLockedFund"
            "params": {
                "usdcAmount": 320.22
            }
        }
    }
  ]
}

User is not allowed to get the deposit details with the reason stated in the message

KYC_REQUIRED User is required to perform KYC because they are about to spend the amount that exceeds the KYC-free limit. Immersve requires them to provide identification information to comply with regulatory requirements

AML_REQUIRED User is not allowed to create a card due to AML Checks Failing Immersve AML Provider found that the funding wallet might not comply with AML and can’t check the origin of funds for the provided wallet. User will need to go through AML process to validate the source of the funds on the wallet

AML_PERMANENTLY_FAILED Similar to AML_REQUIRED, except the user can not remediate the failing check, because the intended deposit wallet is permanently blacklisted.

application/json

• Schema
• Example (from schema)

---

Schema

• statusCode integer required
• message string required
• error string required

{
  "statusCode": 0,
  "message": "string",
  "error": "string"
}