UANATACA RA API DOCUMENTATION (v1)

What it is

The Registration Authority (RA) solution to manage the entire digital certificates life cycle.

The service facilitates the automation of processes through integration via API, allowing you to incorporate the process of issuing digital certificates into your business flows or procedures.

The issuance of digital certificates generates 100% paperless. All information related with the registration and contract issuance is electronically signed and saved in the system to avoid storing physical documentation for years.

How it works

Uanataca RA API allows the generation and distribution of digital certificates, either by integrating the issuance and management into a business application.

The Registration Authority is composed of people and processes, with the main function of identifying applicants of digital certificates and sending verified data for the issuance of the certificate.

Digital certificates are created and used as part of a life-cycle that includes three fundamental stages:

  • Registration including documentation
  • Data validation
  • Certificate issuance

The complete flow is explained in the next section Flow chart

As part of the paperless procedure, every Request has its own digital contract that has to be electronically signed by the RA Operator (in charge of approving the Request) and the certificate subscriber, each one with their respective digital certificates.

Glossary

List of entities and names used to describe UANATACA's services

Certification Authority (CA)

The CA is the issuer of the certificates requested by the Registration Authority.

Registration Authority (RA)

The RA manages the entire life-cycle of digital identities, from the certificate issuance to suspension, reactivation, renewal and revocation of the PKI credentials. Reuests are generated and verified by a Registration Authority Officer.

Registration Authority Officer (RAO)

The RAO follows strict guidelines and policies defined to ensure the trust of the CA. RAO is responsible for managing the requests for digital certificates and verifying the content of the requests as well as identifying people requesting them.

API User

The Account having access to the APIs provided by the system. It is generally used for a server to server interaction.

Certificate Request (Request)

It is a request to issue a new certificate. A request can be associated with only one RA and has a status attribute to monitor the progress of the application:

CREATED: The request has been created and associated to an RA, but the content of the request has not been validated yet. In this state, data can also be inconsistent, the system will not throw an error. The content of the request can be edited at any moment to make it valid.

ENROLLREADY: The certificates are ready to be issued. The request arrives at this stage, if it has been approved and signed by a RAO, who is part of the RA in charge of the request.

ISSUED: The certificate is issued by the user's self-service page on the platform. The user must first set a PIN code or a password regarding the secure element.

RENEWED: The certificate is renewed by the user's self-service page on the platform.

CANCELLED: The request is cancelled and the digital certificate can not be issued.

Scratchcard

It is a virtual scratch card containing the secret codes of the user.

The card contains:

  • A serial number: it uniquely identifies the user
  • An enrollment code: secret code, that is sent to the user by email

It is important to notice that a scratchcard can be used only once. Every request must be associated with a different scratchcard.

Classic Workflow

The following image summarizes the common digital certificate request and issue flow:


img


  1. An end user requests a digital certificate to the Registration Authority (RA)
  2. A Registration Authority Officer (RAO) identifies the user and requests the required documentation
  3. The user sends the required documentation according to the certificate profile
  4. The RAO creates a digital certificate request
  5. The response returns a request ID
  6. The RAO uploads the required documentation according to the request
  7. The RAO verifies all request data and documentation
  8. The RAO checks declaration and signs service contract.
  9. The RAO approves the digital certificate request to allow the certificate issue
  10. The user receives an email with a link to start the certificate generation process
  11. The user access to the online digital certificate generation process
  12. During the process, the service contract is shown to the user
  13. An OTP code is sent to the user via sms
  14. The user inserts the OTP code and creates a custom PIN
  15. The certificate is generated and the service contract is signed by the user
  16. Finally, the user receives the signed contract and an email with the certificate credentials and instructions

The common digital certificate generation process involves the following steps:

1) CREATION OF A REQUEST

2) UPLOAD DOCUMENTS

3) REQUEST APPROVAL


STEP 1: CREATION OF A REQUEST


API Reference: Get First Unused Scratchcard

This call simply requires a Registration Authority (RA) id number. Scratchcards must be available for this RA for successful response.

curl -i -X GET https://api.uanataca.com/api/v1/scratchcards/get_first_unused/ \
-H 'Content-Type: application/json' \
--cert 'cer.pem' --key 'key.pem'
-d '{
  "ra": "121"
}'

The response is a JSON object containing the single-use Scratchcard associated data. The scratchcard number sn must be added to the Create Request call.

{
  "pk": 1193,
  "sn": "1256948",
  "secrets": "{\"erc\": \"6292998123\", \"enrollment_code\": \"_,463vt:\", \"pin\": \"08695572\", \"puk\": \"52351291\"}",
  "registration_authority": 121
}

API reference: Create Request

This call must include enough information to identify the requester user. The full description of the arguments accepted by this endpoint can be found in the API call detailed documentation.

curl -i -X POST 'https://api.uanataca.com/api/v1/requests/' \
-H 'Content-Type: application/json' \
--cert 'cer.pem' --key 'key.pem'
-d '{
  "profile": "PFnubeAFCiudadano",
  "scratchcard": "5053311",
  "secure_element": "2",
  "registration_authority": "116",
  "country_name": "ES",
  "serial_number": "12345678A",
  "id_document_country": "ES",
  "id_document_type": "IDC",
  "given_name": "Name",
  "surname_1": "Surname1",
  "surname_2" "Surname2"
  "email": "mail@domain.com",
  "mobile_phone_number": "+34611223344",
  "paperless_mode": 1
}'

The response is a JSON containing info from the created request. One of the most important parameters from this JSON is the pk which represents the request unique identifier and is used for every operation related to this request.

{
  "pk": 11223,
  "given_name": "Name",
  "surname_1": "Surname1",
  "surname_2": "Surname2",
  "sex": null,
  "id_document_type": "IDC",
  "id_document_country": "ES",
  "serial_number": "12345678A",
  "country_name": "ES",
  "citizenship": null,
  "residence": null,
  "organization_email": null,
  "email": "mail@domain.com",
  "title": null,
  "organization_name": null,
  "organizational_unit_1": null,
  ...
}

STEP 2: UPLOAD DOCUMENTS


API reference: Upload Document

The created request needs documents, so we can query with an HTTP POST request to upload the files.

The required documents for every request are:
document_front : The photo of the front side of the requester ID card
document_rear : The photo of the rear side of the requester ID card
extra_document : If necessary, it is possibile to upload extra documents that represents additional requester information

Additionally a selfie of the requester showing the ID card under the chin can be uploaded as an evidence under the type document_owner.

Note that this endpoint has to be queried for every document type that the Request needs.

curl -i -X POST 'https://api.uanataca.com/api/v1/requests/11223/pl_upload_document/' \
--cert 'cer.pem' --key 'key.pem'
  -H 'Content-Type: multipart/form-data' \
  -F document=@/idc_front.jpg \
  -F type=document_front

The response contains the uploaded document unique identifier associated to the request.

{
  "pk": 11314,
  "type": "document_front"
}

STEP 3: REQUEST APPROVAL

A Registration Authority Officer must first validate the request data and documentation. If the information is correct, the RAO will approve the request by signing the receipt and contract with his or her own cloud certificate.

API Reference: Generate RAO Declaration

curl -i -X POST https://api.uanataca.com/api/v1/requests/25139/generates_tbs_receipt/ \
-H 'Content-Type: application/json' \
-d '{
  "rao": "1400",
  "type": "APPROVE"
}'

The following JSON object contains the receipt:

{
  "serial_number": "3ef3696d2939241d",
  "receipt": "El operador RAO_Name RAO_Surname1 con número de identificación 12345678P\r\nactuando en calidad de operador autorizado de registro del prestador de servicios\r\n
  de confianza UANATACA, S.A. con NIF A66721499, (UANATACA en lo sucesivo)\r\n\r\nDECLARA\r\n\r\nQue previa verificación de acuerdo a la Declaración de Prácticas de
  UANATACA\r\npublicadas en www.uanataca.com, la información detallada a continuación es\r\ncorrecta y será incluida (donde aplicable) en la solicitud de 
  certificados\r\ncualificados:\r\n\r\n- Datos de Identificación de la solicitud de certificados: 36893\r\n- Nombre y Apellidos del Firmante: Name Surname1 Surname2\r\n- DNI/
  NIE/PASAPORTE del Firmante: 11111111B\r\n- Dirección de correo electrónico del Firmante: mail@domain.com\r\n\r\n\r\n18/03/
  2021\r\n\r\n\r\n\r\n--------------------------------------------------------------------\r\nFdo. User Admin\r\nOperador autorizado de registro"
}

Similarly, it is necessary to retrieve the service contract and present it to the RAO before approval.

API Reference: Generate Contract (use type: contract in body)

curl -i -X POST https://api.uanataca.com/api/v1/requests/25139/pl_get_document/ \
-H 'Content-Type: application/json' \
-d '{
  "type": "contract"
  "rao_id": "1400"    
}'

The response consists in a JSON structure containing the contract in Base64 format.

[
  {
    "document": "JVBERi0xLjQKJZOMi54gUmVwb3J0TGFiIEdlbmVyYXRlZCBQREYgZG9jdW1lbnQgaHR0cDovL3d3\ndy5yZXBvcnRsYWIuY29tCjEgMCBvYmoKPDwKL0YxIDIgMCBSCj4 (...)\n",
    "type": "contract"
  }
]

API reference: Approve Request

In order to approve a Request, this must be in the status of CREATED and must have at least the required documents (document_front and document_rear).

curl -i -X POST 'https://api.uanataca.com/api/v1/requests/' \
-H 'Content-Type: application/json' \
--cert 'cer.pem' --key 'key.pem'
-d '{
  "username": "1000279",
  "password": "3DPTm:N4",
  "pin": "23bYQq9a",
  "rao_id": 123
}'

Video ID Workflows

eIDAS VideoID

This workflow defines the complete process of issuing eIDAS certificates.

img


This certificate generation process involves the following steps:


1) CREATION OF A REQUEST

2) VIDEO IDENTIFICATION

3) VALIDATION OF VIDEO IDENTIFICATION EVIDENCES

4) UPDATE OF REQUEST (OPTIONAL)

5) DOCUMENTS UPLOAD (OPTIONAL)

6) REQUEST APPROVAL


STEP 1: CREATION OF A REQUEST


API Reference: Get First Unused Scratchcard

This call simply requires a Registration Authority (RA) id number. Scratchcards must be available for this RA for successful response.

curl -i -X GET https://api.uanataca.com/api/v1/scratchcards/get_first_unused/ \
-H 'Content-Type: application/json' \
--cert 'cer.pem' --key 'key.pem'
-d '{
  "ra": "121"
}'

The response is a JSON object containing the single-use Scratchcard associated data. The scratchcard number sn must be added to the Create Request call.

{
  "pk": 1193,
  "sn": "1256948",
  "secrets": "{\"erc\": \"6292998123\", \"enrollment_code\": \"_,463vt:\", \"pin\": \"08695572\", \"puk\": \"52351291\"}",
  "registration_authority": 121
}

API Reference: Create Request

This call must include this parameters to success. The full description of the arguments accepted by this endpoint can be found in the call detailed documentation.

curl -i -X POST 'https://api.uanataca.com/api/v1/requests/' \
-H 'Content-Type: application/json' \
--cert 'cer.pem' --key 'key.pem'
-d '{
  "profile": "PFnubeAFCiudadano",
  "scratchcard": "5053311",
  "secure_element": "2",
  "registration_authority": "116",
  "email": "mail@domain.com",
  "mobile_phone_number": "+34611223344",
  "videoid_mode": 1
}'

The response is the a JSON containing info from the created request in VIDEOPENDING status. One of the most important parameters from this JSON is the pk which represents the request unique identifier and is used for every operation related to this request.

{
  "pk": 25139,
  "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": "mail@domain.com",
  "title": null,
  "organization_name": null,
  "organizational_unit_1": null,
  (...)
}

At this point, the workflow progress will depend on the video-identification process performed by end user. Its successful completion will change request status to VIDEOREVIEW.

⚠ In case the process is not totally completed or has failed for any reason, the request will change to VIDEOINCOMPLETE or VIDEOERROR respectively.

To inform business app and validation RAO about this change at the time it takes place, we recommend the implementation of a Webhook. Check our documentation for Webhook Configuration.

If a request needs to be cancelled, use the Cancel Request call.


STEP 2: VIDEO IDENTIFICATION


This process is performed by end user in Uanataca platform. It can be start from a link received in an email sent to the end user.

Through Video Identification process, evidences from the certificate subscriber such as name, surname or data related to subscriber ID card are obtained.


STEP 3: VALIDATION OF VIDEO IDENTIFICATION EVIDENCES


With the information gathered in the above mentioned process, a UANATACA Certified Operator will be in charge of validating every evidence.

In case of Natural Person profiles, the request gets approved in this step, meaning that the user will receive an email to complete the certificate issuance.

After this step the request status will change to ENROLLREADY for Natural Person profiles or CREATED for the rest of them.


STEP 4: UPDATE OF THE REQUEST


⚠ This step is required for all profiles except Natural Person

RAO entity compliments every field that does not belong to subscriber identification. Be aware that the fields filled in with information obtained from the video identification process cannot be modified in any way.

