API Reference

Get a user file URL

get
https://api.cardda.com/v1/users//file

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.

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

Name/identifier of the attachment whose presigned URL is requested.

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

User or attachment not found

Updated 4 days ago

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

Updated 4 days ago

Did this page help you?