PATCH

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.

Path Params

documentId string uuid required

Unique identifier for the document
fileId string required

Unique identifier for the file

Body Params

object

Request body for updating file status

status string enum required

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

uploadedrequiresManualReview
triggerLiveScreeningAsync boolean

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

Responses

200

Response Body

object

Response after updating file status

id string required

Unique identifier for the file
view string enum

View or side of the document file

frontbackfull
uploadUrl string uri required

Presigned URL for file upload (legacy; may be stale post-upload)
status string enum 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.

awaitingUploaduploadedacceptedrejectedrequiresManualReview
fileName string

Original filename of the uploaded file
rejectionReason string

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

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

403

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

404

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 PATCH \ --url 'https://app.bitgo-test.com/api/document-service/v1/documents/documentId/files/fileId' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"status":"uploaded","triggerLiveScreeningAsync":true}'

const url = 'https://app.bitgo-test.com/api/document-service/v1/documents/documentId/files/fileId'; const options = { method: 'PATCH', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"status":"uploaded","triggerLiveScreeningAsync":true}) }; 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/documentId/files/fileId") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"status":"uploaded","triggerLiveScreeningAsync":true}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('PATCH', 'https://app.bitgo-test.com/api/document-service/v1/documents/documentId/files/fileId', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"status":"uploaded","triggerLiveScreeningAsync":true}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/document-service/v1/documents/documentId/files/fileId" payload = {,"status":"uploaded","triggerLiveScreeningAsync":true} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.text)