Skip to main content
cURL
curl --request GET \
  --url https://test.deribit.com/api/v2/private/set_clearance_originator \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "private/set_clearance_originator",
  "params": {
    "deposit_id": {
      "currency": "BTC",
      "user_id": 123,
      "address": "2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBz",
      "tx_hash": "230669110fdaf0a0dbcdc079b6b8b43d5af29cc73683835b9bc6b3406c065fda"
    },
    "originator": {
      "is_personal": false,
      "first_name": "First",
      "last_name": "Last",
      "company_name": "Company Name",
      "address": "NL, Amsterdam, Street, 1"
    }
  }
}
'
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "currency": "BTC",
    "user_id": 123,
    "address": "2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBz",
    "amount": 0.4,
    "state": "completed",
    "transaction_id": "230669110fdaf0a0dbcdc079b6b8b43d5af29cc73683835b9bc6b3406c065fda",
    "source_address": "A3BqqD5GRJ8wHy1PYyCXTe9ke5226Fha123",
    "received_timestamp": 1550574558607,
    "updated_timestamp": 1550574558807,
    "note": "Note",
    "clearance_state": "in_progress"
  }
}

Query Parameters

​
deposit_id
string
required

Id of the deposit JSON string containing: object data

​
originator
string
required

Information about the originator of the deposit JSON string containing: object data

Response

200 - application/json

Success response

​
currency
enum<string>
required

Currency, i.e "BTC", "ETH", "USDC"

Available options:
BTC,
ETH,
USDC,
USDT,
EURR
​
address
string
required

Address in proper format for currency

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

​
amount
number
required

Amount of funds in given currency

Example:

1

​
state
enum<string>
required

Deposit state. Allowed values: - pending: deposit detected on blockchain/system, compliance not yet finished

  • completed: compliance check finished successfully
  • rejected: deposit failed compliance and must be handled manually
  • replaced: deposit transaction was replaced on the blockchain and should have a new transaction hash
Available options:
pending,
completed,
rejected,
replaced
​
transaction_id
string | null
required

Transaction id in proper format for currency, null if id is not available

Example:

"1b1fb5568515e2b79503501e3d3680b2d0838d5dfc2d15a04eb8cd9fbbe0b572"

​
received_timestamp
integer
required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

​
updated_timestamp
integer
required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

​
source_address
string

Address in proper format for currency

Example:

"1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"

​
note
string
​
clearance_state
enum<string>

Clearance state indicating the current status of the transaction clearance process. Allowed values: - in_progress: clearance process is in progress

  • pending_admin_decision: transaction is under manual review by Deribit admin
  • pending_user_input: user should provide additional information regarding the transaction
  • success: clearance process completed successfully
  • failed: clearance process failed, transaction is rejected
  • cancelled: transaction is cancelled (currently used only for withdrawals, meaning the withdrawal is cancelled)
  • refund_initiated: clearance process failed, transaction refund is initiated, funds are removed from Deribit balance (valid for deposits only)
  • refunded: clearance process failed, deposit amount is refunded back to the client (valid for deposits only)
Available options:
in_progress,
pending_admin_decision,
pending_user_input,
success,
failed,
cancelled,
refund_initiated,
refunded
​
refund_transaction_id
string | null

Transaction id in proper format for currency, null if id is not available

Example:

"1b1fb5568515e2b79503501e3d3680b2d0838d5dfc2d15a04eb8cd9fbbe0b572"