Skip to content
Registration Authority
/
/
/
GET ALL DOCUMENTS

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

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"
  }
]

APPROVE REQUEST

Request

Approval of a request by a RAO. At this moment the RAO will sign the receipt and the contract.

Path
idstringrequired

The unique identifier of the Request

Bodyapplication/json
usernamestringrequired

The RAO's username

passwordstringrequired

The RAO's password

pinstringrequired

The RAO's PIN

rao_idstringrequired

The RAO's id

langstring

The contract language

curl -i -X POST \
  'https://api.uanataca.com/api/v1/requests/{id}/pl_approve' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "password": "string",
    "pin": "string",
    "rao_id": "string",
    "lang": "string"
  }'

Responses

Successful Response

Bodyapplication/json
secretsobject
requestobject

The JSON object with the information associated to the approved request

Response
application/json
{
  "secrets": {
    "puk": "06092551",
    "enrollment_code": "8N!9xPhB",
    "pin": "76293975",
    "erc": "3706008596"
  },
  "request": {
    "pk": 25319,
    "given_name": "Name",
    "surname_1": "Surname1",
    "surname_2": "Surname2",
    "sex": null,
    "id_document_type": "TIN",
    "id_document_country": "IT",
    "serial_number": "A1111111E",
    "country_name": "ES",
    "citizenship": null,
    "residence": null,
    "organization_email": null,
    "email": "mail@domain",
    "title": null,
    "organization_name": null,
    "organizational_unit_1": null,
    "organizational_unit_2": null,
    "organization_identifier": null,
    "responsible_name": null,
    "responsible_first_surname": null,
    "responsible_second_surname": null,
    "responsible_email": null,
    "responsible_serial": null,
    "responsible_position": null,
    "subscriber_responsible_serial": null,
    "administrative_unit": null,
    "empowerment": null,
    "representation": null,
    "circumstances": null,
    "limit": null,
    "registration": null,
    "process_application": null,
    "entity_owner": null,
    "entity_owner_serial_number": null,
    "description": null,
    "certificate_set": [],
    "profile": "PFSoftAFCiudadano",
    "scratchcard": "5053349",
    "status": "ENROLLREADY",
    "registering_user": { … },
    "approving_user": { … },
    "producing_user": null,
    "registration_authority": 39,
    "secure_element": 0,
    "validity_time": "730",
    "smartcard_sn": null,
    "citizen_tax_number": null,
    "birth_date": null,
    "birth_country": null,
    "birth_city": null,
    "birth_province": null,
    "birth_state": null,
    "birth_district": null,
    "birth_canton": null,
    "id_document_description": null,
    "id_document_issuer": null,
    "organization_rol": null,
    "professional_id_number": null,
    "mobile_phone_number": "+34333333333",
    "fix_phone_number": null,
    "residence_address": null,
    "residence_city": null,
    "residence_province": null,
    "residence_postal_code": null,
    "residence_state": null,
    "residence_district": null,
    "residence_canton": null,
    "organization_tax_number": null,
    "organization_address": null,
    "organization_city": null,
    "organization_province": null,
    "organization_country": null,
    "organization_postal_code": null,
    "organization_state": null,
    "organization_url": null,
    "responsible_legal_level": null,
    "subscriber": null,
    "responsible_legal_documents": null,
    "special_conditions": null,
    "responsible_registry_data": null,
    "approving_rao": { … },
    "producing_rao": null,
    "id_document_number": null
  }
}

eIDAS VideoID

Operations

External VideoID

Operations