User

get

Checks compliance for a user and retrieves predicate message if compliant

Path parameters

addressstringRequired

User address

Example: 0x1234567890123456789012345678901234567890

Query parameters

chainIdnumberOptional

Optional. Chain ID

Default: 1Example: 1

isDepositAndBridgestringOptional

Optional. Indicates if the compliance check is for deposit and bridge interaction. Defaults to false.

Default: falseExample: false

isZapperstringOptional

Optional. Indicates if bridge uses zapper (usdt -> usdc swap). Defaults to false.

Default: falseExample: false

isSolanastringOptional

Optional. Indicates solana deposits. Defaults to false.

Default: falseExample: false

nestComposerAddressstringOptional

Optional. The Nest composer address extracted from CCTP hook data. Required for Solana deposits.

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

Responses

200

Compliance

application/json

400

Bad request

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/user/{address}/compliance

HTTPcURLJavaScriptPython

GET /v1/user/{address}/compliance HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "isCompliant": true,
    "predicateMessage": {
      "taskId": "text",
      "expireByBlockNumber": 1,
      "signerAddresses": [
        "text"
      ],
      "signatures": [
        "text"
      ]
    }
  }
}