Skip to content

Commit 47503df

Browse files
authored
Merge pull request #308 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 658e8f2 + 6b2950a commit 47503df

1 file changed

Lines changed: 99 additions & 37 deletions

File tree

api.yaml

Lines changed: 99 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -47971,6 +47971,37 @@ components:
4797147971
description: Country of residence (ISO 3166-1 alpha-3)
4797247972
govIdCountryOfIssuance:
4797347973
description: Country where government ID was issued (ISO 3166-1 alpha-3)
47974+
govIdClass:
47975+
type: string
47976+
enum:
47977+
- cct
47978+
- cid
47979+
- dl
47980+
- foid
47981+
- hic
47982+
- id
47983+
- ipp
47984+
- keyp
47985+
- ltpass
47986+
- munid
47987+
- myn
47988+
- nbi
47989+
- nric
47990+
- ofw
47991+
- rp
47992+
- pan
47993+
- pid
47994+
- pp
47995+
- ppc
47996+
- pr
47997+
- sss
47998+
- td
47999+
- tribalid
48000+
- umid
48001+
- vid
48002+
- visa
48003+
- wp
48004+
description: Class of government ID (e.g., dl=driver license, pp=passport, id=ID card)
4797448005
address:
4797548006
type: object
4797648007
properties:
@@ -48017,6 +48048,11 @@ components:
4801748048
items:
4801848049
$ref: '#/components/schemas/MissingRequirement'
4801948050
description: List of missing requirements for the associated person
48051+
documents:
48052+
type: array
48053+
items:
48054+
$ref: '#/components/schemas/Document'
48055+
description: Documents associated with the associated person
4802048056
required:
4802148057
- identityId
4802248058
- role
@@ -51805,6 +51841,20 @@ components:
5180551841
allOf:
5180651842
- $ref: '#/components/schemas/AddressString3'
5180751843
description: Required for CSPR. The validator address used to delegate or undelegate.
51844+
CaaSBitGoProduct:
51845+
type: string
51846+
enum:
51847+
- Trade
51848+
- Instant Fee Wallets
51849+
- Hot Self-Custody
51850+
- Cold Self-Custody
51851+
- Custody
51852+
- DeFi
51853+
- Staking
51854+
- Go Account
51855+
- ACH Debits
51856+
title: CaaSBitGoProduct
51857+
description: BitGo products available via KYB API
5180851858
CannotRemoveAdmin:
5180951859
title: Can't remove admin
5181051860
allOf:
@@ -53396,28 +53446,15 @@ components:
5339653446
name:
5339753447
type: string
5339853448
enum:
53449+
- Trade
5339953450
- Instant Fee Wallets
53400-
- Go Account
53401-
- ACH Debits
53402-
- Settlement
53403-
- Tax
53404-
- Trade API
53405-
- Margin Trading
53406-
- Elliptic
53407-
- CryptoCompare
53408-
- MetaMask
53451+
- Hot Self-Custody
53452+
- Cold Self-Custody
5340953453
- Custody
53410-
- Borrowing
53411-
- Lending
5341253454
- DeFi
53413-
- Cold Self-Custody
53414-
- Go Network
5341553455
- Staking
53416-
- Trade
53417-
- Hot Self-Custody
53418-
- Escrow
53419-
- Escrow - Triparty
53420-
- Distributed Custody
53456+
- Go Account
53457+
- ACH Debits
5342153458
description: Name of the BitGo product
5342253459
bitgoOrg:
5342353460
type: string
@@ -53521,28 +53558,15 @@ components:
5352153558
name:
5352253559
type: string
5352353560
enum:
53561+
- Trade
5352453562
- Instant Fee Wallets
53525-
- Go Account
53526-
- ACH Debits
53527-
- Settlement
53528-
- Tax
53529-
- Trade API
53530-
- Margin Trading
53531-
- Elliptic
53532-
- CryptoCompare
53533-
- MetaMask
53563+
- Hot Self-Custody
53564+
- Cold Self-Custody
5353453565
- Custody
53535-
- Borrowing
53536-
- Lending
5353753566
- DeFi
53538-
- Cold Self-Custody
53539-
- Go Network
5354053567
- Staking
53541-
- Trade
53542-
- Hot Self-Custody
53543-
- Escrow
53544-
- Escrow - Triparty
53545-
- Distributed Custody
53568+
- Go Account
53569+
- ACH Debits
5354653570
description: Name of the BitGo product
5354753571
bitgoOrg:
5354853572
type: string
@@ -57060,29 +57084,36 @@ components:
5706057084
description: The operator address to be used for restaking ETH
5706157085
type: string
5706257086
example: '0x0'
57087+
nullable: true
5706357088
validator:
5706457089
description: The provider to use to provision ETH validators.
5706557090
type: string
5706657091
example: FIGMENT
57092+
nullable: true
5706757093
subType:
5706857094
description: The ETH staking type. Defaults to `STAKE` if not provided.
5706957095
type: string
5707057096
enum:
5707157097
- STAKE
5707257098
- ETH_STAKE_PECTRA
57099+
- LIDO
5707357100
example: STAKE
57101+
nullable: true
5707457102
delegationId:
5707557103
description: Optional delegation id to be used for topup, only active delegations are allowed, that do not have a pending stake or pending unstake.
5707657104
type: string
57105+
nullable: true
5707757106
region:
5707857107
description: The region to use for validator provisioning. If not provided, the provider's default provisioning behaviour will be used.
5707957108
type: string
5708057109
enum:
5708157110
- CA
5708257111
- US
5708357112
- EU
57113+
- SG
5708457114
- DEFAULT
5708557115
example: CA
57116+
nullable: true
5708657117
EthStakingTransaction:
5708757118
title: ETH Staking Transaction
5708857119
allOf:
@@ -61773,6 +61804,37 @@ components:
6177361804
description: Country of residence (ISO 3166-1 alpha-3)
6177461805
govIdCountryOfIssuance:
6177561806
description: Country where government ID was issued (ISO 3166-1 alpha-3)
61807+
govIdClass:
61808+
type: string
61809+
enum:
61810+
- cct
61811+
- cid
61812+
- dl
61813+
- foid
61814+
- hic
61815+
- id
61816+
- ipp
61817+
- keyp
61818+
- ltpass
61819+
- munid
61820+
- myn
61821+
- nbi
61822+
- nric
61823+
- ofw
61824+
- rp
61825+
- pan
61826+
- pid
61827+
- pp
61828+
- ppc
61829+
- pr
61830+
- sss
61831+
- td
61832+
- tribalid
61833+
- umid
61834+
- vid
61835+
- visa
61836+
- wp
61837+
description: Class of government ID (e.g., dl=driver license, pp=passport, id=ID card)
6177661838
address:
6177761839
type: object
6177861840
properties:
@@ -80362,7 +80424,7 @@ components:
8036280424
type: object
8036380425
properties:
8036480426
name:
80365-
$ref: '#/components/schemas/WPBitGoProduct'
80427+
$ref: '#/components/schemas/CaaSBitGoProduct'
8036680428
bitgoOrg:
8036780429
$ref: '#/components/schemas/WPBitgoOrg'
8036880430
country:

0 commit comments

Comments
 (0)