POST

Add KYB Documents

Creates a new document and returns presigned URLs for file uploads

Body Params

object

Request body for creating a new document

documentType string enum required
Type of document being uploaded. Supported document types:
- governmentId - The official government-issued identity document for an individual associated with the business (e.g., director, shareholder, or authorized signatory) required for identity verification.
- commercialRegister - Official government document that verifies the identity and legitimacy of the business, containing basic information such as the company's name, address, field of activity, shareholders, and capital.
- articlesOfAssociation - The Articles of Association are formal legal documents that serve as the company's rulebook, outlining its fundamental structure, purpose, internal operations, and how decisions are made, including details on share capital, director appointments, and shareholder rights.
- certificateOfIncorporation - The official document issued by the government registrar that legally recognizes your company's existence and outlines essential information such as its name, purpose, and structure.
- certificateOfGoodStanding - An official document issued by the government registrar confirming that the company is legally registered, active, and in compliance with statutory filing and payment obligations. Must be dated within the last 12 months.
- certificateOfTrust - A document that verifies the existence of a trust, the identity of the trustee(s), and their authority to act on behalf of the trust.
- certificateOfIncumbency - A private legal document issued by the company that verifies the identities and authority of the current directors, officers, and sometimes key shareholders who are authorized to act on behalf of the company in transactions.
- certificateOfIncumbencyOrShareRegister - An official document listing current directors, shareholders, and the company's registered address, or a certified document detailing all company shareholders and their respective shareholdings.
- proofOfPrincipalPlaceOfBusiness - Document confirming the address of the company's principal place of business (e.g., utility bill or bank account statement no older than 3 months).
- activeTradeLicense - The active and valid trade license or equivalent regulatory document issued by the relevant governing authority, proving the business's legal authorization to operate.
- resolutionToOpenBitgoUaeAccount - A document confirming the company's internal resolution or decision to open an account with BitGo UAE.
- resolutionToOpenBitgoSingaporeAccount - This field is for uploading the corporate resolution document confirming authorization to open an account with BitGo Singapore.
- proofOfAuthorizedSignatories - Document confirming the legal authority of the individual(s) authorized to sign contracts and legally binding documents on behalf of the company.
- memorandumOfAssociation - The Memorandum of Association is one of the company's constitutional documents. It typically includes the company's name, address, and confirms the initial shareholders agree to form the company and become members.
- memorandumAndArticlesOfAssociation - This document serves as the constitutional document of the company, outlining its legal existence, objectives, and internal governing rules.
- bylawsOrOperatingAgreement - The company's bylaws or operating agreement. These are governing documents that define the company's structure, operations, and the rights and responsibilities of its members or shareholders.
- operatingAgreement - The operating agreement is a key document that outlines the ownership, internal governance, and operating procedures of the business entity.
- w8 - W-8BEN or W-8BEN-E Form: Used by individuals/institutions to certify foreign status for U.S. tax purposes and to claim treaty benefits for certain types of income (e.g., royalty/passive income, scholarships/fellowships). This form is required to determine the correct rate of tax withholding.
- w9 - This field collects the IRS Form W-9, "Request for Taxpayer Identification Number and Certification." This document is used to confirm your business's name, address, and Taxpayer Identification Number (TIN) for income reporting purposes.
- evidenceOfLegalStatus - Document that confirms your company is currently active and legally authorized to operate in the country or jurisdiction where it was formed. Examples of accepted documents that clearly state or evidence active or good standing include: Certificate of Good Standing, Business Registration or Trade License, Company Registry Extract, Certificate of Incumbency. Note: Documents must be issued within the last 12 months. If an older document is submitted, you may be asked to provide an updated copy.
- evidenceOfActiveStatus - A document that verifies the business entity's current legal standing and active operational status, often an extract from a state company registry or equivalent proof of legal existence.
- proofOfJfsaLicense - Document required as proof of the business's registration or license with the Japanese Financial Services Agency (JFSA).
- proofOfGamingLicense - The official document verifying that your business holds a valid gaming or gambling license issued by the relevant regulatory authority.
- organizationDocument - This field is for uploading the business's organization document. This confirms the entity's legal existence and compliance with regulations. Common documents include the certificate of incorporation, articles of association, or recent excerpts from a state company registry.
- partnershipAgreement - The official document formalizing a business partnership. This document confirms the legal structure and ownership details of the entity.
- articlesOfOrganization - The official document filed with a state to legally form a Limited Liability Company (LLC). It secures the business name and establishes the legal entity.
- businessLicenseOrRegistration - This field is for uploading the company's official business license or registration document, which confirms the legal identity and legitimacy of the business.
- evidenceOfGovernmentOrStateOwnership - Documentation required to verify if the entity is owned or operated by a government or state organization.
- secFilingsAsEvidenceOfPublicTradingStatus - Document field used to collect Securities and Exchange Commission (SEC) filings that serve as evidence of the business entity's public trading status.
- foundingTreatyOrEquivalent - The founding treaty or equivalent document serves as official proof of the business entity's legal existence and is often referred to as a Certificate of Incorporation, Articles of Association, or other governing documents, depending on the jurisdiction and business structure.
- proofOfAddress - A document that verifies the individual's residential address, such as a utility bill, bank statement, or government correspondence dated within the last 3 months.
- sourceOfWealth - A document that evidences the individual's source of wealth, required for high-risk individuals under enhanced due diligence.
- singaporeSupportingDocument - A supporting document for Singapore Accredited Investor qualification. The specific document is indicated by the documentSubType field (e.g., computerizedPayslips, bankStatement, titleDeeds).
- caseRequiredDocuments - A collection of documents required for a specific KYB/KYC case. Unlike other document types, the specific file slots and their per-file document classifications are defined per-instance at creation time rather than statically configured. Each file within this collection sets its own classification via the File.documentType field.
- correspondentAccountCertification — FinCEN Certification Regarding Correspondent Accounts for Foreign Banks. Required from non-US bank applicants per FinCEN regulations. The blank form is available at https://www.fincen.gov/system/files/shared/Certification%20Regarding%20Correspondent%20Accounts%20for%20Foreign%20Banks.pdf — the applicant completes, signs, and uploads it.
- authorizedSignerForm — A signed form identifying the individual authorized to make contractual commitments on behalf of the applicant. The blank fillable form is available at https://www.bitgo.com/legal/bitgo-bank-and-trust-na-authorized-signer-form/ — the authorized signer completes, signs, and uploads it.
governmentIdcommercialRegisterarticlesOfAssociationcertificateOfIncorporationcertificateOfGoodStandingcertificateOfTrustcertificateOfIncumbencycertificateOfIncumbencyOrShareRegisterproofOfPrincipalPlaceOfBusinessactiveTradeLicenseresolutionToOpenBitgoUaeAccountresolutionToOpenBitgoSingaporeAccountproofOfAuthorizedSignatoriesmemorandumOfAssociationmemorandumAndArticlesOfAssociationbylawsOrOperatingAgreementoperatingAgreementw8w9evidenceOfLegalStatusevidenceOfActiveStatusproofOfJfsaLicenseproofOfGamingLicenseorganizationDocumentpartnershipAgreementarticlesOfOrganizationbusinessLicenseOrRegistrationevidenceOfGovernmentOrStateOwnershipsecFilingsAsEvidenceOfPublicTradingStatusfoundingTreatyOrEquivalentproofOfAddresssourceOfWealthsingaporeSupportingDocumentcaseRequiredDocumentscorrespondentAccountCertificationauthorizedSignerForm
subType string enum
Subtype of document (required when documentType is 'governmentId' or 'singaporeSupportingDocument'). Supported subtypes:
- cct - Citizenship Certificate
- cid - Consular ID
- dl - Driver's License
- foid - CO Foreigner ID
- hic - Health Insurance Card
- id - Identification Card
- ipp - Internal Passport
- keyp - AU Keypass ID
- ltpass - Long Term Pass
- munid - US Municipal ID (e.g. NYC ID)
- myn - JP My Number Card (SSN)
- nbi - PH National Bureau of Investigation Certificate
- nric - SG National Residency ID
- ofw - PH Overseas Foreign Worker Card
- rp - Residence Permit
- pan - IN Permanent Account Number card (SSN)
- pid - PH Postal Identity Card
- pp - Passport
- ppc - Passport Card
- pr - Permanent Residence Card
- sss - PH Social Security System Card (SSN)
- td - US Travel Document
- tribalid - US/CA Tribal ID
- umid - PH Unified Multi Purpose ID
- vid - Voter ID
- visa - Visa
- wp - Work Permit
Singapore Accredited Investor supporting document subtypes (for documentType 'singaporeSupportingDocument'):
- computerizedPayslips - Computerized payslips (qualifying criteria: income)
- incomeTaxAssessment - Income tax assessment (qualifying criteria: income)
- employmentLetterContract - Employment letter or contract (qualifying criteria: income)
- bankStatement - Bank statement (qualifying criteria: netAssets, financialAssets)
- dptHoldingStatement - Digital payment token holding statement (qualifying criteria: netAssets)
- investmentHoldingsStatement - Investment holdings statement (qualifying criteria: netAssets, financialAssets)
- titleDeeds - Title deeds (qualifying criteria: netAssets)
- propertyTaxCpfStatement - Property tax or CPF statement (qualifying criteria: netAssets)
- other - Other supporting document
cctciddlfoidhicidippkeypltpassmunidmynnbinricofwrppanpidppppcprssstdtribalidumidvidvisawpcomputerizedPayslipsincomeTaxAssessmentemploymentLetterContractbankStatementdptHoldingStatementinvestmentHoldingsStatementtitleDeedspropertyTaxCpfStatementother
metadata map of objects

Optional metadata for the document (max 100KB)
forUserId string

BitGo public user ID the document is created for; exactly 32 alphanumeric characters

matches ^[a-zA-Z0-9]{32}$

Responses

201

Response Body

object

Response after creating a new document

documentId string required

Unique identifier for the created 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 to be uploaded
files object
- fileId string required
  
  Unique identifier for the file
- fileView string required
  
  View or side of the document file
- label string required
  
  Human-readable label for the file
- required boolean required
  
  Whether this file is required for the document
- uploadUrl string uri required
  
  Presigned URL for file upload
- expiresAt string date-time required
  
  When the upload URL expires

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

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' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"documentType":"governmentId","subType":"cct","metadata":{"key":"string"},"forUserId":"string"}'

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

import requests url = "https://app.bitgo-test.com/api/document-service/v1/documents" payload = {,"documentType":"governmentId","subType":"cct","metadata":{"key":"string"},"forUserId":"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)

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