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

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

Call Create Token

Request

Creates a new token that contains the Registration Authority Officer (RAO) credentials.

Bodyapplication/jsonrequired
usernamestring(Username)required

The RAO's digital identity username

passwordstring(Password)

The RAO's digital identity password. If not included in this call, must be included in calls that require RAO's credentials

pinstring(Pin)

The RAO's digital identity PIN. If not included in this call, must be included in calls that require RAO's credentials

envstring(Env)

The API work environment. (sandbox / prod)

curl -i -X POST \
  https://optimizer-developers.uanataca.com/oneshot/api/v1/api/v1/token \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "password": "string",
    "pin": "string",
    "env": "string"
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "Token created",
  "details": {
    "token_uid": "14185cd9-c6ec-30f4-9f59-a844a77bc234"
  }
}

Call Get Token

Request

Retrieves the token associated credentials with the given unique identifier. The response gets a true or false value regarding if password and PIN parameters are associated to the token.

Path
token_uidany(Token Uid)required

The token unique identifier

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

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "details": {
    "username": "2626807",
    "password": "true",
    "pin": "true",
    "rao_id": "1182",
    "env": "xxx"
  }
}

Call Delete Token

Request

Deletes the token with the specified unique identifier.

Path
token_uidany(Token Uid)required

The token unique identifier

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

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "message": "Token 0112c943-87a3-4fdf-b12g-d95233e973b5 deleted successfully"
}

Call List Tokens

Request

Returns a list of all tokens available and their associated data.

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

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{
  "status": "success",
  "detail": {
    "6d1cae4d55be4cdf9cac50ee36f73406": { … }
  }
}

Requests

Endpoints to manage the signature requests

Operations

Documents

Endpoints to manage the documents

Operations

Images

Endpoints to manage the images

Operations

Video ID

Endpoints to manage the Video ID

Operations