Get a company file URL

Returns a short-lived presigned URL for a file stored in Active Storage for
the company (e.g. a KYC document). The attachment is selected by the
required file_name query parameter, which must be one of the company's
allowed attachment keys. The allowed set depends on the company's country:
for Chile (and other non-MX countries) tax_folder, incorporation_document,
registration_certificate, power_structure, rut_certificate,
plh_contract_file, plh_kyc_file, plh_alliance_file,
plh_contract_file_signed, plh_kyc_file_signed, plh_alliance_file_signed;
for Mexico (MX) incorporation_document, address_file, cif_file,
majority_ownership_incorporation_file.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Query Params
string
enum
required

Attachment key whose presigned URL is requested. Must be one of the
company's allowed attachment keys (country-dependent, see above).

Headers
uuid
required

UUID of the company on whose behalf the request is made. Required for every Organization endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized

404

Company not found

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json