Check the required fields for each certificate profile in eIDAS Certificate Profiles list.


API Reference: Update Request

curl -i -X PUT https://api.uanataca.com/api/v1/requests/{ID}/ \
-H 'Content-Type: application/json' \
-d '{
  "given_name": "Name",
  "surname_1": "Surname1",
  "scratchcard": "1234567890",
  "country_name": "ES",
  "email": "mail@domain.com",
  "profile": "PFnubeAFCiudadano",
  "registration_authority": 64
}'

STEP 5: DOCUMENTS UPLOAD


⚠ This step is required for all profiles except Natural Person

RAO entity uploads required documentation subject to the type of profile being issued.


API Reference: Upload documents

curl -i -X PUT https://api.uanataca.com/api/v1/requests/{request}/upload_videoid_evidence/ \
-H 'Content-Type: multipart/form-data' \
-F document=@sample_folder/sample.pdf \
-F label=test label

STEP 6: REQUEST APPROVAL


To complete a request, the RAO must be sure to validate both additional documents and fields. Before approval, you will be shown a preview of RAO declaration.


API Reference: Generate RAO Declaration

curl -i -X POST https://api.uanataca.com/api/v1/requests/25139/generates_tbs_receipt/ \
-H 'Content-Type: application/json' \
-d '{
  "rao": "1400",
  "type": "APPROVE"
}'

The following JSON object contains the receipt:

{
  "serial_number": "3ef3696d2939241d",
  "receipt": "El operador RAO_Name RAO_Surname1 con número de identificación 12345678P\r\nactuando en calidad de operador autorizado de registro del prestador de servicios\r\n
  de confianza UANATACA, S.A. con NIF A66721499, (UANATACA en lo sucesivo)\r\n\r\nDECLARA\r\n\r\nQue previa verificación de acuerdo a la Declaración de Prácticas de
  UANATACA\r\npublicadas en www.uanataca.com, la información detallada a continuación es\r\ncorrecta y será incluida (donde aplicable) en la solicitud de 
  certificados\r\ncualificados:\r\n\r\n- Datos de Identificación de la solicitud de certificados: 36893\r\n- Nombre y Apellidos del Firmante: Name Surname1 Surname2\r\n- DNI/
  NIE/PASAPORTE del Firmante: 11111111B\r\n- Dirección de correo electrónico del Firmante: mail@domain.com\r\n\r\n\r\n18/03/
  2021\r\n\r\n\r\n\r\n--------------------------------------------------------------------\r\nFdo. User Admin\r\nOperador autorizado de registro"
}

Similarly, it is necessary to retrieve the service contract and present it to the RAO before approval.

API Reference: Generate Contract (use type: contract in body)

curl -i -X POST https://api.uanataca.com/api/v1/requests/25139/pl_get_document/ \
-H 'Content-Type: application/json' \
-d '{
  "type": "contract"
  "rao_id": "1400"    
}'

The response consists in a JSON structure containing the contract in Base64 format.

[
  {
    "document": "JVBERi0xLjQKJZOMi54gUmVwb3J0TGFiIEdlbmVyYXRlZCBQREYgZG9jdW1lbnQgaHR0cDovL3d3\ndy5yZXBvcnRsYWIuY29tCjEgMCBvYmoKPDwKL0YxIDIgMCBSCj4 (...)\n",
    "type": "contract"
  }
]

API Reference: Approve Request

This call makes the request ready for enrollment. Its status changes to ENROLLREADY after executing this call.

curl -i -X POST 'https://api.uanataca.com/api/v1/requests/' \
-H 'Content-Type: application/json' \
--cert 'cer.pem' --key 'key.pem'
-d '{
  "username": "1000279",
  "password": "3DPTm:N4",
  "pin": "23bYQq9a",
  "rao_id": "1400",
  "lang": "ES"
}'

The response is a JSON object with added request approval information.

{
  "secrets": {
    "puk": "38812452",
    "enrollment_code": ".R4P9qgA",
    "pin": "31945152",
    "erc": "3417062505"
  },
  "request": {
    "pk": 25139,
    "given_name": "Name",
    "surname_1": "Surname1",
    "surname_2": "Surname2",
    "sex": null,
    "id_document_type": "IDC",
    "id_document_country": "ES",
    "serial_number": "A9999999E",
    (...)
    "approving_rao": {
      "pk": 1400,
      "given_name": "RAO_Name",
      "surname_1": "RAO_Surname1",
      "surname_2": "RAO_Surname2",
      (...)
    }
  }
}

External Mode

img


The External-Mode Video ID certificate generation process involves the following steps:


1) CREATION OF A REQUEST

2) UPLOAD EVIDENCES

3) REQUEST APPROVAL


STEP 1: CREATION OF A REQUEST


API Reference: Get First Unused Scratchcard

This call simply requires a Registration Authority (RA) id number. Scratchcards must be available for this RA for successful response.

curl -i -X GET https://api.uanataca.com/api/v1/scratchcards/get_first_unused/ \
-H 'Content-Type: application/json' \
--cert 'cer.pem' --key 'key.pem'
-d '{
  "ra": "121"
}'

The response is a JSON object containing the single-use Scratchcard associated data. The scratchcard number sn must be added to the Create Request call.

{
  "pk": 1193,
  "sn": "1256948",
  "secrets": "{\"erc\": \"6292998123\", \"enrollment_code\": \"_,463vt:\", \"pin\": \"08695572\", \"puk\": \"52351291\"}",
  "registration_authority": 121
}

API Reference: Create Request

This call must include enough information to identify the end user. The full description of the arguments accepted by this endpoint can be found in the call detailed documentation.

curl -i -X POST 'https://api.uanataca.com/api/v1/requests/' \
-H 'Content-Type: application/json' \
--cert 'cer.pem' --key 'key.pem'
-d '{
  "profile": "PFnubeAFCiudadano",
  "scratchcard": "5053311",
  "secure_element": "2",
  "registration_authority": "116",
  "country_name": "ES",
  "serial_number": "12345678A",
  "id_document_country": "ES",
  "id_document_type": "IDC",
  "given_name": "Name",
  "surname_1": "Surname1",
  "surname_2" "Surname2"
  "email": "mail@domain.com",
  "mobile_phone_number": "+34611223344",
  "videoid_mode": 1
}'

The response is the a JSON containing info from the created request in VIDEOPENDING status. One of the most important parameters from this JSON is the pk which represents the request unique identifier and is used for every operation related to this request.

{
  "pk": 25139,
  "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": "mail@domain.com",
  "title": null,
  "organization_name": null,
  "organizational_unit_1": null,
  (...)
}

If request data needs to be modified, use the Update Request call. Check API Reference.

If request data needs to be retrieved, use the Get Request call. Check API Reference.


STEP 2: UPLOAD EVIDENCES


A previously created Video ID Request needs a set of information defined as evidences. The succesful upload of ALL this information will change the request status to VIDEOREVIEW.

Data and images are uploaded by using the following call:

API Reference: Upload Data Evidence


Data objects in detail:

acceptance : Client acceptance parameters (e.g. Terms & Conditions, Privacy Policy). This is a customizable JSON object.
data : Set of pictures associated to the client's ID document plus a selfie of him/her.
ocr_data : Text information extracted from the client's ID document via Optical Character Recognition (OCR).
security_checks : Set of validation fields associated to the client's identity (underaging, matching info, liveliness, etc)
similarity_level : Similarity between the client's selfie and the picture is shown on his/her ID document.

curl -i -X PUT https://api.uanataca.com/api/v1/videoid/45836 \
    -H 'Content-Type: application/json' \
    -d '{
        "acceptance": {
            "description": "User Accepted Terms and Conditions and Privacy Policy",
            "url-doc-privacypolicy": "https://www.uanataca.com/public/pki/privacidad-PSC/",
            "ip": "186.0.91.53",
            "url-web-videoid": "https://cms.access.bit4id.org:13035/lcmpl/videoid/46b92251-4ba8-4930-a5aa-8631ec4666b6",
            "user-agent": "Mozilla/5.0 (Linux; Android 11; AC2003)",
            "date": 1622823879708,
            "url-doc-termsconditions": "https://www.uanataca.com/public/pki/terminos-VID/"
        },
        "videoid_data": {
            "images": {
                "document_front": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAM (...)",
                "document_rear": "/I7ye60+aOKS0mVGVSD9RVfyXukjmnS3cAEbpMVm6M1ncWqS3FszptO1lPRRDJ+orI8b (...)",
                "document_photo": "AkjOOwFfHFrrNlpXxcbU9QuIIIkvR56yddgHpX3GEj1PmanmdS/xV1ySVlv/AIbXLPO (...)",
                "document_owner": "SSVnovgCZ4Lhk+R3lJPUDJr5t/Z/wBV1DWfjRbeI75B5iQytcykc7yMEAV2/iwC0T34 (...)"
            },
            "ocr_data": {
                "given_name": "Name",
                "surname_1": "Surname 1",
                "surname_2": "Surname 2",
                "mobile_phone_number": "+34999999999",
                "email": "mail@domain",
                "serial_number": "A9999999E",
                "id_document_type": "IDC",
                "id_document_country": ES
            },
            "security_checks": {
                "otp_validation": true,
                "documents_match": true,
                "data_integrity": true,
                "document_notcopy": true,
                "document_notexpired": true,
                "document_notunderage": true,
                "liveliness": true
            },
            "similarity_level": "high"
        }
    }

Successful response status

{
  "status": "200 OK"
}

In the same way, MP4-format Video evidence is uploaded by using the following call:

API Reference: Upload Video

curl -i -X POST https://lima.uanataca.com/v1/upload/video/30e57b02819a430d8386fd85be9f499f/ \
-H 'Content-Type: multipart/form-data' \
-F video=@sample_folder/sample_video.mp4 

Successful response status

{
  "status": "200 OK"
}

If the uploaded video needs to be retrieved, use Download Video call.


STEP 3: REQUEST APPROVAL


For unsuccessful validations leading to a request refusal, the corresponding call is Refuse Request. Check API Reference. If all information is correct, the RAO will approve the request by signing the receipt and contract with his or her own cloud certificate. These calls are shown below:

API Reference: Generate RAO Declaration

curl -i -X POST https://api.uanataca.com/api/v1/requests/25139/generates_tbs_receipt/ \
-H 'Content-Type: application/json' \
-d '{
  "rao": "1400",
  "type": "APPROVE"
}'

The following JSON object contains the receipt:

{
  "serial_number": "3ef3696d2939241d",
  "receipt": "El operador RAO_Name RAO_Surname1 con número de identificación 12345678P\r\nactuando en calidad de operador autorizado de registro del prestador de servicios\r\n
  de confianza UANATACA, S.A. con NIF A66721499, (UANATACA en lo sucesivo)\r\n\r\nDECLARA\r\n\r\nQue previa verificación de acuerdo a la Declaración de Prácticas de
  UANATACA\r\npublicadas en www.uanataca.com, la información detallada a continuación es\r\ncorrecta y será incluida (donde aplicable) en la solicitud de 
  certificados\r\ncualificados:\r\n\r\n- Datos de Identificación de la solicitud de certificados: 36893\r\n- Nombre y Apellidos del Firmante: Name Surname1 Surname2\r\n- DNI/
  NIE/PASAPORTE del Firmante: 11111111B\r\n- Dirección de correo electrónico del Firmante: mail@domain.com\r\n\r\n\r\n18/03/
  2021\r\n\r\n\r\n\r\n--------------------------------------------------------------------\r\nFdo. User Admin\r\nOperador autorizado de registro"
}

Similarly, it is necessary to retrieve the service contract and present it to the RAO before approval.

API Reference: Generate Contract (use type: contract in body)

curl -i -X POST https://api.uanataca.com/api/v1/requests/25139/pl_get_document/ \
-H 'Content-Type: application/json' \
-d '{
  "type": "contract"
  "rao_id": "1400"    
}'

The response consists in a JSON structure containing the contract in Base64 format.

[
  {
    "document": "JVBERi0xLjQKJZOMi54gUmVwb3J0TGFiIEdlbmVyYXRlZCBQREYgZG9jdW1lbnQgaHR0cDovL3d3\ndy5yZXBvcnRsYWIuY29tCjEgMCBvYmoKPDwKL0YxIDIgMCBSCj4 (...)\n",
    "type": "contract"
  }
]

API Reference: Approve Request

This call makes the request ready for enrollment. Its status changes to ENROLLREADY.

curl -i -X POST 'https://api.uanataca.com/api/v1/requests/' \
-H 'Content-Type: application/json' \
--cert 'cer.pem' --key 'key.pem'
-d '{
  "username": "1000279",
  "password": "3DPTm:N4",
  "pin": "23bYQq9a",
  "rao_id": 123,
  "lang": "ES"
}'

The response is a JSON object with added request approval information.

{
  "secrets": {
    "puk": "38812452",
    "enrollment_code": ".R4P9qgA",
    "pin": "31945152",
    "erc": "3417062505"
  },
  "request": {
    "pk": 25139,
    "given_name": "Name",
    "surname_1": "Surname1",
    "surname_2": "Surname2",
    "sex": null,
    "id_document_type": "IDC",
    "id_document_country": "ES",
    "serial_number": "A9999999E",
    (...)
    "approving_rao": {
      "pk": 1400,
      "given_name": "RAO_Name",
      "surname_1": "RAO_Surname1",
      "surname_2": "RAO_Surname2",
      (...)
    }
  }
}

