POST

Add KYB Documents

Add and validate documents for an existing identity. Documents are verified with the document service before being associated with the identity.

Path Params

identityId string uuid required

The unique ID of the identity

Body Params

object

documents array of objects required

List of documents to accept

at least 1 items
documents object
- documentId string uuid required
  
  External document service ID (must be a valid UUID)
- documentType string enum required
  
  Type of document being uploaded
  
  governmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfGoodStandingcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalentproofOfAddresssourceOfWealthsingaporeSupportingDocumentcaseRequiredDocumentscorrespondentAccountCertificationauthorizedSignerForm
- documentSubType string
  
  Sub-classification within a document type. Required when documentType is singaporeSupportingDocument (valid values: SingaporeSupportingDocumentSubTypeEnum, e.g. computerizedPayslips, bankStatement).

Responses

201

Response Body

object

identityId string required

The identity ID
acceptedDocuments array of objects required

Successfully accepted documents
acceptedDocuments 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
rejectedDocuments array of objects required

Documents that failed validation
rejectedDocuments object
- 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.
- reason string required
  
  Reason for rejection

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 POST \ --url 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId/documents' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"documents":[{,"documentId":"string","documentType":"governmentId","documentSubType":"string"}]}'

const url = 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId/documents'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"documents":[{,"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") 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 = '{,"documents":[{,"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('POST', 'https://app.bitgo-test.com/api/identity-service/v1/identities/identityId/documents', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"documents":[{,"documentId":"string","documentType":"governmentId","documentSubType":"string"}]}', ]); echo $response->getBody();

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

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