The Document Object

šŸ“„ File Upload API

This API allows Members to upload files. These files serve two primary purposes:

  1. As proof of performed ID Verification checks on the Ultimate Beneficial Owner(s) (UBOs) of a Business that is onboarding with Fiat Republic (FR) to become a Linked Business.
  2. As required documentation for Businesses and End Users to enable them for USD-related services.

Members can upload these files directly via an API request or through the Payments Dashboard using one of the following locations:

  • Administration → File Management
  • End Users → [End User Details] → Documents Tab → Upload New File
  • Businesses → [Business Details] → Documents Tab → Upload New File

āš ļø Important: Identity Report

The IDENTITY_VERIFICATION document contains the output from an identity verification check. Please be aware that this report can be generated by various providers.

While Sumsub is a common source, the report could also originate from other services such as Persona, Onfido, or another provider chosen by the Member.


Upload Restrictions

Supported formats:

  • JSON
  • JPEG
  • PDF
  • PNG
  • MP3
  • M4A

Maximum file size:

  • 30 MB for JSON, JPEG, PDF, PNG
  • 70 MB for MP3, M4A

Document Object

AttributeDescriptionFormat/Enum
id
string
Unique identifier of the documente.g. doc_ov8jkx67ny1dbzzzzz
type
string
Type of attached document.
To enable USD, please choose IDENTITY_VERIFICATION
Allowed values are: IDENTITY_VERIFICATION, PASSPORT, CERTIFICATE_OF_INCORPORATION
description
string
A user-defined description for the document.e.g. UBO verification for ABC Corp, Director John Doe
relatedEntityIds
string
IDs of related End User or Business object["eus_p9mnzv0pkoza1ya85o", "biz_ab12cd34ef56gh78ij"]
format
string
The file format of the uploaded document.Allowed formats: JSON, JPEG, PDF, PNG, MP3, M4A
originalName
string
The original filename of the uploaded document.e.g. JohnDoe_UBO_ID_Check_ABC_Corp.pdf
createdAt
integer
Epoch timestamp (in milliseconds) at which the object was created.e.g. 1637593856104