In case of not approving a request for any reason, the call Cancel Request must be executed. Check API Reference.


OPTIONAL


API Reference: Get Request to consult any information about the request.

API Reference: Download video to download the video recorded and uploaded in the identification part.

Webhook Configuration

One-Shot API requires a Webhook implemented on customer business side to manage our service callbacks. Every request status change will trigger a simple event-notification via HTTP POST, consisting on a JSON object to an URL that must be explicitly included as a parameter in the Create Video ID Request call. Keep in mind that the webhook via parameter is just for demo purposes. You will have to contact your officer to set a webhook in your RA.

The following is a sample view of the JSON object that is sent as a callback at every status change:

{
    "status": "VIDEOINCOMPLETE", 
    "date": "2021-07-20T08:08:21.132394", 
    "previous_status": "VIDEOPENDING", 
    "request": 46760, 
    "registration_authority": 455
}

Where:

Status is the most recent status, this is, the status that triggered the notification.
Date is the date of the request status change in datetime format.
Previous_status is the status inmediately previous to last change.
Request is the request unique id.
Registration_authority is the Registration Authority id number the request is associated.


Sample code

In this sample, every JSON object is stored in a file named 'videoid'.

The webhook parameter used in the Create Video ID Request call is defined as:

{host}/videoid

where {host} is the IP or domain from the server exposing the webhook.


Python

import web
import datetime

urls = (
        '/videoid, 'videoid',
        )

app = web.application(urls, globals())
app = app.wsgifunc()

class video:
    def POST(self):
        data = web.data()
        f = open("status.json",'a+')
        f.write(data)
        f.close()
        return ''

if __name__ == "__main__":
    app.run()

PHP

<?php

//videoid.json

$post = file_get_contents('php://input',true);
$file_handle = fopen('/videoid/status.json', 'w');
fwrite($file_handle, $post);
fclose($file_handle);

?>

Endpoint URLs

Uanataca expose its API on urls composed as follows:

https://{host}/api/{version}/{resource}/
⚠ Make sure the URL always ends with a forward slash ("/")

Uanataca host

The host changes according to the environment:

  • api.sandbox.uanataca.com for sandbox environment
  • lima.sandbox.uanataca.com for sandbox environment(only for external videoid flow)
  • api.uanataca.com for production environment
  • lima.uanataca.com for production environment(only for external videoid flow)

Version

It is the api version (currently v1)

Resource

It is the name of the resource of our interest.

Each resource can also have path parameters and sub-resources that are defined in the API Reference below:

This is an example of endpoint exposed by Uanataca:

https://api.uanataca.com/api/v1/requests/123/cloud_enroll/

Authentication

The API authentication is perfomed providing to the server the certificate and the key of an enabled API User.

This is an example HTTP POST request perfomed with cURL:

1 | curl --key key.pem --cert cert.pem -H "Content-Type: application/json" -d @params.json -X POST https://api.uanataca.com/api/v1/requests/

and a Python with requests package example:

1 | import requests
2 | requests.get(
3 |     'https://api.uanataca.com/api/v1/scratchcards/',
4 |     cert = ('/path/to/cert.pem', '/path/to/key.pem')
5 | )

Responses

Every response body returned by Uanataca is JSON object.

If the response is successful, the content of the JSON depends on the API queried.

Instead, the error response is always composed of these keys:

KeyDescription
errorA string that describe the error occured
codeThe HTTP response code related. See table descriptions
idThe unique identifier of the error generated by Uanataca

In the API Reference are described the response structures for each API call.

A successful response:

1 | [
2 |     {
3 |         "data": "MIIHyTCCBbGgAwIBAgIIcO...",
4 |         "profile": "PFnubeAF",
5 |         "subject": "CN=RAO COFTenerife API, 2.5.4.5=TINIT-TSTAPI74S23C129Y, 2.5.4.42=RAO, 2.5.4.4=API, C=ES",
6 |         "issuer": "2.5.4.97=VATES-A66721499, CN=UANATACA CA1 2016, OU=AC-UANATACA, O=UANATACA S.A., L=Barcelona (see current address at www.uanataca.com/address), C=ES",
7 |         "valid_from": "2018-10-16T16:41:00",
8 |         "valid_to": "2020-10-15T16:41:00",
9 |         "serial_number": "70e07489bfccd478",
10|         "status": 0,
11|         "pk": 1980,
12|         "revokation_reason": null,
13|         "type": "FIRSTISSUE"
14|     }
15| ]

An error response:

1 | {
2 |     "code": "500",
3 |     "id": "8e782cdcdb600a90",
4 |     "error": "Invalid ScratchCard"
5 | }

HTTP Status Codes

CodeDescription
200Everything went OK. The server elaborated correctly the request and returned the response to the client.
201The object is successfully Created with the parameters sent by the client.
202The request sent by the client has been Accepted and is under process.
204No Content. The operation was successful but no content is provided in the response body.
400Bad Request. The parameters sent, are not well formatted or are missing.
401Unauthorized. The user used for making the request is not authorized to consume that resource.
403Forbidden.The user used for making the request has no permissions to do it.
404The resource requested is Not Found.
405Method not allowed. The endpoint called has not the method specified.
412Precondition Failed. The operation has some requirements that are not satisfied. For example if a Request is in a wrong state for the operation requested.
429Too Many Requests.
500Internal Server Error. An error occured during the elaboration of the request.
502Bad Gateway.
503Service Unavailable.

Pagination

Some endpoints works with the mechanism of pagination.

This means that when an API returns the content requested, the JSON is composed with the keys:

KeyDescription
countRepresents the number of object found
nextRepresents the url of the next page (it is null if there are no more pages)
previousRepresents the url of the previous page (it is null if there are no more pages)
resultContains a list of objects found

Every page contains at most 10 objects.

Examples

Here are display a couple of JSON returned by Uanataca.

A list of Scratchcards:

1 | {
2 |     "count": 40,
3 |     "next": "https://api.uanataca.com/api/v1/scratchcards/?page=2®istration_authority=8",
4 |     "previous": null,
5 |     "results": [
6 |         {
7 |             "pk": 801,
8 |             "sn": "2000100",
9 |             ...
10|         },
11|         {
12|             "pk": 800,
13|             "sn": "2000099",
14|             ...
15|         },
16|         ...
17|     ]
18| }

A list of Requests:

1 | {
2 |     "count": 643,
3 |     "next": "https://api.uanataca.com/api/v1/requests/?page=2",
4 |     "previous": null,
5 |     "results": [
6 |         {
7 |             "pk": 788,
8 |             ...
9 |         },
10|         {
11|             "pk": 789,
12|             ...
13|         },
14|         ....
15|     ]
16| }

Certificate Profiles

Uanataca provides different certificate profiles for different purpose.

Each profile has their set of fields and each field can be mandatory or not.

Europe (eIDAS)

ProfileDescriptionElement
PFSoftAFCiudadanoNatural personSoftware
PFqscdCiudadanoNatural personSmartcard/Token
PFnubeAFCiudadanoNatural personCloud
PFnubeQAFCiudadanoNatural personCloud-QSCD
PFSoftAFEmpresaNatural person belonging to an organizationSoftware
PFqscdEmpresaNatural person belonging to an organizationSmartcard/Token
PFnubeAFEmpresaNatural person belonging to an organizationCloud
PFnubeQAFEmpresaNatural person belonging to an organizationCloud-QSCD
PFSoftAFColegiadoNatural person belonging to a professional associationSoftware
PFqscdColegiadoNatural person belonging to a professional associationSmartcard/Token
PFnubeAFColegiadoNatural person belonging to a professional associationCloud
PFnubeQAFColegiadoNatural person belonging to a professional associationCloud-QSCD
REPsoftNatural person representativeSoftware
REPqscdNatural person representative (signature only)Smartcard/Token
REPnubeQNatural person representative (signature only)Cloud-QSCD
REPPJsoftNatural person representative of legal person with the administrationSoftware
REPPJnubeNatural person representative of legal person with the administrationCloud
REPPJqscdNatural person representative of legal person with the administrationSmartcard/Token
REPPJnubeQNatural person representative of legal person with the administrationCloud-QSCD
EMPUBsoftPublic employee - Medium levelCloud/Software
EMPUBqscdPublic employee signature - High levelSmartcard/Token
EMPUBnubeQPublic employee signature - High levelCloud-QSCD
REPESPJsoftNatural person representative of entity without legal personality with the administrationsSoftware
REPESPJnubeNatural person representative of entity without legal personality with the administrationsCloud
REPESPJqscdNatural person representative of entity without legal personality with the administrationsSmartcard/Token
REPESPJnubeQNatural person representative of entity without legal personality with the administrationsCloud-QSCD
SELLOPJnubeElectronic sealCloud
SELLOPJsoftElectronic sealSoftware
SELLOPJnubeQElectronic sealCloud-QSCD
SELLOPJqscdElectronic sealSmartcard/Token
SELLOMedioElectronic seal – Medium Level APECloud/Software
SELLOAltoElectronic seal – High Level APESmartcard/Token
SelloOrganoAltoNubeQElectronic seal – High Level APECloud-QSCD

PFSoftAFCiudadano

Certificate of a natural person issued on a cryptographic container in P12 format and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 0 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the software element. Yes
profile PFSoftAFCiudadano Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
id_document_number The cardholder document number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No

PFqscdCiudadano

Certificate of a natural person issued on a smartcard or a cryptographic token and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 1 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the smartcard element. Yes
profile PFqscdCiudadano Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
id_document_number The cardholder document number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No

PFnubeAFCiudadano

Certificate of a natural person issued in the centralized custody system of Uanataca certificates and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile PFnubeAFCiudadano Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
id_document_number The cardholder document number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No

PFnubeQAFCiudadano

Certificate of a natural person issued in the centralized custody system of Uanataca certificates and intended for authentication and qualified electronic signature.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile PFnubeQAFCiudadano Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
id_document_number The cardholder document number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No

PFSoftAFEmpresa

Certificate of a natural person belonging to an organization or company issued on cryptographic token in P12 format and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 0 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the software element. Yes
profile PFSoftAFEmpresa Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
organization_rol No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

PFqscdEmpresa

Certificate of a natural person belonging to an organization or company issued on a smartcard or cryptographic token and intended for authentication and eltronic signature.

Field Value Description Mandatory
secure_element 1 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the smartcard element. Yes
profile PFqscdEmpresa Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
organization_rol No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

PFnubeAFEmpresa

Certificate of a natural person belonging to an organization or company issued in the centralized custody system of Uanataca certificates and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile PFnubeAFEmpresa Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
organization_rol No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

PFnubeQAFEmpresa

Certificate of a natural person belonging to an organization or company issued in the centralized custody system of Uanataca certificates and intended for authentication and qualified eltronic signature.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile PFnubeQAFEmpresa Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
organization_rol No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

PFSoftAFColegiado

Certificate of a registered individual, for authentication and electronic signature issued in cryptographic container format P12.

Field Value Description Mandatory
secure_element 0 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the software element. Yes
profile PFSoftAFColegiado Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
professional_id_number No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

PFqscdColegiado

Certificate of a registered individual, for authentication and electronic signature issued on a cryptographic card or token.

Field Value Description Mandatory
secure_element 1 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the smartcard element. Yes
profile PFqscdColegiado Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
professional_id_number No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

PFnubeAFColegiado

Certificate of a registered individual, for authentication and electronic signature issued in the centralized custody system of Uanataca certificates.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile PFnubeAFColegiado Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
professional_id_number No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

PFnubeQAFColegiado

Certificate of a registered individual, for authentication and qualified electronic signature issued in the centralized custody system of Uanataca certificates.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile PFnubeQAFColegiado Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
professional_id_number No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

REPsoft

Certificate of legal entity representative, suitable for the relationship between Spanish or European companies, for authentication and electronic signature issued in cryptographic container format P12.

Field Value Description Mandatory
registration_authority The Registration Authority id Yes
organization_identifier The organization identifier Yes
organization_email The organization email Yes
subscriber_responsible_serial The organization representative document number No
empowerment The cardholder legal representation level No
representation The cardholder legal representation document No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
description A description No
scratchcard The scratchcard serial number that will be associated to the Request Yes
profile REPsoft Represents the profile of the request Yes
secure_element [0, 2] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
citizen_tax_number The citizen tax number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
sex The cardholder sex No
birth_city The cardholder city of residence No
birth_province The cardholder province of residence No
birth_state The cardholder state of residence No
birth_district The cardholder district of residence No
birth_canton The cardholder canton code of residence No
serial_number The cardholder serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
organizational_unit_2 The cardholder second organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
fix_phone_number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_name The organization name Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_country The organization country Yes
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

REPqscd

Certificate of legal entity representative, suitable for the relationship between Spanish or European companies, for the electronic signature issued on a cryptographic card or token.

