Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Deposit Attribution

Attribute a deposit

Permissions required: Deposit Attribution.

Attribute a deposit by providing information about the originator.

Only attributions in PENDING status can be attributed.

Once the attribution is successfully performed the attribution status moves from PENDING to UNDER_REVIEW.

For attributions performed via API the attributionType will always be CLIENT_API.

patch/deposit-attributions/{depositTransactionId}

Path parameters

depositTransactionIdstring required

The transactionId where the transactionType is DEPOSIT.

Headers

Api-Signaturestring required

A hex-encoded Ed25519 signature of timestamp_epoch_seconds + uppercase(http_method) + request_path + request_body.

Construction example:

toHex(
  ed25519Sign(
    signing_key,
    '{}{}{}{}'.format(timestamp_epoch_seconds, toUpper(httpMethod), httpRequestPath, httpBody)
  )
)
Api-Timestampinteger required

Current timestamp, represented as unix epoch seconds

Request body

notesstring

Additional notes for the deposit attribution.

originatorCountrystring required

The country code (ISO 3166-1 alpha-2) of the originator of this deposit. This field is required in order to perform an attribution.

originatorNamestring required

The name of the originator of this deposit. This field is required in order to perform an attribution.

sourceWalletType'CUSTODIAL' | 'SELF_HOSTED' required

The type of wallet being used by the deposit originator:

  • CUSTODIAL - The wallet owner does not have complete control over the wallet as they do not have the private key; a third party does. This key is needed to conduct transfers. Examples of custodial wallets include: Binance, Coinbase, Kraken, and Bitgo.
  • SELF_HOSTED - The wallet owner has complete control over the wallet as they have the private key. Examples of self-hosted wallets include: Metamask, Trust Wallet, Ledger Nano X, Trezor One, Electrum, Exodus, and Phantom.

This field is required in order to perform an attribution.

Example request

{
  "notes": "US",
  "originatorCountry": "US",
  "originatorName": "John Doe",
  "sourceWalletType": "CUSTODIAL"
}

Response

Deposit attributed successfully

Example response

{
  "data": {
    "depositTransactionId": "0e2b2f9d-8d10-4f1e-960b-28567255045f"
  }
}