CAcardda
User

Get a user file URL

Returns a short-lived presigned URL for a file stored in Active Storage for the user (e.g. their identification document). Access is gated by the user file policy (the user themselves, or admins / companies_manage). The specific attachment is selected by the attachment query parameter.

get/v1/users/{id}/file

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/users/{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

attachmentstring

Name/identifier of the attachment 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.