GET

List the caller's Sumsub IDV records

Returns IDV records for the authenticated user (user-id header). Optional enterpriseId filters to that enterprise. Does not create an applicant. Empty list when the caller has no IDV, or when enterpriseId is set and not linked (does not leak existence). Does not refresh the WebSDK URL — call POST /v1/idv to initiate or retry.

Query Params

enterpriseId string

Optional BitGo enterprise ID. When set, only IDVs linked to this enterprise are returned. When omitted, returns every enterprise link for the caller.

at least 1 characters

Responses

200

Response Body

object

idvRecords array of objects required
idvRecords object
- idvId string required
- status string enum required
  
  pendingaction_requiredapprovedrejected
- verificationType string enum required
  
  penny-dropvideo-idliveness-onlydeposit-verification
- userId string required
- enterpriseId string required
- organizationId string nullable required
- rejectLabels array of strings nullable required

400

Response Body

object

error string required

Error message

403

Response Body

object

error string required

Error message

500

Response Body

object

error string required

Error message

curl -X GET \ --url 'https://app.bitgo-test.com/api/sumsub-service/v1/idv&enterpriseId=string' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/sumsub-service/v1/idv&enterpriseId=string'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; 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/sumsub-service/v1/idv&enterpriseId=string") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/sumsub-service/v1/idv&enterpriseId=string', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/sumsub-service/v1/idv&enterpriseId=string" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "idvRecords": [ { "idvId": "string", "status": "pending", "verificationType": "penny-drop", "userId": "string", "enterpriseId": "string", "organizationId": "string", "rejectLabels": [ "string" ] } ] }