Skip to content
One-Shot
/
Enterprise Documentation
/
/Images

Oneshot API (1.0.0)

One-Shot API for single-use certificate electronic signatures. All endpoints are relative to the base path /oneshot/api/v1.

For the public testing environment (sandbox URL, RAO token, prerequisites, and how to use the test Optimizer), see the Get started guide in the One-Shot documentation: Get started with One-Shot.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Public testing environment

https://optimizer-developers.uanataca.com/oneshot/api/v1/

Settings

Endpoints to manage the service settings

Operations

Tokens

Endpoints to manage the tokens

Operations

Requests

Endpoints to manage the signature requests

Operations

Documents

Endpoints to manage the documents

Operations

Images

Endpoints to manage the images

Operations

Call Upload Image

Request

Uploads an image for using in a visual graphic signature.

Bodymultipart/form-datarequired
imageArray of arrays(Image)required

The image to add in the visual graphic signature in PNG format

curl -i -X POST \
  https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/image \
  -H 'Content-Type: multipart/form-data'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "Image uploaded with uid '463156ce-d566-44d2-94e9-184d89632b98'",
  "details": {
    "image_uid": "463156ce-d566-44d2-94e9-184d89632b98"
  }
}

Call Get Image

Request

Retrieves a previously uploaded image.

Path
image_uidany(Image Uid)required

The image unique identifier

curl -i -X GET \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/image/{image_uid}'

Responses

Successful Response

Bodyimage/png
any
Response
image/png
The retrieved image in png format

Call Delete Image

Request

Deletes a previously uploaded image.

Path
image_uidany(Image Uid)required

The image unique identifier

curl -i -X DELETE \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/image/{image_uid}'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "Image c4cb5944-463156ce-d566-44d2-94e9-184d89632b98 deleted"
}

Call Get Images

Request

Lists all uploaded images.

curl -i -X GET \
  https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/images

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "details": {
    "aef3f74c-0f39-408f-8f54-657bd71d6d3a": { … },
    "93868edb-561d-4439-a56d-79f2a8c32087": { … }
  }
}

Call Delete Images

Request

Deletes all uploaded images.

curl -i -X DELETE \
  https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/images

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "All Images deleted"
}

Video ID

Endpoints to manage the Video ID

Operations