Know Your Business (KYB)

Update KYB Document Status

Update the status of a file after it has been uploaded to the presigned URL. This endpoint is called by the client after successful upload.

patch/api/document-service/v1/documents/{documentId}/files/{fileId}

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/document-service/v1/documents/{documentId}/files/{fileId}
  • Auth
    none declared

Path parameters

documentIdstring uuid required

Unique identifier for the document

fileIdstring required

Unique identifier for the file

Request body

status'uploaded' | 'requiresManualReview' required

File upload status. Use requiresManualReview when the user chooses to submit a previously-rejected file.

triggerLiveScreeningAsyncboolean

When true, triggers async AI live screening on this upload. Defaults to false.

Response

200

idstring required

Unique identifier for the file

view'front' | 'back' | 'full'

View or side of the document file

uploadUrlstring uri required

Presigned URL for file upload (legacy; may be stale post-upload)

status'awaitingUpload' | 'uploaded' | 'accepted' | 'rejected' | 'requiresManualReview' 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.

fileNamestring

Original filename of the uploaded file

rejectionReasonstring

Human-readable reason populated when status is rejected (e.g. illegible scan, wrong document type)

Changes

No operation changes recorded.