Ctrl+K

Upload KYC document and get IPFS hash

post/api/staking/v1/{coin}/wallets/{walletId}/kyc/upload

Accepts a KYC PDF document, uploads it to the XinFin MasterNode IPFS API, and returns the authoritative IPFS hash assigned by the network. Only supported for XDC and TXDC coins.

The returned hash must be included in the subsequent XDC stake request as kycHash. It is submitted to the validator contract in the AUTHORIZE (uploadKYC) transaction.

Path Parameters

  • coinstringRequired
    Must be xdc or txdc.
    Enum: xdc txdc
  • walletIdstringRequired
    The wallet ID of the wallet used for staking.
    Example: 59cd72485007a239fb00282ed480da1f

Request Body

The request body for uploading KYC.
file string <binary>required
The KYC PDF document to upload (max 5MB).

200 Response

hash string required
IPFS CIDv0 hash of the uploaded KYC document. Must be included as `kycHash` in the subsequent XDC stake request.
Example: QmT5NvUtoM5nWFfrQdVrFtvGfKFmG7AHE8P34isapyhCxX
Match pattern: ^Qm[1-9A-HJ-NP-Za-km-z]{44}$

400 Response

error string
errorName string
reqId string
context object

401 Response

error string
errorName string
reqId string
context object

403 Response

error string
errorName string
reqId string
context object

500 Response

error string
errorName string
reqId string
context object