GET

Get KYC Document

Get a KYC document for an identity.

Query Params

identityId string
documentId string

Responses

200

Response Body

object

documents array of objects required
documents object
- id string required
- identityId string required
- status string enum required
  
  pendingprocessingapprovedrejected
- createdAt string date-time required
- updatedAt string date-time required
- fileUploads array of objects
  fileUploads object
  - fileName string required
    
    at least 1 characters
  - fileSize number required
  - uploadStatus string required
    
    at least 1 characters
  - documentType string enum required
    
    frontPhotobackPhotoproofOfResidency
- selectedIdClass string enum
  
  cctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawp

400

Bad Request

Response Body

object

name string
context map of objects required
context object
- <key> object
status number
additionalDetails object
additionalDetails object
- retryAfter number required
error string required
requestId string required

401

Unauthorized

Response Body

object

name string
context map of objects required
context object
- <key> object
status number
additionalDetails object
additionalDetails object
- retryAfter number required
error string required
requestId string required

403

Forbidden

Response Body

object

name string
context map of objects required
context object
- <key> object
status number
additionalDetails object
additionalDetails object
- retryAfter number required
error string required
requestId string required

404

Not Found

Response Body

object

name string
context map of objects required
context object
- <key> object
status number
additionalDetails object
additionalDetails object
- retryAfter number required
error string required
requestId string required

curl --request GET \ --url 'https://app.bitgo-test.com/api/evs/v1/identity/document&identityId=string&documentId=string' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

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

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

{ "documents": [ { "id": "string", "identityId": "string", "status": "pending", "createdAt": "string", "updatedAt": "string", "fileUploads": [ { "fileName": "string", "fileSize": 0, "uploadStatus": "string", "documentType": "frontPhoto" } ], "selectedIdClass": "cct" } ] }