Skip to main content
POST
/
v2
/
users
/
{userId}
/
kyc
/
documents
Add documents
curl --request POST \
  --url https://production.hifibridge.com/v2/users/{userId}/kyc/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "type": "DRIVERS",
    "subType": "FRONT_SIDE",
    "issuedCountry": "<string>",
    "issuedDate": "2023-12-25",
    "expiryDate": "2023-12-25",
    "number": "<string>",
    "description": "<string>",
    "url": "<string>",
    "fileId": "<string>",
    "uboId": "<string>"
  }
]'
{
  "count": 2,
  "data": [
    {
      "id": "7c9439f6-655b-4aeb-9b32-e17759ee9134",
      "type": "CERTIFICATE_OF_INCORPORATION",
      "subType": "SINGLE_SIDE",
      "issuedCountry": "USA",
      "issuedDate": null,
      "expiryDate": null,
      "number": null,
      "description": null,
      "url": "https://example.com/doc_123",
      "fileId": "file_zEFpbPhk71NaQfEVMR544",
      "uboId": null
    },
    {
      "id": "7a9dc485-3216-47fd-baa4-a7ab4085b723",
      "type": "PASSPORT",
      "subType": "SINGLE_SIDE",
      "issuedCountry": "USA",
      "issuedDate": null,
      "expiryDate": null,
      "number": null,
      "description": null,
      "url": "https://example.com/doc_123",
      "fileId": "file_zEFpbPhk71NaQfEVMR544",
      "uboId": "3285c3be-ef36-4f01-bf95-578d3116f0ff"
    }
  ]
}

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

Body

application/json
  • Add Individual Document · object[]
  • Add Business Document · object[]

An array of documents to be added.

​
type
enum<string>
required

Type of the document. This field is immutable once created.

Available options:
DRIVERS,
ID_CARD,
PASSPORT,
INCOME_SOURCE,
INVESTOR_DOC,
PAYMENT_SOURCE,
RESIDENCE_PERMIT,
SELFIE,
PROOF_OF_ADDRESS,
AUTH_LETTER,
OTHER
​
subType
enum<string>
required

Subtype of the document. This field is immutable once created.

Available options:
FRONT_SIDE,
BACK_SIDE,
SINGLE_SIDE
​
issuedCountry
string
required

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.

​
uboId
string

If provided, this document will be attached to the specified UBO. This field is immutable once created.

Response

Success

​
count
integer

Number of documents.

​
data
Document Object · object[]
⌘I