Sign in
Company

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.

get/v1/companies/{id}/file

Path parameters

idstring 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 parameters

file_name'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' | 'address_file' | 'cif_file' | 'majority_ownership_incorporation_file' required

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

Parameters

#/paths/~1v1~1users/get/parameters/0 — unresolved $ref

Response

Presigned URL for the requested file.

urlstring uri

Changes

No recorded changes to this endpoint across all 1 revision of this API.