Validation API

How to Authenticate the APIs

The Validation API provides endpoints for validating a transaction by sending the transaction data and other relevant information. It is secured using a Validation API key found under Settings > API keys in Panorama UI. The usage of the APIs is describe in CUBE3 SDK.

POSThttps://validation-api.cube3.ai/api/v2/transaction/validate

Authorization

ValidationApiKeyAuth

Body

application/json

transaction*Transaction (object)

trackNonce*boolean

Indicates whether to track the nonce of the transaction

clientDataClientData (object)

signTransactionboolean

Indicates whether the transaction should be signed

Response

200

OK

Body

*/*

validboolean

Indicates whether the transaction passed the validation.

payloadstring

This field typically contains a Signature payload to use in transaction.

combinedScoreinteger (int32)

Represents the overall risk score for the transaction, with higher values indicating greater risk.

combinedScoreDetailsExtendedScoreResponse (object)

Provides a breakdown of the risk score and the factors contributing to it by each category: fraud, compliance, and cyber risks.

scoreDetailsobject

Provides a breakdown of the risk score and the factors contributing to it by each category: fraud, compliance, and cyber risks.

controlListsarray of ControlList (object)

Provides a list allow/block lists, involved in transaction.

internalAddressesWithMaxScorearray of InternalAddressWithMaxScoreResponse (object)

Provides a list of addresses, involved in transaction with these address scores.

errorstring

If any error occurs during the validation, it will be detailed here.

cube3TxIdstring

The unique identifier for the transaction within the Cube3 system.

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/transaction/validate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "trackNonce": false,
      "transaction": {
        "chainId": "text",
        "from": "text",
        "to": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "valid": false,
  "payload": "text",
  "combinedScore": 0,
  "combinedScoreDetails": {
    "value": 0,
    "category": "text",
    "subCategory": "text",
    "subCategoryDescription": "text",
    "hops": 0
  },
  "controlLists": [
    {
      "id": "text",
      "address": "text",
      "chainIds": [
        "text"
      ],
      "type": "ALLOW",
      "productType": "SONAR",
      "createdAt": "2024-12-21T17:52:23.313Z",
      "lastUpdatedAt": "2024-12-21T17:52:23.313Z"
    }
  ],
  "internalAddressesWithMaxScore": [
    {
      "address": "text",
      "name": "text",
      "maxScore": 0,
      "category": "text",
      "subCategory": "text",
      "subCategoryDescription": "text",
      "subCategoriesAndTags": [
        {
          "category": "text",
          "subCategory": "text",
          "subCategoryDescription": "text"
        }
      ]
    }
  ],
  "error": "text",
  "cube3TxId": "text"
}

PUThttps://validation-api.cube3.ai/api/v2/transaction/{cube3-transaction-id}

Authorization

ValidationApiKeyAuth

Path parameters

cube3-transaction-id*string

Body

application/json

transactionIdstring

Real transaction id on chain.

blockNumberstring

Transaction on chain block number.

blockTimestring (date-time)

Transaction on chain block time.

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v2/transaction/{cube3-transaction-id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Deprecated:

POSThttps://validation-api.cube3.ai/api/v1/transaction/validate

Authorization

ValidationApiKeyAuth

Body

application/json

transaction*Transaction (object)

trackNonce*boolean

Indicates whether to track the nonce of the transaction

clientDataClientData (object)

signTransactionboolean

Indicates whether the transaction should be signed

Response

200

OK

Body

*/*

validboolean

Indicates whether the transaction passed the validation

payloadstring

This field typically contains a Signature payload to use in transaction

errorstring

If any error occurs during the validation, it will be detailed here.

combinedScoreinteger (int32)

Represents the overall risk score for the transaction, with higher values indicating greater risk

combinedScoreDetailsExtendedScoreSimplified (object)

Provides a breakdown of the risk score and the factors contributing to it. Fraud, compliance, and cyber risks, with higher values indicating greater overall risk

cube3TxIdstring

The unique identifier for the transaction within the Cube3 system

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v1/transaction/validate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "trackNonce": false,
      "transaction": {
        "from": "text",
        "to": "text",
        "chainId": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "valid": false,
  "payload": "text",
  "error": "text",
  "combinedScore": 0,
  "combinedScoreDetails": {
    "value": 0,
    "category": "text",
    "subCategory": "text",
    "subCategoryDescription": "text"
  },
  "cube3TxId": "text"
}

Deprecated:

PUThttps://validation-api.cube3.ai/api/v1/transaction/{cube3-transaction-id}

Authorization

ValidationApiKeyAuth

Path parameters

cube3-transaction-id*string

Body

application/json

transactionId*string

blockNumberstring

blockTimestring (date-time)

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://validation-api.cube3.ai/api/v1/transaction/{cube3-transaction-id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "transactionId": "text"
    }),
});
const data = await response.json();