Field Value Description Mandatory
registration_authority The Registration Authority id Yes
organization_identifier The organization identifier Yes
organization_email The organization email Yes
subscriber_responsible_serial The organization representative document number No
empowerment The cardholder legal representation level No
representation The cardholder legal representation document No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
description A description No
scratchcard The scratchcard serial number that will be associated to the Request Yes
profile REPqscd Represents the profile of the request Yes
secure_element 1 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the smartcard element. Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
citizen_tax_number The citizen tax number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
sex The cardholder sex No
birth_city The cardholder city of residence No
birth_province The cardholder province of residence No
birth_state The cardholder state of residence No
birth_district The cardholder district of residence No
birth_canton The cardholder canton code of residence No
serial_number The cardholder serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
organizational_unit_2 The cardholder second organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
fix_phone_number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_name The organization name Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_country The organization country Yes
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

REPnubeQ

Certificate of representative of legal entity, suitable for the relationship between Spanish or European companies, for the qualified electronic signature, and issued in the centralized custody system of Uanataca certificates.

Field Value Description Mandatory
registration_authority The Registration Authority id Yes
organization_identifier The organization identifier Yes
organization_email The organization email Yes
subscriber_responsible_serial The organization representative document number No
empowerment The cardholder legal representation level No
representation The cardholder legal representation document No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
description A description No
scratchcard The scratchcard serial number that will be associated to the Request Yes
profile REPnubeQ Represents the profile of the request Yes
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
citizen_tax_number The citizen tax number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
sex The cardholder sex No
birth_city The cardholder city of residence No
birth_province The cardholder province of residence No
birth_state The cardholder state of residence No
birth_district The cardholder district of residence No
birth_canton The cardholder canton code of residence No
serial_number The cardholder serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
organizational_unit_2 The cardholder second organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
fix_phone_number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_name The organization name Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_country The organization country Yes
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

REPPJsoft

Certificate of the legal entity representative issued on a cryptographic container in P12 format and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 0 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile REPPJsoft Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organization_email The organization email Yes
description One of the following options:
- Registro Mercantil: Reg: XXX /Hoja: XXX /Tomo:XXX /Sección:XXX /Libro:XXX /Folio:XXX /Fecha: dd-mm-aaaa /Inscripción: XXX.
- Poder Notarial: Notario: Nombre Apellido1 Apellido2 /Núm Protocolo: XXX /Fecha Otorgamiento: dd-mm-aaaa.
- Boletines Oficiales: Boletín: XXX /Fecha: dd-mm-aaaa /Numero resolución: XXX.
- Otros: Documento: XXX /Fecha: dd-mm-aaaa
Yes
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
subscriber_responsible_serial The organization representative document number No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

REPPJnube

Certificate of the legal entity representative issued in the centralized custody system of Uanataca certificates and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile REPPJnube Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organization_email The organization email Yes
description One of the following options:
- Registro Mercantil: Reg: XXX /Hoja: XXX /Tomo:XXX /Sección:XXX /Libro:XXX /Folio:XXX /Fecha: dd-mm-aaaa /Inscripción: XXX.
- Poder Notarial: Notario: Nombre Apellido1 Apellido2 /Núm Protocolo: XXX /Fecha Otorgamiento: dd-mm-aaaa.
- Boletines Oficiales: Boletín: XXX /Fecha: dd-mm-aaaa /Numero resolución: XXX.
- Otros: Documento: XXX /Fecha: dd-mm-aaaa
Yes
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
subscriber_responsible_serial The organization representative document number No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

REPPJqscd

Certificate of the legal entity representative issued on a smartcard or on a cryptographic token and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 1 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the smartcard element. Yes
profile REPPJqscd Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organization_email The organization email Yes
description One of the following options:
- Registro Mercantil: Reg: XXX /Hoja: XXX /Tomo:XXX /Sección:XXX /Libro:XXX /Folio:XXX /Fecha: dd-mm-aaaa /Inscripción: XXX.
- Poder Notarial: Notario: Nombre Apellido1 Apellido2 /Núm Protocolo: XXX /Fecha Otorgamiento: dd-mm-aaaa.
- Boletines Oficiales: Boletín: XXX /Fecha: dd-mm-aaaa /Numero resolución: XXX.
- Otros: Documento: XXX /Fecha: dd-mm-aaaa
Yes
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
subscriber_responsible_serial The organization representative document number No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

REPPJnubeQ

Certificate of representative of legal entity, suitable to interact with Spanish Public Administrations, issued in the centralized custody system of Uanataca certificates and intended for authentication and qualified electronic signature.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile REPPJnubeQ Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organization_email The organization email Yes
description One of the following options:
- Registro Mercantil: Reg: XXX /Hoja: XXX /Tomo:XXX /Sección:XXX /Libro:XXX /Folio:XXX /Fecha: dd-mm-aaaa /Inscripción: XXX.
- Poder Notarial: Notario: Nombre Apellido1 Apellido2 /Núm Protocolo: XXX /Fecha Otorgamiento: dd-mm-aaaa.
- Boletines Oficiales: Boletín: XXX /Fecha: dd-mm-aaaa /Numero resolución: XXX.
- Otros: Documento: XXX /Fecha: dd-mm-aaaa
Yes
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
subscriber_responsible_serial The organization representative document number No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

EMPUBsoft

Certificate of public employee of a Spanish Public Administration, issued on a cryptographic container in P12 format and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element [0, 2] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile EMPUBsoft Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
organizational_unit_1 CERTIFICADO ELECTRONICO DE EMPLEADO PUBLICO The cardholder first organizational unit Yes
organizational_unit_2 The cardholder second organizational unit Yes
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
responsible_position The responsible position No
organizational_unit_3 The cardholder third organizational unit No
organizational_unit_4 The cardholder fourth organizational unit No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

EMPUBqscd

Certificate of public employee of a Spanish Public Administration, issued on a smartcard or a cryptographic token and intended for electronic signature.

Field Value Description Mandatory
secure_element 1 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the smartcard element. Yes
profile EMPUBqscd Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
organizational_unit_1 CERTIFICADO ELECTRONICO DE EMPLEADO PUBLICO The cardholder first organizational unit Yes
organizational_unit_2 The cardholder second organizational unit Yes
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
responsible_position The responsible position No
organizational_unit_3 The cardholder third organizational unit No
organizational_unit_4 The cardholder fourth organizational unit No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

EMPUBnubeQ

Certificate of public employee of a Spanish Public Administration, issued in the centralized custody system of Uanataca certificates and intended for the qualified electronic signature.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile EMPUBnubeQ Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
organizational_unit_1 CERTIFICADO ELECTRONICO DE EMPLEADO PUBLICO The cardholder first organizational unit Yes
organizational_unit_2 The cardholder second organizational unit Yes
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_tax_number The organization tax number Yes
organization_name The organization name Yes
responsible_serial The responsible serial number Yes
organization_email The organization email Yes
responsible_position The responsible position No
organizational_unit_3 The cardholder third organizational unit No
organizational_unit_4 The cardholder fourth organizational unit No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

REPESPJsoft

Certificate of representative of entity without legal license issued on a cryptographic container in P12 format and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 0 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile REPESPJsoft Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organization_email The organization email Yes
description One of the following options:
- Registro Mercantil: Reg: XXX /Hoja: XXX /Tomo:XXX /Sección:XXX /Libro:XXX /Folio:XXX /Fecha: dd-mm-aaaa /Inscripción: XXX.
- Poder Notarial: Notario: Nombre Apellido1 Apellido2 /Núm Protocolo: XXX /Fecha Otorgamiento: dd-mm-aaaa.
- Boletines Oficiales: Boletín: XXX /Fecha: dd-mm-aaaa /Numero resolución: XXX.
- Otros: Documento: XXX /Fecha: dd-mm-aaaa
Yes
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
subscriber_responsible_serial The organization representative document number No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

REPESPJnube

Certificate of representative of entity without legal license issued in the centralized custody system of Uanataca certificates and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile REPESPJnube Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organization_email The organization email Yes
description One of the following options:
- Registro Mercantil: Reg: XXX /Hoja: XXX /Tomo:XXX /Sección:XXX /Libro:XXX /Folio:XXX /Fecha: dd-mm-aaaa /Inscripción: XXX.
- Poder Notarial: Notario: Nombre Apellido1 Apellido2 /Núm Protocolo: XXX /Fecha Otorgamiento: dd-mm-aaaa.
- Boletines Oficiales: Boletín: XXX /Fecha: dd-mm-aaaa /Numero resolución: XXX.
- Otros: Documento: XXX /Fecha: dd-mm-aaaa
Yes
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
subscriber_responsible_serial The organization representative document number No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

REPESPJqscd

Certificate of representative of entity without legal license issued on a smartcard or on a cryptographic token and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 1 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the smartcard element. Yes
profile REPESPJqscd Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organization_email The organization email Yes
description One of the following options:
- Registro Mercantil: Reg: XXX /Hoja: XXX /Tomo:XXX /Sección:XXX /Libro:XXX /Folio:XXX /Fecha: dd-mm-aaaa /Inscripción: XXX.
- Poder Notarial: Notario: Nombre Apellido1 Apellido2 /Núm Protocolo: XXX /Fecha Otorgamiento: dd-mm-aaaa.
- Boletines Oficiales: Boletín: XXX /Fecha: dd-mm-aaaa /Numero resolución: XXX.
- Otros: Documento: XXX /Fecha: dd-mm-aaaa
Yes
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
subscriber_responsible_serial The organization representative document number No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

REPESPJnubeQ

Certificate of representative of entity without legal license, suitable to relate with the Spanish Public Administrations, issued in the centralized custody system of Uanataca certificates and intended for authentication and qualified electronic signature.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile REPESPJnubeQ Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organization_email The organization email Yes
description One of the following options:
- Registro Mercantil: Reg: XXX /Hoja: XXX /Tomo:XXX /Sección:XXX /Libro:XXX /Folio:XXX /Fecha: dd-mm-aaaa /Inscripción: XXX.
- Poder Notarial: Notario: Nombre Apellido1 Apellido2 /Núm Protocolo: XXX /Fecha Otorgamiento: dd-mm-aaaa.
- Boletines Oficiales: Boletín: XXX /Fecha: dd-mm-aaaa /Numero resolución: XXX.
- Otros: Documento: XXX /Fecha: dd-mm-aaaa
Yes
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
subscriber_responsible_serial The organization representative document number No
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No
organization_url The organization web url No

SELLOPJnube

Electronic seal certificate issued in the centralized custody system of Uanataca certificates and intended for electronic signature, usually in unassisted processes.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile SELLOPJnube Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
responsible_email The responsible email No
organization_email The organization email Yes
process_application The application name that will use the certificate Yes
description A description Yes
representation The cardholder legal representation document Yes
empowerment The cardholder legal representation level Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No

SELLOPJsoft

Electronic seal certificate issued in a cryptographic container in P12 format and intended for electronic signature, usually in unassisted processes.

Field Value Description Mandatory
secure_element 0 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile SELLOPJsoft Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
responsible_email The responsible email No
organization_email The organization email Yes
process_application Yes
description A description No
representation The cardholder legal representation document Yes
empowerment The cardholder legal representation level Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No

SELLOPJnubeQ

Electronic seal certificate issued in the centralized custody system of Uanataca certificates and intended for the qualified electronic signature, usually in unassisted processes.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud one. Yes
profile SELLOPJnubeQ Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
responsible_email The responsible email No
organization_email The organization email Yes
process_application Yes
description A description No
representation The cardholder legal representation document Yes
empowerment The cardholder legal representation level Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No

SELLOPJqscd

Electronic seal certificate, issued on a smartcard or a cryptographic token and intended for the electronic signature.

Field Value Description Mandatory
secure_element 1 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the smartcard one. Yes
profile SELLOPJqscd Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
responsible_email The responsible email No
organization_email The organization email Yes
process_application The application name that will use the certificate Yes
description A description No
representation The cardholder legal representation document Yes
empowerment The cardholder legal representation level Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No

SELLOMedio

Electronic seal certificate for Spanish Public Administrations, intended for advanced electronic signature, generally in unattended processes, and issued issued in cryptographic container format P12.

Field Value Description Mandatory
secure_element [0, 2] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the software element. Yes
profile SELLOMedio Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organizational_unit_1 SELLO ELECTRONICO The cardholder first organizational unit Yes
organizational_unit_2 The cardholder second organizational unit No
organizational_unit_3 The cardholder third organizational unit No
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
responsible_email The responsible email No
organization_email The organization email Yes
process_application The application name that will use the certificate Yes
description A description No
representation The cardholder legal representation document Yes
empowerment The cardholder legal representation level Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No

SELLOAlto

Electronic seal certificate for Spanish Public Administrations, intended for the electronic signature usually qualified in unattended processes, and issued on a cryptographic card or token.

Field Value Description Mandatory
secure_element 1 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the smartcard one. Yes
profile SELLOAlto Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organizational_unit_1 SELLO ELECTRONICO The cardholder first organizational unit Yes
organizational_unit_2 The cardholder second organizational unit No
organizational_unit_3 The cardholder third organizational unit No
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
responsible_email The responsible email No
organization_email The organization email Yes
process_application The application name that will use the certificate Yes
description A description No
representation The cardholder legal representation document Yes
empowerment The cardholder legal representation level Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No

SelloOrganoAltoNubeQ

