Create a Crypto Wallet

Create a Crypto Wallet by passing the cryptocurrency
Create a Crypto Wallet
 last updated: 
September 16, 2022

To create a crypto wallet, please note the following:

- If you are creating a business crypto wallet, pass the businessId in the request object.
- If you are creating a personal crypto wallet, the personId is already included in the header.
- The idNumber field in the person object must have the full SSN (if US citizen) or passport number (if non-US citizen). If your person object only has the last 4 of SSN, creating a crypto wallet will fail.
- During the crypto wallet creation, it is your responsibility to present an option for the user to accept the Terms, after which you should set acceptedTerms as true in the request body.
- You also need to pass one of the supported crypto currencies in the request.

ENDPOINT

  1. POST /v1/crypto

REQUEST

  1. {
  2.    "label": "Jane's BTC Wallet",
  3.    "acceptedTerms": true,
  4.    "currency": "BTC"
  5. }

RESPONSE

  1. {
  2.     "id": "cpw-c8b351d4-95d6-423b-a984-7907d273f817",
  3.     "businessId": "",
  4.     "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  5.     "createdPersonId": "per-b1216152-0d54-401f-816f-de392b5ba77f",
  6.     "label": "Jane's BTC Wallet",
  7.     "cryptoAddress": "tb1qscc2j3358fsrhtzkh3qdklayhndfckzlha330h",
  8.     "cryptoBalance": "0.00000000",
  9.     "usdBalance": "0.00",
  10.     "currency": "BTC",
  11.     "custodian": "Zerohash",
  12.     "status": "",
  13.     "acceptedTerms": true,
  14.     "metadata": null,
  15.     "config": {
  16.         "card": {
  17.             "virtual": {
  18.                 "enabled": true,
  19.                 "count": "5"
  20.             },
  21.             "physical": {
  22.                 "enabled": true,
  23.                 "count": "5"
  24.             }
  25.         },
  26.         "buy": {
  27.             "enabled": true
  28.         },
  29.         "sell": {
  30.             "enabled": true
  31.         },
  32.         "send": {
  33.             "enabled": true
  34.         },
  35.         "receive": {
  36.             "enabled": true
  37.         }
  38.     },
  39.     "createdAt": "2022-04-01T00:51:08Z",
  40.     "modifiedAt": "2022-04-01T00:51:08Z",
  41.     "familyId": ""
  42. }