Sign in
Know Your Business (KYB)

Update KYB Document

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

put/api/identity-service/v1/identities/{identityId}/documents/{identityDocumentId}

Path parameters

identityIdstring uuid required

The unique ID of the identity

identityDocumentIdstring uuid required

The unique ID of the document association

Request body

documentIdstring uuid

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

documentType'governmentId' | 'commercialRegister' | 'articlesOfAssociation' | 'certificateOfIncorporation' | 'certificateOfGoodStanding' | 'certificateOfTrust' | 'certificateOfIncumbency' | 'certificateOfIncumbencyOrShareRegister' | 'proofOfPrincipalPlaceOfBusiness' | 'activeTradeLicense' | 'resolutionToOpenBitgoUaeAccount' | 'resolutionToOpenBitgoSingaporeAccount' | 'proofOfAuthorizedSignatories' | 'memorandumOfAssociation' | 'memorandumAndArticlesOfAssociation' | 'bylawsOrOperatingAgreement' | 'operatingAgreement' | 'w8' | 'w9' | 'evidenceOfLegalStatus' | 'evidenceOfActiveStatus' | 'proofOfJfsaLicense' | 'proofOfGamingLicense' | 'organizationDocument' | 'partnershipAgreement' | 'articlesOfOrganization' | 'businessLicenseOrRegistration' | 'evidenceOfGovernmentOrStateOwnership' | 'secFilingsAsEvidenceOfPublicTradingStatus' | 'foundingTreatyOrEquivalent' | 'proofOfAddress' | 'sourceOfWealth' | 'singaporeSupportingDocument' | 'caseRequiredDocuments' | 'correspondentAccountCertification' | 'authorizedSignerForm'

Type of document being uploaded

documentSubTypestring

Updated sub-classification within the document type.

Response

200

idstring required

Internal ID for the document association

documentIdstring required

External document service ID

documentType'governmentId' | 'commercialRegister' | 'articlesOfAssociation' | 'certificateOfIncorporation' | 'certificateOfGoodStanding' | 'certificateOfTrust' | 'certificateOfIncumbency' | 'certificateOfIncumbencyOrShareRegister' | 'proofOfPrincipalPlaceOfBusiness' | 'activeTradeLicense' | 'resolutionToOpenBitgoUaeAccount' | 'resolutionToOpenBitgoSingaporeAccount' | 'proofOfAuthorizedSignatories' | 'memorandumOfAssociation' | 'memorandumAndArticlesOfAssociation' | 'bylawsOrOperatingAgreement' | 'operatingAgreement' | 'w8' | 'w9' | 'evidenceOfLegalStatus' | 'evidenceOfActiveStatus' | 'proofOfJfsaLicense' | 'proofOfGamingLicense' | 'organizationDocument' | 'partnershipAgreement' | 'articlesOfOrganization' | 'businessLicenseOrRegistration' | 'evidenceOfGovernmentOrStateOwnership' | 'secFilingsAsEvidenceOfPublicTradingStatus' | 'foundingTreatyOrEquivalent' | 'proofOfAddress' | 'sourceOfWealth' | 'singaporeSupportingDocument' | 'caseRequiredDocuments' | 'correspondentAccountCertification' | 'authorizedSignerForm' required

Type of document being uploaded

documentSubTypestring nullable

Sub-classification within a document type (e.g., Singapore supporting document subtype).

status'missing' | 'countExceeded' | 'submitted' | 'inReview' | 'verified' required

Verification status

createdAtstring required

ISO timestamp when document was associated

updatedAtstring required

ISO timestamp when association was last updated

Changes

Changed in 1 of the 19 revisions of this API.79

  • 70b5f74b179979See the full diff
    • ●

      added the new authorizedSignerForm enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new caseRequiredDocuments enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new certificateOfGoodStanding enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new correspondentAccountCertification enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new proofOfAddress enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new singaporeSupportingDocument enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new sourceOfWealth enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new authorizedSignerForm enum value to the request property

      request-property-enum-value-added

    • ○

      added the new caseRequiredDocuments enum value to the request property

      request-property-enum-value-added

    • ○

      added the new certificateOfGoodStanding enum value to the request property

      request-property-enum-value-added

    • ○

      added the new correspondentAccountCertification enum value to the request property

      request-property-enum-value-added

    • ○

      added the new proofOfAddress enum value to the request property

      request-property-enum-value-added

    • ○

      added the new singaporeSupportingDocument enum value to the request property

      request-property-enum-value-added

    • ○

      added the new sourceOfWealth enum value to the request property

      request-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added