Electronic seal certificate for Spanish Public Administrations, intended for the electronic signature usually qualified in unattended processes, and issued in the centralized custody system of Uanataca certificates.

Field Value Description Mandatory
secure_element 2 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud one. Yes
profile SelloOrganoAltoNubeQ Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organizational_unit_1 SELLO ELECTRONICO The cardholder first organizational unit Yes
organizational_unit_2 The cardholder second organizational unit No
organizational_unit_3 The cardholder third organizational unit No
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
responsible_email The responsible email No
organization_email The organization email Yes
process_application The application name that will use the certificate Yes
description A description No
representation The cardholder legal representation document Yes
empowerment The cardholder legal representation level Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No

Peru

ProfileDescriptionElement
PEPNCiudadanoNatural personSoftware/Smartcard/Token
PEPNPertenecienteNatural person belonging to an organizationSoftware/Smartcard/Token
PEPNRepresentanteLegal entity representativeSoftware/Smartcard/Token
PEPNColegiadoNatural person belonging to a professional associationSoftware/Smartcard/Token
PEFacturacionLegal entity for electronic invoicingSoftware/Smartcard/Token
PESElectronicoLegal entity for unassisted signatureCloud/Software/Smartcard/Token

PEPNCiudadano

Certificate of natural person, destined to authentication and digital signature.

Field Value Description Mandatory
secure_element [0, 1] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile PEPNCiudadano Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number No
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. DNI – National identity document. CEX - Immigration Card. PAS - Passport. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes

PEPNPerteneciente

Certificate of a natural person belonging to or linked to a company or organization, intended for authentication and digital signature.

Field Value Description Mandatory
secure_element [0, 1] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile PEPNPerteneciente Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number No
id_document_type [DNI,CEX,PAS] The cardholder Id Document Type. DNI – National identity document. CEX - Immigration Card. PAS - Passport. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_number The cardholder document number No
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
organization_name The organization name Yes
organization_identifier The organization identifier Yes
organization_email The organization email Yes
id_responsible_document_type [DNI,CEX,PAS] The responsible document type. DNI – National identity document. CEX - Immigration Card. PAS - Passport. Yes
id_responsible_document_country ISO 3166-1 alpha-2 The responsible document country Yes
id_responsible_document_number The responsible document number No
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No

PEPNRepresentante

Certificate of legal entity representative, intended for authentication and digital signature.

Field Value Description Mandatory
secure_element [0, 1] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile PEPNRepresentante Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number No
id_document_type [DNI,CEX,PAS] The cardholder Id Document Type. DNI – National identity document. CEX - Immigration Card. PAS - Passport. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_number The cardholder document number No
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
organization_name The organization name Yes
organization_identifier The organization identifier Yes
organization_email The organization email Yes

PEPNColegiado

Certificate of a natural person linked to a professional association, destined to authentication and digital signature.

Field Value Description Mandatory
secure_element [0, 1] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile PEPNColegiado Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number No
id_document_type [DNI,CEX,PAS] The cardholder Id Document Type. DNI – National identity document. CEX - Immigration Card. PAS - Passport. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_number The cardholder document number No
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
organizational_unit_1 Colegiado The cardholder first organizational unit Yes
organizational_unit_2 The cardholder second organizational unit Yes
organizational_unit_3 The cardholder third organizational unit No
title The cardholder professional title Yes
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
organization_name The organization name Yes
organization_identifier The organization identifier Yes
organization_email The organization email Yes
id_responsible_document_type [DNI,CEX,PAS] The responsible document type. DNI – National identity document. CEX - Immigration Card. PAS - Passport. Yes
id_responsible_document_country ISO 3166-1 alpha-2 The responsible document country Yes
id_responsible_document_number The responsible document number No
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No

PEFacturacion

Certificate of legal entity, intended only for electronic invoicing processes.

Field Value Description Mandatory
secure_element [0, 1] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile PEFacturacion Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number No
id_document_type [DNI,CEX,PAS] The cardholder Id Document Type. DNI – National identity document. CEX - Immigration Card. PAS - Passport. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_number The cardholder document number No
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
title The cardholder professional title Yes
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
organization_name The organization name Yes
organization_identifier The organization identifier Yes
organization_city The organization city Yes
organizational_unit_1 The cardholder first organizational unit Yes
organizational_unit_2 The cardholder second organizational unit No

PESElectronico

Certificado de persona jurídica, destinado a procesos de firma desasistidos dentro de una empresa u organización.

Field Value Description Mandatory
secure_element [0, 1, 2] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile PESElectronico Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
smartcard_sn The smartcard serial number No
organization_name The organization name Yes
organization_identifier The organization identifier Yes
process_application The application name that will use the certificate Yes
organization_email The organization email Yes
id_document_type [DNI,CEX,PAS] The cardholder Id Document Type. DNI – National identity document. CEX - Immigration Card. PAS - Passport. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_number The cardholder document number No
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes

Global

ProfileDescriptionElement
PFSoftNCNatural personSoftware
PFnubeNCNatural personCloud/Smartcard/Token
SELLOsoftNCElectronic sealSoftware
SELLOnubeNCElectronic sealCloud/Smartcard/Token
REPnubeNCNatural person representativeCloud
REPsoftNCNatural person representativeSoftware/Smartcard/Token

PFSoftNC

Certificate of a natural person issued on a cryptographic container in P12 format and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element 0 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the software element. Yes
profile PFSoftNC Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
id_document_number The cardholder document number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No

PFnubeNC

Certificate of a natural person issued in the centralized custody system of Uanataca certificates or on a smartcard or a cryptographic token, and intended for authentication and electronic signature.

Field Value Description Mandatory
secure_element [1, 2] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile PFnubeNC Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
id_document_number The cardholder document number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No

SELLOsoftNC

Electronic seal certificate issued in a cryptographic container in P12 format and intended for electronic signature, usually in unassisted processes.

Field Value Description Mandatory
secure_element 0 Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
profile SELLOsoftNC Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
responsible_email The responsible email No
organization_email The organization email Yes
process_application Yes
description A description No
representation The cardholder legal representation document Yes
empowerment The cardholder legal representation level Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No

SELLOnubeNC

Electronic seal certificate issued in the centralized custody system of Uanataca certificates or on a smartcard or a cryptographic token, and intended for electronic signature, usually in unassisted processes.

Field Value Description Mandatory
secure_element [1, 2] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. This profile only allows the cloud element. Yes
profile SELLOnubeNC Represents the profile of the request Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
registration_authority The Registration Authority id Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
serial_number The cardholder serial number Yes
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
organization_country The organization country Yes
organization_identifier The organization identifier Yes
organization_name The organization name Yes
organizational_unit_1 The cardholder first organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
responsible_serial The responsible serial number Yes
responsible_email The responsible email No
organization_email The organization email Yes
process_application The application name that will use the certificate Yes
description A description Yes
representation The cardholder legal representation document Yes
empowerment The cardholder legal representation level Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_postal_code The organization postal code No

REPsoftNC

Certificate of legal entity representative, suitable for the relationship between Spanish or European companies, for authentication and electronic signature issued in cryptographic container format P12.

Field Value Description Mandatory
registration_authority The Registration Authority id Yes
organization_identifier The organization identifier Yes
organization_email The organization email Yes
subscriber_responsible_serial The organization representative document number No
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
description A description Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
profile REPsoftNC Represents the profile of the request Yes
secure_element [0, 1] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
citizen_tax_number The citizen tax number No
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
sex The cardholder sex No
birth_city The cardholder city of residence No
birth_province The cardholder province of residence No
birth_state The cardholder state of residence No
birth_district The cardholder district of residence No
birth_canton The cardholder canton code of residence No
serial_number The cardholder serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
title The cardholder professional title No
organizational_unit_1 The cardholder first organizational unit No
organizational_unit_2 The cardholder second organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
fix_phone_number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_name The organization name Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_country The organization country Yes
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

REPnubeNC

Certificate of legal entity representative, suitable for the relationship between Spanish or European companies, for the qualified electronic signature, and issued in the centralized custody system of Uanataca certificates.

Field Value Description Mandatory
registration_authority The Registration Authority id Yes
organization_identifier The organization identifier Yes
organization_email The organization email Yes
subscriber_responsible_serial The organization representative document number No
empowerment The cardholder legal representation level Yes
representation The cardholder legal representation document Yes
circumstances The cardholder legal conditions No
limit The cardholder ristrict of representation No
registration The cardholder representation registry data No
description A description Yes
scratchcard The scratchcard serial number that will be associated to the Request Yes
profile REPnubeNC Represents the profile of the request Yes
secure_element [2] Represents the device where the keys will be enrolled and can assume the values of 0, 1 or 2 that respectively are Software, Smartcard and Cloud. Yes
validity_time [1,3,365,730,1095,1825] It's the certificate validity expressed in days Yes
citizen_tax_number The citizen tax number No
given_name The cardholder given name Yes
surname_1 The cardholder first surname Yes
surname_2 The cardholder second surname No
sex The cardholder sex No
birth_city The cardholder city of residence No
birth_province The cardholder province of residence No
birth_state The cardholder state of residence No
birth_district The cardholder district of residence No
birth_canton The cardholder canton code of residence No
serial_number The cardholder serial number Yes
id_document_type [IDC,PAS,PNO,TIN] The cardholder Id Document Type. IDC - Identification based on national identity card number. PAS - Identification based on passport number. PNO - Identification based on (national) personal number (national civic registration number). TIN - Tax Identification Number according to the European Commission. Yes
id_document_country ISO 3166-1 alpha-2 The cardholder id document country Yes
id_document_description The cardholder document description No
id_document_issuer The cardholder document issuer No
title The cardholder professional title No
organizational_unit_1 The cardholder first organizational unit No
organizational_unit_2 The cardholder second organizational unit No
email The cardholder email Yes
mobile_phone_number The cardholder mobile phone number Yes
fix_phone_number No
residence_address The cardholder address of residence No
residence_city The cardholder city of residence No
residence_province The cardholder province of residence No
residence The cardholder country of residence No
residence_postal_code The cardholder postal code of residence No
residence_state The cardholder state of residence No
residence_district The cardholder district of residence No
residence_canton The cardholder canton code of residence No
organization_name The organization name Yes
responsible_name The name of the organization representative Yes
responsible_first_surname The first surname of the organization representative Yes
responsible_second_surname The second of the organization representative No
organization_address The organization address No
organization_city The organization city No
organization_province The organization province No
organization_country The organization country Yes
organization_postal_code The organization postal code No
organization_state The organization state No
organization_url The organization web url No

Postman collection

A postman collection is available as a support for a quick start.

Registration Authority Postman collection download

Postman settings

It is required to add the authentication API certificate provided according to the environment. The certificates are added in:

Postman settings > Certificates > Client certificates

The required fields are:

host and port: The endpoint host and port regarding the environment

  • api.sandbox.uanataca.com in port 443 for sandbox environment
  • api.uanataca.com in port 443 for production environment

CRT file: the file containing the public certificate

KEY file: the file containing the certificate private key


API Reference

Registration Authority

A Registration Authority (RA) is an organization delegated by a Certification Authority allowed to manage the life-cyle of digital certificates.
MethodEndpointAction
POST/registrationauthorities/Create a new Registration Authority
GET/registrationauthorities/List all Registration Authorities
GET/registrationauthorities/{id}/Get data from a specific Registration Authority
PUT/registrationauthorities/{id}/Update info about a Registration Authority

CREATE RA

Create a new registration authority.

Request
Request Body schema: application/json
name
required
string

The RA name

parent
required
string

The RA parent unique id

enabled_from
string

The date when the RA will be enabled from (the format is YYYY-MM-DD)

enabled_until
string

The date when the RA will be no longer enabled (the format is YYYY-MM-DD)

organization_tax_number
string

The tax number of the organization

organization_name
string

The organization name

responsible_name
string

The RA responsible given name

responsible_first_surname
string

The RA responsible first surname

responsible_second_surname
string

The RA responsible second surname

responsible_serial
string

The RA responsible serial number

email
string

A valid email address

fix_phone_number
string

A mobile phone number

address
string

The city address

city
string

The city where the RA is located

postal_code
string

The postal code of the city where the RA is located

province
string

The province of the city where the RA is located

url
string

A web url of the RA

country
string

The country where the RA is located

enable_external_auth
boolean

VideoID external authentication mode enabling/disabling check

videoid_enabled
boolean

VideoID enabling/disabling check

videoid_provider
integer

VideoID provider indicator

Responses
200

Successful Response

400

Bad Request

500

Invalid or missing parameters | Permission denied

