Skip to main content
POST
Issue a presigned PUT URL to upload a review photo to R2

Authorizations

Authorization
string
header
default:sk_test_DEMO0000_replace_with_your_sandbox_key
required

API key authentication. Issued by the Safariat admin or via the partner portal. The secret is shown only once at generation.

Production sk_live_* keys must additionally sign every write request (POST/PUT/DELETE) with the X-Timestamp and X-Signature headers. Sandbox sk_test_* keys are exempt from request signing: X-Signature and X-Timestamp are not required for writes in the sandbox (so the developer-portal "Try it" playground works end to end). The Idempotency-Key header remains required on writes in both environments.

Headers

Idempotency-Key
string
required

Opaque, client-generated string unique per logical operation (a UUID v4 is recommended but any non-blank value up to 255 chars is accepted). Same key + same body = the cached response is returned with the Idempotent-Replayed: true header. Same key + different body = 409 Conflict. Retained for 24 h.

Maximum string length: 255
X-Timestamp
integer<int64>
required

Unix timestamp in seconds at the time the request is issued. Validity window ±5 minutes — beyond that the request is rejected. Required for production sk_live_* keys only; not required for sandbox sk_test_* keys.

X-Signature
string
required

hex(HMAC_SHA256(secret, "{X-Timestamp}\n{METHOD}\n{path}\n{body}")). The path includes the query string. The body is the exact JSON representation sent — any reformatting invalidates the signature. Required for production sk_live_* keys only; not required for sandbox sk_test_* keys.

Pattern: ^[a-f0-9]{64}$

Body

application/json
content_type
enum<string>
required
Available options:
image/jpeg,
image/png,
image/webp
Example:

"image/jpeg"

file_name
string
required

Original filename from the user's device. Used only for logging and extension hinting — Safariat generates a UUID-based key on R2.

Maximum string length: 255
Example:

"dunes-sunset.jpg"

expected_size
integer<int64>
required

File size in bytes. Capped at 10 MB.

Required range: 1 <= x <= 10485760
Example:

256000

Response

Presigned upload ticket issued

put_url
string<uri>
required

Presigned PUT URL on R2. The bank MUST PUT the binary directly to this URL with the same Content-Type header as the one used to issue the ticket.

public_url
string<uri>
required

Canonical public URL of the file once uploaded. Include this in POST /reviews.photo_urls to attach the photo to a review.

content_type
enum<string>
required
Available options:
image/jpeg,
image/png,
image/webp
max_bytes
integer<int64>
required

Echoed cap (10 MB).

expires_at
string<date-time>
required

After this instant the put_url is no longer accepted by R2.