CAcardda
Company membership

Get a membership file URL

Returns a short-lived presigned URL for a file stored in Active Storage for the membership (e.g. an identification or powers document). The attachment is selected by the required file_name query parameter, which must be one of the membership's allowed attachment keys: identification_file, power_file, pep_file, pep_file_template.

get/v1/company_memberships/{id}/file

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/company_memberships/{id}/file
  • Auth
    HTTP bearer

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'identification_file' | 'power_file' | 'pep_file' | 'pep_file_template' required

Attachment key whose presigned URL is requested.

Parameters

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

Response

Presigned URL for the requested file.

urlstring uri

Changes

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