post/api/v1/registrationauthorities
Request samples
application/json
{
  • "name": "string",
  • "parent": "string",
  • "enabled_from": "string",
  • "enabled_until": "string",
  • "organization_tax_number": "string",
  • "organization_name": "string",
  • "responsible_name": "string",
  • "responsible_first_surname": "string",
  • "responsible_second_surname": "string",
  • "responsible_serial": "string",
  • "email": "string",
  • "fix_phone_number": "string",
  • "address": "string",
  • "city": "string",
  • "postal_code": "string",
  • "province": "string",
  • "url": "string",
  • "country": "string",
  • "enable_external_auth": true,
  • "videoid_enabled": true,
  • "videoid_provider": 0
}
Response samples
application/json
{
  • "pk": 121,
  • "name": "RA Name",
  • "parent": 1,
  • "operators": [ ],
  • "enabled_from": "2020-07-20",
  • "enabled_until": "2025-07-20",
  • "organization_tax_number": "43242414213",
  • "organization_name": "Name_Org",
  • "responsible_name": "Name_Resp",
  • "responsible_first_surname": "Sur1_Resp",
  • "responsible_second_surname": "Sur2_Resp",
  • "responsible_serial": "X1111111C",
  • "email": "mail@domain.com",
  • "fix_phone_number": "+34333333333",
  • "mobile_phone_number": "+34555555555",
  • "city": "City Name",
  • "postal_code": "1000000",
  • "province": "Province_Name",
  • "address": null,
  • "state": null,
  • "country": "ES",
  • "enable_external_auth": false,
  • "videoid_enabled": true,
  • "videoid_provider": 2
}

LIST RAs

Get the list of registration authorities

Responses
200

Successful Response

get/api/v1/registrationauthorities
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/registrationauthorities/
Response samples
application/json
{
  • "count": 40,
  • "previous": null,
  • "results": [
    ]
}

GET RA

Gets data from a specific RA.

Request
path Parameters
id
required
string

The id of the registration authority

Responses
200

Successful Response

500

Invalid RA

get/api/v1/registrationauthorities/{id}
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/registrationauthorities/121/
Response samples
application/json
{
  • "pk": 121,
  • "name": "RA Name",
  • "parent": null,
  • "operators": [
    ]
}

UPDATE RA

Update the info about a registration authority.

Request
path Parameters
id
required
string

The id of the registration authority

Request Body schema: application/json
name
required
string

The RA name

parent
required
string

The RA parent unique id

enabled_from
string

The date when the RA will be enabled from (the format is YYYY-MM-DD)

enabled_until
string

The date when the RA will be no longer enabled (the format is YYYY-MM-DD)

organization_tax_number
string

The tax number of the organization

organization_name
string

The organization name

responsible_name
string

The RA responsible given name

responsible_first_surname
string

The RA responsible first surname

responsible_second_surname
string

The RA responsible second surname

responsible_serial
string

The RA responsible serial number

email
string

A valid email address

fix_phone_number
string

A mobile phone number

address
string

The city address

city
string

The city where the RA is located

postal_code
string

The postal code of the city where the RA is located

province
string

The province of the city where the RA is located

url
string

A web url of the RA

country
string

The country where the RA is located

enable_external_auth
boolean

VideoID external authentication mode enabling/disabling check

videoid_enabled
boolean

VideoID enabling/disabling check

videoid_provider
integer

VideoID provider indicator

Responses
200

Successful Response

400

Bad Request

500

Invalid or missing parameters

put/api/v1/registrationauthorities/{id}
Request samples
application/json
{
  • "name": "string",
  • "parent": "string",
  • "enabled_from": "string",
  • "enabled_until": "string",
  • "organization_tax_number": "string",
  • "organization_name": "string",
  • "responsible_name": "string",
  • "responsible_first_surname": "string",
  • "responsible_second_surname": "string",
  • "responsible_serial": "string",
  • "email": "string",
  • "fix_phone_number": "string",
  • "address": "string",
  • "city": "string",
  • "postal_code": "string",
  • "province": "string",
  • "url": "string",
  • "country": "string",
  • "enable_external_auth": true,
  • "videoid_enabled": true,
  • "videoid_provider": 0
}
Response samples
application/json
{
  • "pk": 121,
  • "name": "RA Name",
  • "parent": 1,
  • "operators": [ ],
  • "enabled_from": "2020-07-20",
  • "enabled_until": "2028-07-20",
  • "organization_tax_number": "43242414213",
  • "organization_name": "Name_Org",
  • "responsible_name": "Name_Resp",
  • "responsible_first_surname": "Sur1_Resp",
  • "responsible_second_surname": "Sur2_Resp",
  • "responsible_serial": "X1111111C",
  • "email": "new_mail@domain.com",
  • "fix_phone_number": "+34333333333",
  • "mobile_phone_number": "+34555555555",
  • "city": "City Name",
  • "postal_code": "1000000",
  • "province": "Province_Name",
  • "address": null,
  • "state": null,
  • "country": "ES",
  • "enable_external_auth": false
}

Registration Authority Officer

A Registration Authority Officer (RAO) is a role responsible for managing requests and verify its content.
MethodEndpointAction
POST/rao/Create a new Registration Authority Officer
GET/rao/List all Registration Authority Officers
GET/rao/{id}/Get data from a specific Registration Authority Officer
PUT/rao/{id}/Update info about a Registration Authority Officer

CREATE RAO

Create a new registration authority officer.

Request
Request Body schema: application/json
registration_authority_master
required
string

The registration authority master id

registration_authority
required
string

The list of the RAs where the RAO can operate

certificate
required
string

The Request certificate in Base64 format

given_name
required
string

The RAO's name

surname_1
required
string

The RAO's first surname

surname_2
string

The RAO's second surname

id_document_number
string

The RAO's document number

id_document_issuer
string

The document issuer

email
string

A valid email address

Responses
200

Successful Response

400

Bad Request

500

Invalid or missing parameters | Permission denied

post/api/v1/rao
Request samples
application/json
{
  • "registration_authority_master": "string",
  • "registration_authority": "string",
  • "certificate": "string",
  • "given_name": "string",
  • "surname_1": "string",
  • "surname_2": "string",
  • "id_document_number": "string",
  • "id_document_issuer": "string",
  • "email": "string"
}
Response samples
application/json
{
  • "pk": 1400,
  • "given_name": "RAO_Name",
  • "surname_1": "RAO_Surname1",
  • "surname_2": "RAO_Surname2",
  • "certificate": {
    },
  • "id_document_number": "Y8888888E",
  • "id_document_description": null,
  • "id_document_issuer": null,
  • "registration_authority": [
    ],
  • "registration_authority_master": 1,
  • "is_identificator": false
}

LIST RAOs

Get the list of RAOs. The result can be filtered with the following query parameters: given_name, surname_1, surname_2, certificate, registration_authority, registration_authority_master

Request
query Parameters
filter1
string

Filter string

filter2
string

Filter string

filterN
string

Filter string

Responses
200

Successful Response

get/api/v1/rao
Request samples
curl -i -X GET \
  'https://api.uanataca.com/api/v1/rao?filter1=registration_authority&filter2=given_name'
Response samples
application/json
{
  • "count": 25,
  • "next": "null",
  • "previous": null,
  • "results": [
    ]
}

GET RAO

Get information about a RAO.

Request
path Parameters
id
required
string

The RAO's unique identifier

Responses
200

Successful Response

500

Invalid RAO

get/api/v1/rao/{id}
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/rao/1400/
Response samples
application/json
{
  • "pk": 219,
  • "given_name": "RAO_Name",
  • "surname_1": "RAO_Surname1",
  • "surname_2": "RAO_Surname2",
  • "certificate": {
    },
  • "id_document_number": "12354232414",
  • "id_document_description": null,
  • "id_document_issuer": null,
  • "registration_authority": [
    ],
  • "registration_authority_master": 1,
  • "is_identificator": false
}

UPDATE RAO

Update information about a RAO.

Request
Request Body schema: application/json
registration_authority_master
required
string

The registration authority master id

registration_authority
required
string

The list of the RAs where the RAO can operate

certificate
required
string

The Request certificate in Base64 format

given_name
required
string

The RAO's name

surname_1
required
string

The RAO's first surname

surname_2
string

The RAO's second surname

id_document_number
string

The RAO's document number

id_document_issuer
string

The document issuer

email
string

A valid email address

Responses
200

Successful Response

400

Bad Request

500

Invalid or missing parameters | Permission denied

put/api/v1/rao/{id}
Request samples
application/json
{
  • "registration_authority_master": "string",
  • "registration_authority": "string",
  • "certificate": "string",
  • "given_name": "string",
  • "surname_1": "string",
  • "surname_2": "string",
  • "id_document_number": "string",
  • "id_document_issuer": "string",
  • "email": "string"
}
Response samples
application/json
{
  • "pk": 1400,
  • "given_name": "RAO_NewName",
  • "surname_1": "RAO_Surname1",
  • "surname_2": "RAO_Surname2",
  • "certificate": {
    },
  • "id_document_number": "Y8888888E",
  • "id_document_description": null,
  • "id_document_issuer": null,
  • "registration_authority": [
    ],
  • "registration_authority_master": 1,
  • "is_identificator": false
}

Users

A user is the account having access to the Registration Authority platform according to its permissions.
MethodEndpointAction
POST/users/Create a new user
GET/users/List all users
GET/users/{id}/Get data from a specific user
PUT/users/{id}/Update info about a user

CREATE USER

Create a new user.

Request
Request Body schema: application/json
registration_authority
required
string

The registration authority id

permission_profile
required
string

The permission profile id that will be associated to this user

request
required
string

The request id

rao
required
string

The RAO id

Responses
200

Successful Response

400

Bad Request

500

Invalid or missing parameters | Permission denied

post/api/v1/users
Request samples
application/json
{
  • "registration_authority": "string",
  • "permission_profile": "string",
  • "request": "string",
  • "rao": "string"
}
Response samples
application/json
{
  • "pk": 221,
  • "permission_profile": 18,
  • "registration_authority": 1,
  • "request": 255
}

LIST USERS

Gets the list of users.

Responses
200

Successful Response

get/api/v1/users
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/users/
Response samples
application/json
{
  • "count": 7,
  • "previous": null,
  • "results": [
    ]
}

GET USER

Get information about an user.

Request
path Parameters
id
required
string

The User's unique identifier

Responses
200

Successful Response

500

Invalid or missing parameters | Permission denied

get/api/v1/users/{id}
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/users/36/
Response samples
application/json
{
  • "pk": 36,
  • "permission_profile": 18,
  • "registration_authority": 41,
  • "request": 787
}

UPDATE USER

Update a new user.

Request
path Parameters
id
required
string

The User's unique identifier

Request Body schema: application/json
registration_authority
required
string

The registration authority id

permission_profile
string

The permission profile id that will be associated to this user

request
string

The request id

rao
string

The RAO id

Responses
200

Successful Response

400

Bad Request

500

Invalid or missing parameters | Permission denied

put/api/v1/users/{id}
Request samples
application/json
{
  • "registration_authority": "string",
  • "permission_profile": "string",
  • "request": "string",
  • "rao": "string"
}
Response samples
application/json
{
  • "pk": 221,
  • "permission_profile": 18,
  • "registration_authority": 1,
  • "request": 150
}

Scratchcards

A scratchcard is a virtual card containing the initial secret codes of a digital certificate. Every request requires a scratchcard.
MethodEndpointAction
GET/scratchards/List all available scratchcards
GET/scratchards/{id}/Get data from a specific scratchcard
GET/scratchards/get_first_unused/Get first unused scratchcard
POST/scratchards/isused/Get the status of a scratchcard
POST/scratchards/revoke/Revoke, suspend or activate the digital certificate associated to a scratchcard
POST/scratchards/whoami/Get the request assocaited to a scratchcard
POST/scratchards/move/Move scratchcards from a Registration Authority to another one

LIST SCRATCHCARDS

Gets the list of scratchcards

Request
query Parameters
registration_authority
string

Registration authority number

sn
string

Number of scratchcard

Responses
200

Successful Response

400

Bad Request

get/api/v1/scratchcards
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/scratchcards/?registration_authority=123&sn=123456
Response samples
application/json
{
  • "count": 550,
  • "next": null,
  • "previous": null,
  • "results": [
    ]
}

GET SCRATCHCARD

Get details from a scratchcard.

Request
path Parameters
id
required
string

The scratchcard unique id

Responses
200

Successful Response

404

Invalid scratchcard id

get/api/v1/scratchcards/{id}
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/scratchcards/1045/
Response samples
application/json
{
  • "pk": 1045,
  • "sn": "1200948",
  • "secrets": "{\"erc\": \"8117606937\", \"enrollment_code\": \",8cj6Ax2\", \"pin\": \"85376977\", \"puk\": \"86175206\"}",
  • "registration_authority": 121
}

GET FIRST UNUSED SCRATCHCARD

Get first unused scratchcard.

Request
Request Body schema: application/json
ra
string

The registration authority id

Responses
200

Successful Response

400

Bad Request

get/api/v1/scratchcards/get_first_unused
Request samples
application/json
{
  • "ra": "string"
}
Response samples
application/json
{
  • "pk": 1193,
  • "sn": "1256948",
  • "secrets": "{\"erc\": \"6292998123\", \"enrollment_code\": \"_,463vt:\", \"pin\": \"08695572\", \"puk\": \"52351291\"}",
  • "registration_authority": 121
}

IS USED SCRATCHCARD

Get the status of a known scratchcard.

Request
Request Body schema: application/json
required
sn
string

The scratchcard id number

Responses
200

Successful Response

400

Bad Request

500

Invalid scratchcard id

post/api/v1/scratchcards/isused
Request samples
application/json
{
  • "sn": "string"
}
Response samples
text/plain
true

REVOKE SCRATCHCARD

