UANATACA RA API DOCUMENTATION (v1)
| Table of Contents | ||
|---|---|---|
|
What it is
The Registration Authority (RA) solution to manage the entire digital certificates life cycle.
...
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.
...
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.
| Infonote |
|---|
⚠ 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 4: UPDATE OF THE REQUEST
| Infonote |
|---|
⚠ This step is required for all profiles except Natural Person |
...
Check the required fields for each certificate profile in eIDAS Certificate Profiles list.
API Reference: Update Request
| Code Block |
|---|
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
| Infonote |
|---|
⚠ This step is required for all profiles except Natural Person |
...
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:
...
| Code Block |
|---|
https://{host}/api/{version}/{resource}/ |
| Infonote |
|---|
⚠ Make sure the URL always ends with a forward slash ("/") |
...
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:
...
key | Description |
|---|---|
error | A string that describe the error occured |
code | The HTTP response code related. See table descriptions |
id | The unique identifier of the error generated by Uanataca |
In the API Reference are described the response structures for each API call.
...
Profile | Description | Element |
|---|---|---|
Natural person | Software | |
Natural person | Smartcard/Token | |
Natural person | Cloud | |
Natural person | Cloud-QSCD | |
Natural person belonging to an organization | Software | |
Natural person belonging to an organization | Smartcard/Token | |
Natural person belonging to an organization | Cloud | |
Natural person belonging to an organization | Cloud-QSCD | |
Natural person belonging to a professional association | Software | |
Natural person belonging to a professional association | Smartcard/Token | |
Natural person belonging to a professional association | Cloud | |
Natural person belonging to a professional association | Cloud-QSCD | |
Natural person representative | Software | |
Natural person representative (signature only) | Smartcard/Token | |
Natural person representative (signature only) | Cloud-QSCD | |
Natural person representative of legal person with the administration | Software | |
Natural person representative of legal person with the administration | Cloud | |
Natural person representative of legal person with the administration | Smartcard/Token | |
Natural person representative of legal person with the administration | Cloud-QSCD | |
Public employee - Medium level | Cloud/Software | |
Public employee signature - High level | Smartcard/Token | |
Public employee signature - High level | Cloud-QSCD | |
Natural person representative of entity without legal personality with the administrations | Software | |
Natural person representative of entity without legal personality with the administrations | Cloud | |
Natural person representative of entity without legal personality with the administrations | Smartcard/Token | |
Natural person representative of entity without legal personality with the administrations | Cloud-QSCD | |
Electronic seal | Cloud | |
Electronic seal | Software | |
Electronic seal | Cloud-QSCD | |
Electronic seal | Smartcard/Token | |
Electronic seal – Medium Level APE | Cloud/Software | |
Electronic seal – High Level APE | Smartcard/Token | |
Electronic seal – High Level APE | Cloud-QSCD |
...
with the administrations | Cloud-QSCD | |
Electronic seal | Cloud | |
Electronic seal | Software | |
Electronic seal | Cloud-QSCD | |
Electronic seal | Smartcard/Token | |
Electronic seal – Medium Level APE | Cloud/Software | |
Electronic seal – High Level APE | Smartcard/Token | |
Electronic seal – High Level APE | Cloud-QSCD |
PFSoftAFCiudadano
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 | |
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 | |
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.
...
Profile | Description | Element |
|---|---|---|
Natural person | Software/Smartcard/Token | |
Natural person belonging to an organization | Software/Smartcard/Token | |
Legal entity representative | Software/Smartcard/Token | |
Natural person belonging to a professional association | Software/Smartcard/Token | |
Legal entity for electronic invoicing | Software/Smartcard/Token | |
Legal entity for unassisted signature | Cloud/Software/Smartcard/Toke |
...
Profile | Description | Element |
|---|---|---|
Natural person | Software | |
Natural person | Cloud/Smartcard/Token | |
Electronic seal | Software | |
Electronic seal | Cloud/Smartcard/Token | |
Natural person representative | Cloud | |
Natural person representative | Software/Smartcard/Token |
...
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 | |
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 |
...
REPnubeNC
Certificate of legal entity representative, suitable for the relationship between Spanish or European companies, for authentication and the qualified electronic signature, and issued in cryptographic container format P12the 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 | |
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 |
...
REPsoftNC
Certificate of legal entity representative, suitable for the relationship between Spanish or European companies, for the qualified authentication and electronic signature , and issued in the centralized custody system of Uanataca certificatescryptographic 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 | |
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.
...
KEY file: the file containing the certificate private key