# SignBox API

For testing purposes, Uanataca provides integrators of a pre-configured test-mode SignBox Optimizer accessible at the following URL: `https://optimizer-developers.uanataca.com`

For more information about the sandbox environment click here. [UANATACA SIGNBOX API Sandbox](https://namirial.atlassian.net/wiki/spaces/BES/pages/276856895/UANATACA+SIGNBOX+API#Sandbox-Environment)


Version: 1.0.0

## Servers

```
/signbox
```

## Download OpenAPI description

[SignBox API](https://docs.namirial.app/_bundle/products/namirialpkiaas/signbox/openapi.yaml)

## Signature

### Echo

 - [GET /api/v1/echo](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/signature/echo_api_v1_echo_get.md): Replies back what it receives to check the service availability.

### Sign

 - [POST /api/v1/sign](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/signature/sign_api_v1_sign_post.md): Signs the submitted file.

### Otp

 - [POST /api/v1/otp](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/signature/otp_api_v1_otp_post.md): Generates an otp for the specified digital identity.

### Open Session

 - [POST /api/v1/open_session](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/signature/open_session_api_v1_open_session_post.md): Open a signature session for the specified digital identity.

### Close Session

 - [POST /api/v1/close_session](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/signature/close_session_api_v1_close_session_post.md): Close the specified signature session.

## Images

### Upload Image

 - [POST /api/v1/image](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/images/call_upload_image_api_v1_image_post.md): Uploads an image for using in a visual graphic signature.

### Call Get Image

 - [GET /api/v1/image/{image_uid}](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/images/call_get_image_api_v1_image__image_uid__get.md): Retrieves a previously uploaded image.

### Call Delete Image

 - [DELETE /api/v1/image/{image_uid}](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/images/call_delete_image_api_v1_image__image_uid__delete.md): Deletes a previously uploaded image.

### Call Get Images

 - [GET /api/v1/images](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/images/call_list_images_api_v1_images_get.md): Lists all uploaded images.

### Call Delete Images

 - [DELETE /api/v1/images](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/images/call_delete_images_api_v1_images_delete.md): Deletes all uploaded images.

## Tokens

### Call Create Token

 - [POST /api/v1/token](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/tokens/call_create_token_api_v1_token_post.md): Creates a new token that contains the Registration Authority Officer (RAO) credentials

### Call Get Token

 - [GET /api/v1/token/{token_uid}](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/tokens/call_get_token_api_v1_token__token_uid__get.md): 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.

### Call Delete Token

 - [DELETE /api/v1/token/{token_uid}](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/tokens/call_delete_token_api_v1_token__token_uid__delete.md): Deletes the token with the specified unique identifier.

### Call List Tokens

 - [GET /api/v1/tokens](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/tokens/call_list_tokens_api_v1_tokens_get.md): Returns a list of all tokens available and their associated data.

## Troubleshooting

### Job

 - [GET /api/v1/job/{jobid}](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/troubleshooting/job_api_v1_job__jobid__get.md): Get job status

### Result

 - [GET /api/v1/result/{jobid}](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/troubleshooting/result_api_v1_result__jobid__get.md): Get job result

## Timestamp

### Timestamp

 - [POST /api/v1/timestamp](https://docs.namirial.app/products/namirialpkiaas/signbox/openapi/timestamp/timestamp_api_v1_timestamp_post.md): Timestamps the submitted file