Skip to main content
POST
/
v2
/
users
/
{userId}
/
kyc
/
documents
/
{documentId}
Update a document
curl --request POST \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc/documents/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "issuedCountry": "<string>",
  "issuedDate": "2023-12-25",
  "expiryDate": "2023-12-25",
  "number": "<string>",
  "description": "<string>",
  "url": "<string>",
  "fileId": "<string>"
}'
{
  "id": "d9f38450-ec16-4a4b-bf69-f8c88bb73a94",
  "type": "PASSPORT",
  "subType": "SINGLE_SIDE",
  "issuedCountry": "USA",
  "issuedDate": null,
  "expiryDate": null,
  "number": null,
  "description": null,
  "url": "https://example.com/doc_123",
  "fileId": "file_zEFpbPhk71NaQfEVMR544"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
userId
string
required

ID of the user

​
documentId
string
required

The ID of the document.

Body

application/json
  • Update Individual Document
  • Update Business Document
​
issuedCountry
string

Three-letter alpha-3 country code as defined in the ISO 3166-1 spec.

​
issuedDate
string<date>

Date of issue of the document.

​
expiryDate
string<date>

Expiry date of the document.

​
number
string

If applicable, unique identification number of the document.

​
description
string

Description of the document. Required if type is OTHER.

​
url
string
deprecated

URL of the document. Either url or fileId is required, but not both.

*Maximum file size 10MB and minimum file size 10KB

*Valid file types: .pdf, .jpeg, .jpg, .png, .heic, .tif

​
fileId
string

The file ID returned from the file upload endpoint. Either url or fileId is required, but not both.

Response

Success

​
type
string
​
subType
string
​
issuedCountry
string
​
issuedDate
string<date>
​
expiryDate
string<date>
​
number
string
​
description
string
​
url
string
deprecated
​
fileId
string
​
uboId
string
⌘I