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

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

Call Upload Document

Request

Upload a document and associate it to a Request

Path
request_pkinteger(The ID of the Request to which associated the document)required

The ID of the Request to which associated the document

curl -i -X POST \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/document/{request_pk}'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "detail": {
    "name": "file",
    "uid": "604b889f-6b3a-4af7-a24a-b5e610e7f7c1"
  }
}

Call Delete Documents

Request

Delete all documents

Path
request_pkinteger(The ID of the Request to which the document is associated)required

The ID of the Request to which the document is associated

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

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "Documents deleted for Request xxx"
}

Call Get Document

Request

Retrieve a document associated to specific Request

Path
request_pkinteger(The ID of the Request to which the document is associated)required

The ID of the Request to which the document is associated

document_uidstring(Document Uid)required
Query
document_typeDocument Type (string) or Document Type (null)(Document Type)
Default "original"
Any of:
string(Document Type)
Default "original"
curl -i -X GET \
  'https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/document/{request_pk}/{document_uid}?document_type=original'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
"The retrieved image"

Call Delete Document

Request

Delete a document associated to a specific Request

Path
request_pkinteger(The ID of the Request to which the document is associated)required

The ID of the Request to which the document is associated

document_uidstring(Document Uid)required

The document unique identifier

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

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "Document 604b889f-6b3a-4af7-a24a-b5e610e7f7c1 deleted"
}

Call List Documents

Request

List of documents associated to a specific Request

Path
request_pkinteger(The ID of the Request)required

The ID of the Request

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

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "detail": {
    "b40aa3a6-6e2b-421e-8759-5f7717b35b1a": { … }
  }
}

Images

Endpoints to manage the images

Operations

Video ID

Endpoints to manage the Video ID

Operations