Skip to content
Registration Authority
/
Enterprise Documentation
/
/Requests

UANATACA RA API DOCUMENTATION (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://api.uanataca.com/

Registration Authority

Operations

Registration Authority Officer

Operations

Users

Operations

Scratchcards

Operations

Requests

Operations

LIST REQUEST

Request

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

Path
scratchcardanyrequired

Number of scratchcard

given_nameanyrequired

Name

surname_1anyrequired

First surname

surname_2anyrequired

Last surname

serial_numberanyrequired

Document number

emailanyrequired

Email of the certificate owner

mobile_phone_numberanyrequired

Phone number of the certificate owner

registration_authorityanyrequired

Registration Authority number where certificate belongs

curl -i -X GET \
  https://api.uanataca.com/api/v1/requests

Responses

Successful Response

Bodyapplication/json
countstring

The number of existing requests

nextstring

The list next page endpoint

previousstring

The list previous page endpoint

resultsobject

A JSON object with full information related to each listed request

Response
application/json
{
  "count": 87,
  "next": "https://access.bit4id.org:13035/api/v1/requests/?page=2",
  "previous": "null",
  "results": {
    "pk": 36876,
    "given_name": "Name",
    "surname_1": "Surname1",
    "surname_2": "Surname2",
    "sex": null,
    "id_document_type": "IDC",
    "id_document_country": "ES",
    "serial_number": "Y3646957E",
    "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": "PFSoftAFCiudadano",
    "scratchcard": "5053616",
    "status": "ISSUED",
    "registering_user": { … },
    "approving_user": { … },
    "producing_user": { … },
    "registration_authority": 303,
    "secure_element": 0,
    "validity_time": "730",
    "smartcard_sn": null,
    "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": "+34999999999",
    "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": { … },
    "id_document_number": "",
    "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": "",
    "complement_number": null,
    "id_responsible_document_issuer": null,
    "provider_registration_number": null,
    "communication_language": "es"
  }
}

CREATE REQUEST

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.

Bodyapplication/json
profilestringrequired

Certificate profile

validity_timenumber

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

scratchcardstringrequired

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

secure_elementstring

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

registration_authoritystringrequired

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

identification_raonumber

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_namestring

The country where the RA is registered

serial_numberstring

The user's document serial number

id_document_countrystring

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

id_document_typestring

The user's document type

given_namestring

The user's given name

surname_1string

The user's first surname

surname_2string

The user's second surname

emailstringrequired

The user's email

mobile_phone_numberstring

The user's mobile phone number

paperless_modenumber

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

videoid_modenumber

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

webhook_urlstring

The webhook associated URL.

⚠ Not required for external authentication. See Webhook Configuration section

curl -i -X POST \
  https://api.uanataca.com/api/v1/requests \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
  }'

Responses

Successful Response

Bodyapplication/json
object

A JSON object with full information about the created request

Response
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": {
    "pk": 53,
    "permission_profile": 13,
    "registration_authority": 116,
    "request": 144
  },
  "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
}

GET REQUEST

Request

Returns full information about a request.

Path
idstringrequired

The unique identifier of the request

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

Responses

Successful Response

Bodyapplication/json
object

The JSON object with full information associated to the approved request

Response
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": {
    "pk": 527,
    "permission_profile": 19,
    "registration_authority": 303,
    "request": 28634
  },
  "approving_user": {
    "pk": 527,
    "permission_profile": 19,
    "registration_authority": 303,
    "request": 28634
  },
  "producing_user": {
    "pk": 527,
    "permission_profile": 19,
    "registration_authority": 303,
    "request": 28634
  },
  "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": {
    "pk": 1400,
    "given_name": "RAO_Name",
    "surname_1": "RAO_Surname1",
    "surname_2": "RAO_Surname2",
    "certificate": { … },
    "id_document_number": "Y3646959E",
    "id_document_description": "IDC",
    "id_document_issuer": "",
    "registration_authority": [],
    "registration_authority_master": 327,
    "is_identificator": false
  },
  "producing_rao": {
    "pk": 1400,
    "given_name": "RAO_Name",
    "surname_1": "RAO_Surname1",
    "surname_2": "RAO_Surname2",
    "certificate": { … },
    "id_document_number": "Y1111111E",
    "id_document_description": "IDC",
    "id_document_issuer": "",
    "registration_authority": [],
    "registration_authority_master": 327,
    "is_identificator": false
  },
  "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
}

eIDAS VideoID

Operations

External VideoID

Operations