> ## Documentation Index
> Fetch the complete documentation index at: https://docs.slate.inc/llms.txt
> Use this file to discover all available pages before exploring further.

# Request an image upload URL

> Request a presigned upload URL and a freshly generated key for the user's signature
or notary seal image. Each request produces a new key, so uploads never overwrite a
previous image. Upload the image to the returned URL first, then save the profile via
PUT /v1/users/{userId} (passing the returned key as signatureKey / notarySealKey) to store
the reference. Allowed for the user themselves or a caller with the manage permission.




## OpenAPI

````yaml /api-reference/users/openapi.yaml post /v1/users/{userId}/images
openapi: 3.0.0
info:
  title: Users API
  description: >-
    Manage user profiles and their signature and notary seal images. Supports
    listing users for an owner, retrieving and updating individual profiles, and
    requesting upload URLs for user images.
  version: 1.0.0
  contact:
    name: Slate API Support
    email: api-support@slate.inc
    url: https://slate.inc
servers:
  - url: https://api.slate.inc/users
    description: Production
  - url: https://api.uat.slate.inc/users
    description: UAT (staging)
security:
  - bearerAuth: []
paths:
  /v1/users/{userId}/images:
    post:
      summary: Request an image upload URL
      description: >
        Request a presigned upload URL and a freshly generated key for the
        user's signature

        or notary seal image. Each request produces a new key, so uploads never
        overwrite a

        previous image. Upload the image to the returned URL first, then save
        the profile via

        PUT /v1/users/{userId} (passing the returned key as signatureKey /
        notarySealKey) to store

        the reference. Allowed for the user themselves or a caller with the
        manage permission.
      operationId: postV1UserImages
      parameters:
        - in: path
          name: userId
          required: true
          description: The user's unique ID.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageUploadRequest'
      responses:
        '200':
          description: The presigned upload URL and key for the image.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageUpload'
        '400':
          description: Invalid request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid, or insufficient credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ImageUploadRequest:
      type: object
      required:
        - type
        - filename
      description: Requests a presigned upload URL for one of the user's images.
      properties:
        type:
          type: string
          enum:
            - signature
            - notary_seal
          description: The image type to upload.
        filename:
          type: string
          description: >-
            Original filename of the image; its extension determines the
            extension of the generated key.
    ImageUpload:
      type: object
      required:
        - type
        - url
        - key
      properties:
        type:
          type: string
          description: The image type, either "signature" or "notary_seal".
        url:
          type: string
          description: A presigned upload (PUT) URL for the image.
        key:
          type: string
          description: >-
            The generated key the upload is stored under. Pass it as
            signatureKey / notarySealKey when saving the profile so the saved
            profile references this upload.
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          description: A human-readable error message.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cognito-issued JWT access token. Send it as `Authorization: Bearer
        <token>`.

````