Revoke, suspend or activate certificates associated to the request that use the specified scratchcard.

Request
Request Body schema: application/json
scratchcard
required
string

The scratchcard id number

erc
required
string

The scratchcard revocation code

reason
required
string

The reason associated to the scratchcard revocation:

  • UNSPECIFIED - Unspecified reason
  • KEYCOMPROMISE - Compromised keys
  • AFFILIATIONCHANGED - Affiliation changed
  • SUPERSEDED - Superseded
  • CESSATIONOFOPERATION - Ceased
  • PRIVILEGESWITHDRAWN - Privileges withdrawn

The reason to suspend or activate a certificate when this is suspended:

  • CERTIFICATEHOLD - Suspend a certificate
  • NOT_REVOKED - Activate a certificate that was suspended
Enum: "UNSPECIFIED" "KEYCOMPROMISE" "AFFILIATIONCHANGED" "SUPERSEDED" "CESSATIONOFOPERATION" "PRIVILEGESWITHDRAWN" "CERTIFICATEHOLD" "NOT_REVOKED"
Responses
200

Successful Response

400

Bad Request

412

Invalid or missing parameters

500

Invalid request id | Scratchcard has no associated request

post/api/v1/scratchcards/revoke
Request samples
application/json
{
  • "scratchcard": "string",
  • "erc": "string",
  • "reason": "UNSPECIFIED"
}
Response samples
application/json
[
  • {
    }
]

WHOAMI

Get the request associated to the scratchcard.

Request
Request Body schema: application/json
scratchcard
required
string

The scratchcard id number

erc
required
string

The scratchcard enrollment code (password for accessing Uanataca services)

Responses
200

Successful Response

400

Bad Request

412

Invalid or missing parameters

post/api/v1/scratchcards/whoami
Request samples
application/json
{
  • "scratchcard": "string",
  • "erc": "string"
}
Response samples
application/json
{
  • "pk": 25139,
  • "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": "ES",
  • "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": "PFnubeAFCiudadano",
  • "scratchcard": "5053349",
  • "status": "ENROLLREADY",
  • "registering_user": {
    },
  • "approving_user": {
    },
  • "producing_user": null,
  • "registration_authority": 41,
  • "secure_element": 2,
  • "validity_time": "730",
  • "smartcard_sn": "",
  • "citizen_tax_number": "",
  • "birth_date": null,
  • "birth_country": null,
  • "birth_city": "",
  • "birth_province": "",
  • "birth_state": "",
  • "birth_district": "",
  • "birth_canton": "",
  • "id_document_description": "",
  • "id_document_issuer": "",
  • "organization_rol": null,
  • "professional_id_number": null,
  • "mobile_phone_number": "+34600112233",
  • "fix_phone_number": "",
  • "residence_address": "",
  • "residence_city": "",
  • "residence_province": "",
  • "residence_postal_code": "",
  • "residence_state": "",
  • "residence_district": "",
  • "residence_canton": "",
  • "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": "",
  • "id_responsible_document_type": null,
  • "id_responsible_document_country": null,
  • "id_responsible_document_number": null,
  • "organizational_unit_3": null
}

MOVE SCRATCHCARDS

Move scratchcards from an ra to another one.

Request
Request Body schema: application/json
from_ra
required
string

The source RA id that will give the scratchcards

⚠ If from_ra/to_ra is used, from_sn/to_sn cannot be used

to_ra
required
string

The destination RA id that will receive the scratchcards

⚠ If from_ra/to_ra is used, from_sn/to_sn cannot be used

amount
required
string

The amount of scratchcards to be transferred

from_sn
required
string

The scratchcard starting id

⚠ If from_sn/to_sn is used, from_ra/to_ra cannot be used

to_sn
required
string

The scratchcard ending id

⚠ If from_sn/to_sn is used, from_ra/to_ra cannot be used

Responses
200

Successful Response

403

Permission denied

500

Bad Request (JSON syntax error)

post/api/v1/scratchcards/move
Request samples
application/json
{
  • "from_ra": "string",
  • "to_ra": "string",
  • "amount": "string",
  • "from_sn": "string",
  • "to_sn": "string"
}
Response samples
application/json
{
  • "moved": 1000
}

Requests

Manage digital certicate requests life-cycle.
MethodEndpointAction
POST/requests/Create a digital certificate request
GET/requests/List all requests
GET/requests/{id}/Get data from a request
PUT/requests/{id}/Update info about a request
DELETE/requests/{id}/cancel/Cancel a request
GET/requests/{id}/validate/Validate the request fields
POST/requests/generates_tbs_receipt/Generates a declaration for a request that must be signed by a RAO
POST/requests/{id}/generate_document/Generates a contract related to a request that must be signed by a RAO
POST/requests/{id}/pl_upload_document/Upload required documentation
POST/requests/{id}/pl_delete_document/Delete a document
POST/requests/{id}/pl_get_document/Retrieve a document
GET/requests/{id}/pl_get_documents/Retrieve all documents
POST/requests/{id}/pl_approve/Approve request
POST/requests/{id}/preauthlink/Get the certificate generation process pre-authenticated link
POST/requests/{id}/is_renewable/Check if a request certificate is renewable or not
POST/requests/{id}/enable_renewal/Enable the renewal option for a request's certificate
POST/requests/{id}/disable_renewal/Disable the renewal option for a request's certificate
POST/requests/{id}/renewal_status/Displays information about renewal status of a request
POST/requests/check_contact_data_limits/Checks if the given contact data is already in use
POST/requests/{id}/generate_otp_for_unlock/Send an OTP code for reset or unlock PIN
POST/requests/{id}/unlock_pin/Reset or unlock PIN

CREATE REQUEST

Creates a new request for digital certificate issuance.

⚠ Each certificate profile has its own set of fields. Please check the list of fields in the Certificate Profiles section.

Request
Request Body schema: application/json
profile
required
string

Certificate profile

validity_time
number

Validity time for the certificate (value in days). Values are subject to the certificate profile that is being used.

scratchcard
required
string

Available and unused scratchcard serial number. The first unused scratchcard serial number can be obtained in the Get first unused call

secure_element
string

Can be 0, 1 or 2 which stands respectively to Software, Smartcard and Cloud

registration_authority
required
string

