PUT

Update KYB Document

Update a specific document association (document ID, type, or status).

Path Params

identityId string uuid required

The unique ID of the identity
identityDocumentId string uuid required

The unique ID of the document association

Body Params

object

documentId string uuid

New external document service ID (must be a valid UUID)
documentType string enum

Type of document being uploaded

governmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfGoodStandingcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalentproofOfAddresssourceOfWealthsingaporeSupportingDocumentcaseRequiredDocumentscorrespondentAccountCertificationauthorizedSignerForm
documentSubType string

Updated sub-classification within the document type.

Responses

200

Response Body

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

422

Response Body

object

error string required

500

No response body

curl --request PUT \ --url 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId/documents/identityDocumentId' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"documentId":"string","documentType":"governmentId","documentSubType":"string"}'

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

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('PUT', 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId/documents/identityDocumentId', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"documentId":"string","documentType":"governmentId","documentSubType":"string"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/identity-service/v1/identities/identityId/documents/identityDocumentId" payload = {,"documentId":"string","documentType":"governmentId","documentSubType":"string"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.text)