Get pre-signed upload URL for onboarding assets

POST /api/v1/onboarding/upload-url

Returns a pre-signed S3 PUT URL for uploading a firm logo during onboarding (no business context required).

Operation ID: get_onboarding_upload_url_api_v1_onboarding_upload_url_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: OnboardingUploadUrlRequest

filename string required
content_type string

Responses

201 Successful Response

Schema: OnboardingUploadUrlResponse

upload_url string required
s3_key string required

400 Bad Request - Invalid input

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

429 Too Many Requests - Rate limit exceeded

Code samples

POST /api/v1/onboarding/upload-url

bash

curl -X POST 'https://api.ondayzero.com/api/v1/onboarding/upload-url' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "filename": "string"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/onboarding/upload-url', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "filename": "string"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "filename": "string"
}

response = httpx.post("https://api.ondayzero.com/api/v1/onboarding/upload-url", headers=headers, json=payload)
data = response.json()