Upload Images

POST 
/v1/partner/bookings/:booking_id/images

Allows uploading images associated with a booking, such as insurance cards or photo IDs. Requires 'write:bookings' scope. Supports various image types for comprehensive patient documentation. The image field must be a base64-encoded image. Only single file uploads are allowed, and the image should be appropriately encoded to ensure a valid upload. Accepts the below image_type values: photo_id_front photo_id_back insurance_card_front insurance_card_back.

Token scope:

{'scope': 'write:bookings'}

Request

Path Parameters

booking_id Booking Idrequired

The unique identifier of the booking to which the image will be uploaded.

application/json

Body

required

image Imagerequired
image_type Image Type (string)

The type of image being uploaded. Must be one of the values defined in the ImageTypes schema

Responses

200

Successful Response

application/json

Schema

Schema

booking_id Booking Id (integer)required
image_id Image Id (integer)required
image_type Image Type (string)required

Example (from schema)

{
  "booking_id": 0,
  "image_id": 0,
  "image_type": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...