# Oneshot API 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](enterprise-documentation/get-started/get-started.md). Version: 1.0.0 ## Servers Public testing environment ``` https://optimizer-developers.uanataca.com/oneshot/api/v1 ``` ## Download OpenAPI description [Oneshot API](https://docs.namirial.app/_bundle/products/namirialpkiaas/one-shot/openapi.yaml) ## Settings Endpoints to manage the service settings ### Call Hello - [GET /api/v1/hello](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/settings/call_hello_api_v1_hello_get.md): Checks if server is UP. ### Call Get Version - [GET /api/v1/version](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/settings/call_get_version_api_v1_version_get.md): Retrieves the current Optimizer version. ## Tokens Endpoints to manage the tokens ### Call Create Token - [POST /api/v1/token](https://docs.namirial.app/products/namirialpkiaas/one-shot/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/one-shot/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/one-shot/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/one-shot/openapi/tokens/call_list_tokens_api_v1_tokens_get.md): Returns a list of all tokens available and their associated data. ## Requests Endpoints to manage the signature requests ### Call Create - [POST /api/v1/create](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/requests/call_create_api_v1_create_post.md): Creates a new digital signature request for the user identified. ### Call Get Request - [GET /api/v1/request/{request_pk}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/requests/call_get_request_api_v1_request__request_pk__get.md): Retrieve request information with the id obtained in the CREATE REQUEST response. ### Call Delete Request - [DELETE /api/v1/request/{request_pk}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/requests/call_delete_request_api_v1_request__request_pk__delete.md): Cancels the Video ID One-Shot Signature request ### Call Update Request - [PUT /api/v1/request/{request_pk}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/requests/call_update_request_api_v1_request__request_pk__put.md): Updates a Video ID signature request. ### Call Get Request Contract - [GET /api/v1/contract/{request_pk}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/requests/call_get_request_contract_api_v1_contract__request_pk__get.md): Get Request contract. ### Call Generate Otp - [POST /api/v1/otp/{request_pk}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/requests/call_generate_otp_api_v1_otp__request_pk__post.md): Generates a One-Time Password (OTP) code for the user. The OTP is sent directly to the user's mobile phone as an SMS message. > This method is only required and available for requests using Uanataca SMS method ### Call Sign - [POST /api/v1/sign/{request_pk}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/requests/call_sign_api_v1_sign__request_pk__post.md): Sign documents assigned to specific Request ## Documents Endpoints to manage the documents ### Call Upload Document - [POST /api/v1/document/{request_pk}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/documents/call_upload_document_api_v1_document__request_pk__post.md): Upload a document and associate it to a Request ### Call Delete Documents - [DELETE /api/v1/document/{request_pk}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/documents/call_delete_documents_api_v1_document__request_pk___delete.md): Delete all documents ### Call Get Document - [GET /api/v1/document/{request_pk}/{document_uid}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/documents/call_get_document_api_v1_document__request_pk___document_uid__get.md): Retrieve a document associated to specific Request ### Call Delete Document - [DELETE /api/v1/document/{request_pk}/{document_uid}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/documents/call_delete_document_api_v1_document__request_pk___document_uid__delete.md): Delete a document associated to a specific Request ### Call List Documents - [GET /api/v1/documents/{request_pk}](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/documents/call_list_documents_api_v1_documents__request_pk__get.md): List of documents associated to a specific Request ## Images Endpoints to manage the images ### Call Upload Image - [POST /api/v1/image](https://docs.namirial.app/products/namirialpkiaas/one-shot/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/one-shot/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/one-shot/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/one-shot/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/one-shot/openapi/images/call_delete_images_api_v1_images_delete.md): Deletes all uploaded images. ## Video ID Endpoints to manage the Video ID ### Call Create Videoid - [POST /api/v1/videoid](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/video-id/call_create_videoid_api_v1_videoid_post.md): Create a VideoID ### Call Validate Videoid - [POST /api/v1/videoid/{videoid_pk}/validate](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/video-id/call_validate_videoid_api_v1_videoid__videoid_pk__validate_post.md): Validate a VideoID ### Call Approve Videoid - [POST /api/v1/videoid/{videoid_pk}/approve](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/video-id/call_approve_videoid_api_v1_videoid__videoid_pk__approve_post.md): Approve a VideoID ### Call Refuse Videoid - [POST /api/v1/videoid/{videoid_pk}/refuse](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/video-id/call_refuse_videoid_api_v1_videoid__videoid_pk__refuse_post.md): Refuse a VideoID ### Call Upload Videoid Evidences - [POST /api/v1/videoid/{videoid_pk}/evidences](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/video-id/call_upload_videoid_evidences_api_v1_videoid__videoid_pk__evidences_post.md): Upload evidences for a VideoID ### Call Upload Videoid Video - [POST /api/v1/videoid/{videoid_pk}/video](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/video-id/call_upload_videoid_video_api_v1_videoid__videoid_pk__video_post.md): Upload video for a VideoID ### Call Download Videoid Video - [GET /api/v1/videoid/{videoid_pk}/video](https://docs.namirial.app/products/namirialpkiaas/one-shot/openapi/video-id/call_download_videoid_video_api_v1_videoid__videoid_pk__video_get.md): Download VideoID video