POST

Verify KYB Document Status

Verify the upload status of all files in a document by checking with the storage provider. Updates file and document statuses based on actual verification results.

Path Params

documentId string uuid required

Unique identifier for the document

Responses

200

Response Body

object

Response after verifying document upload status

documentId string required

Unique identifier for the document
documentType string enum required

Type of document being uploaded

governmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfGoodStandingcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalentproofOfAddresssourceOfWealthsingaporeSupportingDocumentcaseRequiredDocumentscorrespondentAccountCertificationauthorizedSignerForm
documentTypeLabel string required

Human-readable label for the document type
subType string enum

Subtype of document (relevant for governmentId and singaporeSupportingDocument document types)

cctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawpcomputerizedPayslipsincomeTaxAssessmentemploymentLetterContractbankStatementdptHoldingStatementinvestmentHoldingsStatementtitleDeedspropertyTaxCpfStatementother
status string enum required

Current status of the document

awaitingUploaduploadedacceptedrejected
files array of objects required

List of files with verification status
files object
- fileId string required
  
  Unique identifier for the file
- fileView string enum required
  
  View or side of the document file
  
  frontbackfull
- required boolean required
  
  Whether this file is required for the document
- status string enum required
  
  Current status of the file upload. requiresManualReview is a terminal state set after 2 failed AI screening attempts; the file is locked and Trust ops resolves it manually.
  
  awaitingUploaduploadedacceptedrejectedrequiresManualReview
- downloadUrl string uri
  
  Presigned URL for file download

400

Response Body

object

Generic error response

code string required

Error code
message string required

Error message
details map of objects

Additional error details
details object
- <key> object nullable

401

Response Body

object

Generic error response

code string required

Error code
message string required

Error message
details map of objects

Additional error details
details object
- <key> object nullable

403

Response Body

object

Generic error response

code string required

Error code
message string required

Error message
details map of objects

Additional error details
details object
- <key> object nullable

404

Response Body

object

Generic error response

code string required

Error code
message string required

Error message
details map of objects

Additional error details
details object
- <key> object nullable

500

Response Body

object

Generic error response

code string required

Error code
message string required

Error message
details map of objects

Additional error details
details object
- <key> object nullable

curl --request POST \ --url 'https://app.bitgo-test.com/api/document-service/v1/documents/documentId/verify' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{}'

const url = 'https://app.bitgo-test.com/api/document-service/v1/documents/documentId/verify'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({}) }; 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/document-service/v1/documents/documentId/verify") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/document-service/v1/documents/documentId/verify', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/document-service/v1/documents/documentId/verify" payload = {} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)

{ "documentId": "string", "documentType": "governmentId", "documentTypeLabel": "string", "subType": "cct", "status": "awaitingUpload", "files": [ { "fileId": "string", "fileView": "front", "required": true, "status": "awaitingUpload", "downloadUrl": "string" } ] }