The unique identifier (PK) of the RA (it's assigned when is created)

identification_rao
number

The ID of Operator in charge of identifying, this Operator has to be registered as 'Identification RAO' in the respective Registration Authority. You are able to check it through Get RAO call response, explicitly in is_identificator field. This field is required if the approval Operator is not the same as the identifier

country_name
string

The country where the RA is registered

serial_number
string

The user's document serial number

id_document_country
string

The user's id document country two-letters code (ISO 3166-1 alpha-2)

id_document_type
string

The user's document type

given_name
string

The user's given name

surname_1
string

The user's first surname

surname_2
string

The user's second surname

email
required
string

The user's email

mobile_phone_number
string

The user's mobile phone number

paperless_mode
number

This parameter must be included and set to 1 for a classic certificate request

videoid_mode
number

This parameter must be included and set to 1 for a Video ID certificate request

webhook_url
string

The webhook associated URL.

⚠ Not required for external authentication. See Webhook Configuration section

Responses
201

Successful Response

400

Bad Request

500

Invalid or missing parameters | Permission denied

post/api/v1/requests
Request samples
application/json
{
  • "profile": "string",
  • "validity_time": 0,
  • "scratchcard": "string",
  • "secure_element": "string",
  • "registration_authority": "string",
  • "identification_rao": 0,
  • "country_name": "string",
  • "serial_number": "string",
  • "id_document_country": "string",
  • "id_document_type": "string",
  • "given_name": "string",
  • "surname_1": "string",
  • "surname_2": "string",
  • "email": "string",
  • "mobile_phone_number": "string",
  • "paperless_mode": 0,
  • "videoid_mode": 0,
  • "webhook_url": "string"
}
Response samples
application/json
{
  • "pk": 25139,
  • "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": "PFnubeAFCiudadano",
  • "scratchcard": "5053349",
  • "status": "CREATED",
  • "registering_user": {
    },
  • "approving_user": null,
  • "producing_user": null,
  • "registration_authority": 68,
  • "secure_element": 2,
  • "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": "+34600112233",
  • "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": null,
  • "producing_rao": null,
  • "id_document_number": null
}

LIST REQUESTS

Retrieves the list of requests stored. Path parameters are only necessary if an explicit filter is wanted.

Request
path Parameters
scratchcard
required
string

Number of scratchcard

given_name
required
string

Name

surname_1
required
string

First surname

surname_2
required
string

Last surname

serial_number
required
string

Document number

email
required
string

Email of the certificate owner

mobile_phone_number
required
string

Phone number of the certificate owner

registration_authority
required
string

Registration Authority number where certificate belongs

Responses
200

Successful Response

get/api/v1/requests
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/requests/
Response samples
application/json
{
  • "count": 87,
  • "previous": null,
  • "results": [
    ]
}

GET REQUEST

Returns full information about a request.

Request
path Parameters
id
required
string

The unique identifier of the request

Responses
200

Successful Response

404

Invalid request id

get/api/v1/requests/{id}
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/requests/25139/
Response samples
application/json
{
  • "pk": 25139,
  • "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": "PFnubeAFCiudadano",
  • "scratchcard": "5051762",
  • "status": "ISSUED",
  • "registering_user": {
    },
  • "approving_user": {
    },
  • "producing_user": {
    },
  • "registration_authority": 504,
  • "secure_element": 2,
  • "validity_time": "365",
  • "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": "+34600112233",
  • "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": {
    },
  • "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": true,
  • "ext_recognition_data": null,
  • "complement_number": null,
  • "id_responsible_document_issuer": null,
  • "provider_registration_number": null,
  • "communication_language": "",
  • "identification_rao": null
}

UPDATE REQUEST

Updates information about a request.

Request
path Parameters
id
required
string

The unique identifier of the Request

Request Body schema: application/json
profile
required
string

Certificate profile

scratchcard
required
string

Available and unused scratchcard serial number. The first unused scratcard serial number can be obtained in the Get first unused call

secure_element
string

Can be 0, 1 or 2 which stands respectively to Software, Smartcard and Cloud

registration_authority
required
string

The unique identifier (PK) of the RA (it's assigned when is created)

country_name
required
string

The country where the RA is registered

serial_number
string

The user's document serial number

id_document_country
string

The user's id document country two-letters code (ISO 3166-1 alpha-2)

id_document_type
string

The user's document type

given_name
string

The user's given name

surname_1
string

The user's first surname

surname_2
string

The user's second surname

email
required
string

The user's email

mobile_phone_number
string

The user's mobile phone number

paperless_mode
number

This parameter must be included and set to 1 for a classic certificate request

videoid_mode
number

This parameter must be included and set to 1 for a Video ID certificate request

Responses
200

Successful Response

400

Bad Request

404

Request id not found

412

Already approved request

500

Invalid or missing parameters | Permission denied

put/api/v1/requests/{id}
Request samples
application/json
{
  • "profile": "string",
  • "scratchcard": "string",
  • "secure_element": "string",
  • "registration_authority": "string",
  • "country_name": "string",
  • "serial_number": "string",
  • "id_document_country": "string",
  • "id_document_type": "string",
  • "given_name": "string",
  • "surname_1": "string",
  • "surname_2": "string",
  • "email": "string",
  • "mobile_phone_number": "string",
  • "paperless_mode": 0,
  • "videoid_mode": 0
}
Response samples
application/json
{
  • "pk": 25139,
  • "given_name": "Name",
  • "surname_1": "Surname1",
  • "surname_2": "New_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": "New_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": "PFnubeAFCiudadano",
  • "scratchcard": "5053349",
  • "status": "CREATED",
  • "registering_user": {
    },
  • "approving_user": null,
  • "producing_user": null,
  • "registration_authority": 68,
  • "secure_element": 2,
  • "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": "+34600112233",
  • "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": null,
  • "producing_rao": null,
  • "id_document_number": null
}

CANCEL REQUEST

Change the request status to CANCELLED. Requests can be cancelled only if the digital certificate is not issued yet.

Request
path Parameters
id
required
string

The unique identifier of the Request

Responses
200

Successful Response

404

Invalid request id

412

Already approved/cancelled request id

delete/api/v1/requests/{id}/cancel
Request samples
curl -i -X DELETE \
  https://api.uanataca.com/api/v1/requests/25139/cancel/
Response samples
application/json
{
  • "status": "Request cancelled"
}

VALIDATE REQUEST

Validate the request fields.

Request
path Parameters
id
required
string

The unique identifier of the Request

Responses
200

Successful Response

404

Invalid request id

412

Already approved request id

get/api/v1/requests/{id}/validate
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/requests/25139/validate/
Response samples
application/json
[
  • [
    ],
  • [
    ]
]

GENERATE RAO DECLARATION

Generates a declaration related to a request that must be signed by a RAO.
The receipt is signed in the Approve Request call.

Request
path Parameters
id
required
string

The unique identifier of the Request

Request Body schema: application/json
rao
required
string

The unique identifier of the RAO that will sign and approve the request

type
required
string

The type of the receipt to generate

Value: "APPROVE"
Responses
200

Successful Response

400

Bad Request

404

Invalid request id

post/api/v1/requests/{id}/generates_tbs_receipt
Request samples
application/json
{
  • "rao": "string",
  • "type": "APPROVE"
}
Response samples
application/json
{
  • "serial_number": "3ef3696d2939241d",
  • "receipt": "El operador RAO_Name RAO_Surname1 con número de identificación 12345678P\r\nactuando en calidad de operador autorizado de registro del prestador de servicios\r\nde confianza UANATACA, S.A. con NIF A66721499, (UANATACA en lo sucesivo)\r\n\r\nDECLARA\r\n\r\nQue previa verificación de acuerdo a la Declaración de Prácticas de UANATACA\r\npublicadas en www.uanataca.com, la información detallada a continuación es\r\ncorrecta y será incluida (donde aplicable) en la solicitud de certificados\r\ncualificados:\r\n\r\n- Datos de Identificación de la solicitud de certificados: 36893\r\n- Nombre y Apellidos del Firmante: Name Surname1 Surname2\r\n- DNI/NIE/PASAPORTE del Firmante: 11111111B\r\n- Dirección de correo electrónico del Firmante: mail@domain.com\r\n\r\n\r\n18/03/2021\r\n\r\n\r\n\r\n--------------------------------------------------------------------\r\nFdo. User Admin\r\nOperador autorizado de registro"
}

GENERATE CONTRACT

Generates a contract associated to a request that must be signed by a RAO.
The contract is signed in the approve request call.

Request
path Parameters
id
required
string

The unique identifier of the Request

Request Body schema: application/json
doctype
string

The contract type

Enum: "contract" "contract_renew"
Responses
200

Successful Response

400

Bad Request

404

Invalid request id

post/api/v1/requests/{id}/generate_document
Request samples
application/json
{
  • "doctype": "contract"
}
Response samples
application/json
{
  • "document": "%PDF-1.4\n%���� ReportLab Generated PDF document http://www.reportlab.com\n1 0 obj\n<<\n/F1 2 0 R\n>>\nendobj\n2 0 obj\n<<\n/Bas (...) "
}

UPLOAD DOCUMENT

Upload the required documentation for certificate issuance.

Request
path Parameters
id
required
string

The unique identifier of the Request

Request Body schema: multipart/form-data
required
document
required
string

The file to be uploaded

type
required
string

The type of the document to be uploaded

Enum: "document_front" "document_rear" "document_owner" "extra_document"
Responses
201

Successful Response

404

Invalid request id

412

Precondition Failed

500

Internal server error

post/api/v1/requests/{id}/pl_upload_document
Request samples
curl -i -X POST \
  https://api.uanataca.com/api/v1/requests/25139/pl_upload_document/ \
  -H 'Content-Type: multipart/form-data' \
  -F document=@sample_folder/img_front.png \
  -F type=document_front
Response samples
application/json
{
  • "pk": 48312,
  • "type": "document_front"
}

DELETE DOCUMENT

Delete an identification document previously uploaded.

Request
path Parameters
id
required
string

The unique identifier of the Request

Request Body schema: multipart/form-data
required
docpk
required
string

The database primary key of the document to be deleted

Responses
200

Successful Response

404

Invalid document id

500

Missing parameter docpk

post/api/v1/requests/{id}/pl_delete_document
Request samples
curl -i -X POST \
  https://api.uanataca.com/api/v1/requests/25139/pl_delete_document/ \
  -H 'Content-Type: multipart/form-data' \
  -F docpk="document_front"
Response samples
application/json
{
  • "status": "Document deleted successfully"
}

GET A DOCUMENT

Retrieves a request's associated document in Base64 format.

Request
path Parameters
id
required
string

The unique identifier of the Request

Request Body schema: multipart/form-data
required
type
required
string

The type of the document to be retrieved

Enum: "document_front" "document_rear" "document_owner" "extra_document" "contract" "signed_contract"
rao_id
required
string

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

Responses
200

Successful Response

404

Invalid request id

post/api/v1/requests/{id}/pl_get_document
Request samples
curl -i -X POST \
  https://api.uanataca.com/api/v1/requests/25139/pl_get_document/ \
  -H 'Content-Type: multipart/form-data' \
  -F type="contract"
  -F rao_id="1400"
Response samples
application/json
[
  • {
    }
]

GET ALL DOCUMENTS

Retrieves all uploaded documents associated to a request.

Request
path Parameters
id
required
string

The unique identifier of the Request

Responses
200

Successful Response

404

Invalid request id

get/api/v1/requests/{id}/pl_get_documents
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/requests/25139/pl_get_documents/
Response samples
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

APPROVE REQUEST

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

Request
path Parameters
id
required
string

The unique identifier of the Request

Request Body schema: application/json
username
required
string

The RAO's username

password
required
string

The RAO's password

pin
required
string

The RAO's PIN

rao_id
required
string

The RAO's id

lang
string

The contract language

Responses
200

Successful Response

400

Bad Request

404

Not Found

412

Missing request parameters

500

Invalid RAO parameters

post/api/v1/requests/{id}/pl_approve
Request samples
application/json
{
  • "username": "string",
  • "password": "string",
  • "pin": "string",
  • "rao_id": "string",
  • "lang": "string"
}
Response samples
application/json
{
  • "secrets": {
    },
  • "request": {
    }
}

GET PRE-AUTHENTICATION LINK

Get the pre-authenticated link to start the online certificate generation process for a specific request.

Request
path Parameters
id
required
string

The unique identifier of the Request

Responses
200

Successful Response

403

Permission denied

404

Invalid request id

post/api/v1/requests/{id}/preauthlink
Request samples
curl -i -X POST \
  https://api.uanataca.com/api/v1/requests/25139/preauthlink/
Response samples
application/json

IS RENEWABLE

Find out about whether a request is renewable or not.

Request
Request Body schema: application/json
scratchcard
string

The scratchcard number of the request

erc
string

The scratchcard enrollment code of the request

Responses
200

Successful Response

400

JSON syntax error

412

Precondition Failed

post/api/v1/requests/is_renewable
Request samples
application/json
{
  • "scratchcard": "string",
  • "erc": "string"
}
Response samples
application/json
{
  • "torenew": {
    },
  • "renewed": false,
  • "request": {
    }
}

ENABLE RENEWAL

Activates the renewal option for a certificate

Request
path Parameters
id
required
string

The response status message

Responses
200

Successful Response

404

Not Found

412

Precondition Failed

post/api/v1/requests/{id}/enable_renewal
Request samples
curl -i -X POST \
  https://api.uanataca.com/api/v1/requests/25139/enable_renewal/
Response samples
application/json
{
  • "status": "Renewal enabled for request"
}

DISABLE RENEWAL

Deactivates the renewal option for a certificate

Request
path Parameters
id
required
string

The response status message

Responses
200

Successful Response

404

Invalid parameters

post/api/v1/requests/{id}/disable_renewal
Request samples
curl -i -X POST \
  https://api.uanataca.com/api/v1/requests/25139/disable_renewal/
Response samples
application/json
{
  • "status": "Renewal disabled for request"
}

GET RENEWAL STATUS

Displays information about renewal status of a request

Request
path Parameters
id
required
string

The response status message

Responses
200

Successful Response

get/api/v1/requests/{id}/renewal_status/
Request samples
Response samples
application/json
{
  • "request_is_renewable": false,
  • "renewal_enabled": false,
  • "reason": "Not yet enabled"
}

CHECK CONTACT DATA

Checks if the given contact data is already in use.

Request
Request Body schema: application/json
registration_authority
number

Registration authority number where the contact data it's going to be consulted.

serial_number
string

Serial number to check

email
string

Email address to check

mobile_phone_number
string

Mobile phone number to check

Responses
200

Successful Response

post/api/v1/requests/check_contact_data_limits/
Request samples
application/json
{
  • "registration_authority": 0,
  • "serial_number": "string",
  • "email": "string",
  • "mobile_phone_number": "string"
}
Response samples
{
  • "reason": "string",
  • "result": "string",
  • "registration_authority": 0
}

OTP FOR RESET/UNLOCK PIN

Sends an OTP code via SMS for PIN reset or unlock.

Request
path Parameters
id
required
string

The unique identifier of the Request

Responses
200

Successful Response

500

Invalid request id

post/api/v1/requests/{id}/generate_otp_for_unlock
Request samples
curl -i -X POST \
  https://api.uanataca.com/api/v1/requests/25139/generate_otp_for_unlock/
Response samples
application/json
{
  • "status": "success",
  • "message": "OTP sent via SMS"
}

RESET/UNLOCK PIN

Performs the PIN reset or unlock operation

Request
path Parameters
id
required
string

The unique identifier of the Request

Request Body schema: application/json
scratchcard
string

The scratchcard number (username) associated to the request

enrollment_code
string

The scratchcard enrollment code of the request

newpin
string

The new pin

otp
string

The OTP code sent to the user via SMS

Responses
200

Successful response

412

Invalid request id | parameters | invalid otp

500

JSON syntax error | Pin not locked

post/api/v1/requests/{id}/unlock_pin
Request samples
application/json
{
  • "scratchcard": "string",
  • "enrollment_code": "string",
  • "newpin": "string",
  • "otp": "string"
}
Response samples
application/json
{
  • "status": "success",
  • "message": "Pin unlocked successfully"
}

eIDAS VideoID

This allows the management of certificate issuing by establishing a video call for identity verification.
MethodEndpointAction
POST/requests/{id_request}/upload_videoid_evidenceUpload Documents

UPLOAD DOCUMENT

Upload the required documentation for certificate issuance.

Request
path Parameters
id_request
required
string

The unique identifier of the Request

Request Body schema: multipart/form-data
required
document
required
string

The file to be uploaded

label
required
string

Label assigned to document

Responses
201

Successful Response

post/api/v1/requests/{id_request}/upload_videoid_evidence
Request samples
Response samples
application/json
{
  • "pk": 48312,
  • "type": "videoid_evidence"
}

External VideoID

This allows the management of certificate issuing by uploading external evidences for identity verification.
MethodEndpointAction
POST/requests/{id_request}/validate_videoidValidate Video ID Request
POST/requests/{id_request}/refuse_videoidRefuse Request
POST/upload/data/{video_pk}/Upload data evidence
PUT/upload/video/{video_identifier}/Upload video
GET/download/video/{video_identifier}/Download video

VALIDATE VIDEO ID REQUEST

Validation of a Video ID Request

Request
path Parameters
id_request
required
string

The Request unique identifier

Request Body schema: application/json
username
required
string

The RAO's username

password
required
string

The RAO's password

pin
required
string

The RAO's pin

rao_id
required
string

The RAO's id

Responses
200

Successful Response

400

Bad Request | Invalid Request id

412

Invalid Request status for validation

500

Invalid or missing parameters | Permission denied

post/api/v1/requests/{id_request}/validate_videoid
Request samples
application/json
{
  • "username": "string",
  • "password": "string",
  • "pin": "string",
  • "rao_id": "string"
}
Response samples
application/json
{
  • "secrets": {
    },
  • "request": {
    }
}

REFUSE REQUEST

Refuse validation for a Video ID Request

Request
path Parameters
id_request
required
string

The Request unique identifier

Request Body schema: application/json
username
required
string

The RAO's username

password
required
string

The RAO's password

pin
required
string

The RAO's pin

rao_id
required
string

The RAO's id

Responses
200

Successful Response

400

Bad Request | Invalid Request id

412

Invalid Request status for validation

500

Invalid or missing parameters | Permission denied

post/api/v1/requests/{id_request}/refuse_videoid
Request samples
application/json
{
  • "username": "string",
  • "password": "string",
  • "pin": "string",
  • "rao_id": "string"
}
Response samples
application/json
{
  • "videoid_status": "REFUSED",
  • "reason": "testing the API"
}

UPLOAD DATA EVIDENCE

Upload Request associated data

Request
path Parameters
video_pk
required
string

The video request pk

Request Body schema: application/json
object

A set of acceptance parameters.

⚠ Customizable object for external authentication.

object

Data to upload for Video ID

⚠ Customizable object for external authentication.

Responses
200

Successful Response

put/api/v1/videoid/{video_pk}
Request samples
application/json
{
  • "acceptance": {
    },
  • "videoid_data": {
    }
}

UPLOAD VIDEO

Upload Request associated video

Request
path Parameters
video_identifier
required
string

Unique request video identifier

Request Body schema: multipart/form-data
required
video
required
string

The video to be uploaded

Responses
200

Successful Response

400

Bad Request | Invalid Request id

post/v1/upload/video/{video_identifier}
Request samples
curl -i -X POST \
  https://lima.uanataca.com/v1/upload/video/f8402ee3844b48a1a84aff69b48b \
  -H 'Content-Type: multipart/form-data' \
  -F video=@sample_folder/sample_video.mp4 
Response samples
application/json
{
  • "status": "200 OK"
}

DOWNLOAD VIDEO

Download mp4-format binary video file associated to a Request

Request
path Parameters
video_identifier
required
string

The Request unique identifier

Responses
200

Successful Response

get/api/v1/download/video/{video_identifier}
Request samples
curl -i -X GET \
  https://api.uanataca.com/api/v1/download/video/25139