GET

List KYB Documents

Retrieve all documents associated with an identity.

Path Params

identityId string uuid required

The unique ID of the identity

Responses

200

Response Body

object

identityId string required

The identity ID
documents array of objects required

List of documents associated with the identity
documents object
- id string required
  
  Internal ID for the document association
- documentId string required
  
  External document service ID
- documentType string enum required
  
  Type of document being uploaded
  
  governmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfGoodStandingcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalentproofOfAddresssourceOfWealthsingaporeSupportingDocumentcaseRequiredDocumentscorrespondentAccountCertificationauthorizedSignerForm
- documentSubType string nullable
  
  Sub-classification within a document type (e.g., Singapore supporting document subtype).
- status string enum required
  
  Verification status
  
  missingcountExceededsubmittedinReviewverified
- createdAt string required
  
  ISO timestamp when document was associated
- updatedAt string required
  
  ISO timestamp when association was last updated

400

Response Body

object

error string required

404

Response Body

object

error string required

500

Response Body

object

error string required

curl --request GET \ --url 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId/documents' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId/documents'; 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/identity-service/v1/identities/identityId/documents") 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/identity-service/v1/identities/identityId/documents', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/identity-service/v1/identities/identityId/documents" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "identityId": "string", "documents": [ { "id": "string", "documentId": "string", "documentType": "governmentId", "documentSubType": "string", "status": "missing", "createdAt": "string", "updatedAt": "string" } ] }