Skip to content
Registration Authority
/
/
/
VALIDATE VIDEO ID REQUEST

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

eIDAS VideoID

Operations

External VideoID

Operations

VALIDATE VIDEO ID REQUEST

Request

Validation of a Video ID Request

Path
id_requeststringrequired

The Request unique identifier

Bodyapplication/json
usernamestringrequired

The RAO's username

passwordstringrequired

The RAO's password

pinstringrequired

The RAO's pin

rao_idstringrequired

The RAO's id

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

Responses

Successful Response

Bodyapplication/json
object

The JSON object with full information associated to the approved request

Response
application/json
{
  "secrets": {
    "puk": "38812452",
    "enrollment_code": ".R4P9qgA",
    "pin": "31945152",
    "erc": "3417062505"
  },
  "request": {
    "pk": 45013,
    "given_name": "Name",
    "surname_1": "Surname1",
    "surname_2": "Surname2",
    "sex": null,
    "id_document_type": "IDC",
    "id_document_country": "ES",
    "serial_number": "A9999999E",
    "country_name": "ES",
    "citizenship": null,
    "residence": null,
    "organization_email": null,
    "email": "name@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": "PFnubeAFCiudadano",
    "scratchcard": "5082518",
    "status": "ENROLLREADY",
    "registering_user": { … },
    "approving_user": { … },
    "producing_user": null,
    "registration_authority": 577,
    "secure_element": 2,
    "validity_time": "365",
    "smartcard_sn": null,
    "citizen_tax_number": null,
    "birth_date": "02/07/1986",
    "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": "+34777777777",
    "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,
    "id_responsible_document_type": null,
    "id_responsible_document_country": null,
    "id_responsible_document_number": null,
    "organizational_unit_3": null,
    "paperless_mode": false,
    "videoid_mode": true,
    "ext_recognition_data": null,
    "complement_number": null,
    "id_responsible_document_issuer": null,
    "provider_registration_number": null,
    "communication_language": "",
    "identification_rao": null,
    "videoid_data": { … }
  }
}

REFUSE REQUEST

Request

Refuse validation for a Video ID Request

Path
id_requeststringrequired

The Request unique identifier

Bodyapplication/json
usernamestringrequired

The RAO's username

passwordstringrequired

The RAO's password

pinstringrequired

The RAO's pin

rao_idstringrequired

The RAO's id

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

Responses

Successful Response

Bodyapplication/json
videoid_statusstring

The request status (REFUSED)

reasonstring

The reason for refusal

Response
application/json
{
  "videoid_status": "REFUSED",
  "reason": "testing the API"
}

UPLOAD DATA EVIDENCE

Request

Upload Request associated data

Path
video_pkstringrequired

The video request pk

Bodyapplication/json
acceptanceobject

A set of acceptance parameters.

⚠ Customizable object for external authentication.

videoid_dataobject

Data to upload for Video ID

⚠ Customizable object for external authentication.

curl -i -X PUT \
  'https://api.uanataca.com/api/v1/videoid/{video_pk}' \
  -H 'Content-Type: application/json' \
  -d '{
    "acceptance": {
      "description": "string",
      "url-doc-privacypolicy": "string",
      "ip": "string",
      "url-web-videoid": "string",
      "user-agent": "string",
      "date": "string",
      "url-doc-termsconditions": "string"
    },
    "videoid_data": {
      "images": {
        "document_front": "string",
        "document_rear": "string",
        "document_photo": "string",
        "document_owner": "string"
      },
      "ocr_data": {
        "given_name": "string",
        "surname_1": "string",
        "surname_2": "string",
        "mobile_phone_number": "string",
        "email": "string",
        "serial_number": "string",
        "id_document_type": "IDC",
        "id_document_country": "string"
      },
      "security_checks": {
        "otp_validation": true,
        "documents_match": true,
        "data_integrity": true,
        "document_notcopy": true,
        "document_notexpired": true,
        "document_notunderage": true,
        "liveliness": true
      },
      "similarity_level": 0
    }
  }'

Responses

Successful Response

Body

UPLOAD VIDEO

Request

Upload Request associated video

Path
video_identifierstringrequired

Unique request video identifier

Bodymultipart/form-datarequired
videostringrequired

The video to be uploaded

curl -i -X POST \
  'https://api.uanataca.com/v1/upload/video/{video_identifier}' \
  -H 'Content-Type: multipart/form-data' \
  -F video=string

Responses

Successful Response

Bodyapplication/json
statusstring

Successful response status message

Response
application/json
{
  "status": "200 OK"
}

DOWNLOAD VIDEO

Request

Download mp4-format binary video file associated to a Request

Path
video_identifierstringrequired

The Request unique identifier

curl -i -X GET \
  'https://api.uanataca.com/api/v1/download/video/{video_identifier}'

Responses

Successful Response

Body