Skip to content

Commit 77b6240

Browse files
authored
Merge pull request #309 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 47503df + b8f675f commit 77b6240

1 file changed

Lines changed: 52 additions & 6 deletions

File tree

api.yaml

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12702,15 +12702,33 @@ paths:
1270212702
- `visa` - Visa
1270312703
- `wp` - Work Permit
1270412704
frontPhoto:
12705-
description: Front photo of the identity document
12705+
description: |-
12706+
Front photo of the identity document
12707+
12708+
Image Requirements:
12709+
- Dimensions: 200 to 15,000 px
12710+
- File Size: 10 KB to 15 MB
12711+
- Supported Formats: JPG, JPEG, PNG, HEIC, PDF
1270612712
example: '"passport-front.jpg"'
1270712713
format: binary
1270812714
backPhoto:
12709-
description: Back photo of the identity document
12715+
description: |-
12716+
Back photo of the identity document
12717+
12718+
Image Requirements:
12719+
- Dimensions: 200 to 15,000 px
12720+
- File Size: 10 KB to 15 MB
12721+
- Supported Formats: JPG, JPEG, PNG, HEIC, PDF
1271012722
example: '"drivers-license-back.png"'
1271112723
format: binary
1271212724
proofOfResidency:
12713-
description: Proof of residency
12725+
description: |-
12726+
Proof of residency
12727+
12728+
Image Requirements:
12729+
- Dimensions: 200 to 15,000 px
12730+
- File Size: 10 KB to 15 MB
12731+
- Supported Formats: JPG, JPEG, PNG, HEIC, PDF
1271412732
example: '"rental-lease.pdf"'
1271512733
format: binary
1271612734
responses:
@@ -12830,15 +12848,33 @@ paths:
1283012848
- `visa` - Visa
1283112849
- `wp` - Work Permit
1283212850
frontPhoto:
12833-
description: Front photo of the identity document
12851+
description: |-
12852+
Front photo of the identity document
12853+
12854+
Image Requirements:
12855+
- Dimensions: 200 to 15,000 px
12856+
- File Size: 10 KB to 15 MB
12857+
- Supported Formats: JPG, JPEG, PNG, HEIC, PDF
1283412858
example: '"passport-front.jpg"'
1283512859
format: binary
1283612860
backPhoto:
12837-
description: Back photo of the identity document
12861+
description: |-
12862+
Back photo of the identity document
12863+
12864+
Image Requirements:
12865+
- Dimensions: 200 to 15,000 px
12866+
- File Size: 10 KB to 15 MB
12867+
- Supported Formats: JPG, JPEG, PNG, HEIC, PDF
1283812868
example: '"drivers-license-back.png"'
1283912869
format: binary
1284012870
proofOfResidency:
12841-
description: Proof of residency
12871+
description: |-
12872+
Proof of residency
12873+
12874+
Image Requirements:
12875+
- Dimensions: 200 to 15,000 px
12876+
- File Size: 10 KB to 15 MB
12877+
- Supported Formats: JPG, JPEG, PNG, HEIC, PDF
1284212878
example: '"rental-lease.pdf"'
1284312879
format: binary
1284412880
responses:
@@ -54071,11 +54107,15 @@ components:
5407154107
type: string
5407254108
format: decimal
5407354109
description: This is the smallest amount that can be traded for the currency.
54110+
platformSymbol:
54111+
type: string
54112+
description: The BitGo platform symbol for this currency.
5407454113
example:
5407554114
id: 519824c6-b534-49b4-a636-22dfd0ade5cf
5407654115
symbol: USD
5407754116
name: US Dollar
5407854117
increment: '0.01'
54118+
platformSymbol: USD
5407954119
Currency1:
5408054120
title: Currency
5408154121
type: object
@@ -67187,6 +67227,9 @@ components:
6718767227
pattern: ^[0-9a-f]{32}$
6718867228
walletType:
6718967229
type: string
67230+
walletSubType:
67231+
type: string
67232+
description: The subtype of the wallet (e.g., custodialHot)
6719067233
wallets:
6719167234
type: array
6719267235
items:
@@ -84383,6 +84426,9 @@ components:
8438384426
maxQuantity:
8438484427
type: string
8438584428
description: Maximum quantity allowed
84429+
field:
84430+
type: string
84431+
description: Request field name that caused the error
8438684432
errorName:
8438784433
type: string
8438884434
example:

0 commit comments

Comments
 (0)