Skip to content

Commit 5d58247

Browse files
dev-portal-updater-protected[bot]dev-portal-updater-protected[bot]
authored
Merge pull request #405 from BitGo/update-bitgo-api-docs
Update API reference on BitGo Developer Portal
2 parents 04735b5 + 120f34c commit 5d58247

1 file changed

Lines changed: 227 additions & 0 deletions

File tree

‎api.yaml‎

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29726,6 +29726,233 @@ paths:
2972629726
$ref: '#/components/responses/ForbiddenError2'
2972729727
'500':
2972829728
$ref: '#/components/responses/InternalServerError1'
29729+
/api/sumsub-service/v1/idv/{idvId}:
29730+
get:
29731+
summary: Get Sumsub IDV status
29732+
description: Returns the current identity verification status for the given IDV record. Does not refresh the WebSDK URL — call POST /v1/idv to initiate or retry.
29733+
operationId: sumsub.get.v1.idv.id
29734+
tags:
29735+
- Identity Verification (IDV)
29736+
x-internal: false
29737+
parameters:
29738+
- name: idvId
29739+
in: path
29740+
required: true
29741+
schema:
29742+
type: string
29743+
description: The IDV record ID
29744+
responses:
29745+
'200':
29746+
description: '200'
29747+
content:
29748+
application/json:
29749+
schema:
29750+
type: object
29751+
properties:
29752+
idvId:
29753+
type: string
29754+
status:
29755+
type: string
29756+
enum:
29757+
- pending
29758+
- action_required
29759+
- approved
29760+
- rejected
29761+
userId:
29762+
type: string
29763+
enterpriseId:
29764+
type: string
29765+
organizationId:
29766+
type: string
29767+
nullable: true
29768+
rejectLabels:
29769+
type: array
29770+
items:
29771+
type: string
29772+
nullable: true
29773+
required:
29774+
- idvId
29775+
- status
29776+
- userId
29777+
- enterpriseId
29778+
- organizationId
29779+
- rejectLabels
29780+
'403':
29781+
description: '403'
29782+
content:
29783+
application/json:
29784+
schema:
29785+
type: object
29786+
properties:
29787+
error:
29788+
type: string
29789+
description: Error message
29790+
required:
29791+
- error
29792+
additionalProperties: true
29793+
'404':
29794+
description: '404'
29795+
content:
29796+
application/json:
29797+
schema:
29798+
type: object
29799+
properties:
29800+
error:
29801+
type: string
29802+
description: Error message
29803+
required:
29804+
- error
29805+
additionalProperties: true
29806+
'500':
29807+
description: '500'
29808+
content:
29809+
application/json:
29810+
schema:
29811+
type: object
29812+
properties:
29813+
error:
29814+
type: string
29815+
description: Error message
29816+
required:
29817+
- error
29818+
additionalProperties: true
29819+
/api/sumsub-service/v1/idv:
29820+
post:
29821+
summary: Initiate Sumsub IDV for a user
29822+
description: Initiates the Sumsub identity verification flow for a user within an enterprise. Returns a WebSDK URL when verification is pending, or a completion status if the user has already been verified.
29823+
operationId: sumsub.post.v1.idv
29824+
tags:
29825+
- Identity Verification (IDV)
29826+
x-internal: false
29827+
parameters: []
29828+
requestBody:
29829+
description: Body
29830+
content:
29831+
application/json:
29832+
schema:
29833+
type: object
29834+
properties:
29835+
userId:
29836+
type: string
29837+
description: The BitGo user ID
29838+
enterpriseId:
29839+
type: string
29840+
description: The BitGo enterprise ID
29841+
sumsubShareToken:
29842+
type: string
29843+
minLength: 1
29844+
description: Share token to copy an existing applicant from another Sumsub environment
29845+
required:
29846+
- userId
29847+
- enterpriseId
29848+
responses:
29849+
'200':
29850+
description: '200'
29851+
content:
29852+
application/json:
29853+
schema:
29854+
discriminator:
29855+
propertyName: status
29856+
oneOf:
29857+
- type: object
29858+
properties:
29859+
idvId:
29860+
type: string
29861+
status:
29862+
type: string
29863+
enum:
29864+
- pending
29865+
url:
29866+
type: string
29867+
expiresAt:
29868+
type: string
29869+
required:
29870+
- idvId
29871+
- status
29872+
- url
29873+
- expiresAt
29874+
title: Pending
29875+
- type: object
29876+
properties:
29877+
idvId:
29878+
type: string
29879+
status:
29880+
type: string
29881+
enum:
29882+
- action_required
29883+
url:
29884+
type: string
29885+
expiresAt:
29886+
type: string
29887+
required:
29888+
- idvId
29889+
- status
29890+
- url
29891+
- expiresAt
29892+
title: Action Required
29893+
- type: object
29894+
properties:
29895+
idvId:
29896+
type: string
29897+
status:
29898+
type: string
29899+
enum:
29900+
- approved
29901+
required:
29902+
- idvId
29903+
- status
29904+
title: Approved
29905+
- type: object
29906+
properties:
29907+
idvId:
29908+
type: string
29909+
status:
29910+
type: string
29911+
enum:
29912+
- rejected
29913+
required:
29914+
- idvId
29915+
- status
29916+
title: Rejected
29917+
'400':
29918+
description: '400'
29919+
content:
29920+
application/json:
29921+
schema:
29922+
type: object
29923+
properties:
29924+
error:
29925+
type: string
29926+
description: Error message
29927+
required:
29928+
- error
29929+
additionalProperties: true
29930+
'403':
29931+
description: '403'
29932+
content:
29933+
application/json:
29934+
schema:
29935+
type: object
29936+
properties:
29937+
error:
29938+
type: string
29939+
description: Error message
29940+
required:
29941+
- error
29942+
additionalProperties: true
29943+
'500':
29944+
description: '500'
29945+
content:
29946+
application/json:
29947+
schema:
29948+
type: object
29949+
properties:
29950+
error:
29951+
type: string
29952+
description: Error message
29953+
required:
29954+
- error
29955+
additionalProperties: true
2972929956
/api/fiat/v1/transaction/ach-debit:
2973029957
post:
2973129958
summary: Initiate ACH deposit

0 commit comments

Comments
 (0)