POST

Upload KYC document and get IPFS hash

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 Params

coin string enum required

Must be xdc or txdc.

xdctxdc
walletId string required

The wallet ID of the wallet used for staking.

Body Params

object

file string binary required

The KYC PDF document to upload (max 5MB).

Responses

200

IPFS hash computed successfully.

Response Body

object

Response containing the IPFS CIDv0 hash of the uploaded KYC document.

hash string required

IPFS CIDv0 hash of the uploaded KYC document. Must be included as kycHash in the subsequent XDC stake request.

matches ^Qm[1-9A-HJ-NP-Za-km-z]{44}$

400

Bad Request

Response Body

object

error string
errorName string
reqId string
context object

401

Unauthorized

Response Body

object

error string
errorName string
reqId string
context object

403

Forbidden

Response Body

object

error string
errorName string
reqId string
context object

500

Server Error - Transient error please try again

Response Body

object

error string
errorName string
reqId string
context object

curl --request POST \ --url 'https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/kyc/upload' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"file":"string"}'

const url = 'https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/kyc/upload'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"file":"string"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/kyc/upload") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"file":"string"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/kyc/upload', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"file":"string"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/staking/v1/coin/wallets/walletId/kyc/upload" payload = {,"file":"string"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)