Skip to content
Registration Authority
/
/
/
UPDATE REQUEST

UANATACA RA API DOCUMENTATION (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://api.uanataca.com/

Registration Authority

Operations

Registration Authority Officer

Operations

Users

Operations

Scratchcards

Operations

Requests

Operations

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
}

UPDATE REQUEST

Request

Updates information about a request.

Path
idstringrequired

The unique identifier of the Request

Bodyapplication/json
profilestringrequired

Certificate profile

scratchcardstringrequired

Available and unused scratchcard serial number. The first unused scratcard 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)

country_namestringrequired

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

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

Responses

Successful Response

Bodyapplication/json
object

A JSON object with full information about the updated request

Response
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": {
    "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
}

CANCEL REQUEST

Request

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

Path
idstringrequired

The unique identifier of the Request

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

Responses

Successful Response

Bodyapplication/json
statusstring

The successful cancellation status message

Response
application/json
{
  "status": "Request cancelled"
}

eIDAS VideoID

Operations

External VideoID

Operations