Skip to content
Registration Authority
/
/
/
GET A DOCUMENT

UANATACA RA API DOCUMENTATION (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://api.uanataca.com/

Registration Authority

Operations

Registration Authority Officer

Operations

Users

Operations

Scratchcards

Operations

Requests

Operations

DELETE DOCUMENT

Request

Delete an identification document previously uploaded.

Path
idstringrequired

The unique identifier of the Request

Bodymultipart/form-datarequired
docpkstringrequired

The database primary key of the document to be deleted

curl -i -X POST \
  'https://api.uanataca.com/api/v1/requests/{id}/pl_delete_document' \
  -H 'Content-Type: multipart/form-data' \
  -F docpk=string

Responses

Successful Response

Bodyapplication/json
statusstring

The successful response status message

Response
application/json
{
  "status": "Document deleted successfully"
}

GET A DOCUMENT

Request

Retrieves a request's associated document in Base64 format.

Path
idstringrequired

The unique identifier of the Request

Bodymultipart/form-datarequired
typestringrequired

The type of the document to be retrieved

Enum"document_front""document_rear""document_owner""extra_document""contract""signed_contract"
rao_idstringrequired

The rao id number. This field is required only if request status is CREATED or VIDEOREVIEW

curl -i -X POST \
  'https://api.uanataca.com/api/v1/requests/{id}/pl_get_document' \
  -H 'Content-Type: multipart/form-data' \
  -F type=document_front \
  -F rao_id=string

Responses

Successful Response

Bodyapplication/json
pkstring

The request id

documentstring

The document content in Base64 format

typestring

The document type

Response
application/json
{
  "document": "iVBORw0KGgoAAAANSUhEUgAAAPwAAAChCAYAAAGUvOLYAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAABU9xJREFUeNqMlmuMXGUZx3/nfmZ257bX7m53t91uKbS1Ak0kIFIwIZHUSP0kBmLiJSIWXa3SBE1TkaZaU2liQFObED9QE0M(...)",
  "type": "contract"
}

GET ALL DOCUMENTS

Request

Retrieves all uploaded documents associated to a request.

Path
idstringrequired

The unique identifier of the Request

curl -i -X GET \
  'https://api.uanataca.com/api/v1/requests/{id}/pl_get_documents'

Responses

Successful Response

Bodyapplication/json
pkstring

The document database id

documentstring

The document content in Base64 format

typestring

The document type

Response
application/json
[
  {
    "pk": 48312,
    "document": "iVBORw0KGgoAAAANSUhEUgAAAPwAAAChCAYAAAGUvOLYAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAABU9xJREFUeNqMlmuMXGUZx3/nfmZ257bX7m53t91uKbS1Ak0kIFIwIZHUSP0kBmLiJSIWXa3SBE1TkaZaU2liQFObED9QE0M(...)",
    "type": "document_front"
  },
  {
    "pk": 48320,
    "document": "7m53t91uKbS1Ak0kIFIwIZHUSP0kBmLiJiVBORw0KGgoAAAANSUhEUgAAAPwTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAABU9xJREFUeNqAAAChCAYAAAGUvOLYAAAAGXRFWHRMlmuMXGUZx3/nfmZ257bXSIWXa3SBE1TkaZaU2liQFObED9QE0M(...)",
    "type": "document_rear"
  },
  {
    "pk": 48321,
    "document": "ANSUhEUgAAAPwTb2Z0d27m53t91uREFUeNqAAACwIZHUSP0kBmLiJiVBORw0KGgoAAAFyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAABU9xJhCAYAAAGU7bXSIWXa3SBE1TkaZaU2DDKxk89fogpvOLYAAAAGXRFWHRMlmuMXGUZx3/nfmZ25liQFObED9QE0M(...)",
    "type": "signed_contract"
  }
]

eIDAS VideoID

Operations

External VideoID

Operations