Skip to content

UANATACA RA API DOCUMENTATION (v1)

Download OpenAPI description
Languages
Servers

https://api.uanataca.com/

Operations
Operations

Request

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

Query
filter1string

Filter string

filter2string

Filter string

filterNstring

Filter string

curl -i -X GET \
  'https://api.uanataca.com/api/v1/rao?filter1=string&filter2=string&filterN=string'

Responses

Successful Response

Bodyapplication/json
countstring

The number of associated RAOs

nextstring

The list next page endpoint

previousstring

The list previous page endpoint

resultsArray of objects

Array of JSON objects containing RAOs information

Response
application/json
{ "count": 25, "next": "null", "previous": null, "results": [ {} ] }

Request

Create a new registration authority officer.

Bodyapplication/json
registration_authority_masterstringrequired

The registration authority master id

registration_authoritystringrequired

The list of the RAs where the RAO can operate

certificatestringrequired

The Request certificate in Base64 format

given_namestringrequired

The RAO's name

surname_1stringrequired

The RAO's first surname

surname_2string

The RAO's second surname

id_document_numberstring

The RAO's document number

id_document_issuerstring

The document issuer

emailstring

A valid email address

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

Responses

Successful Response

Bodyapplication/json
pknumber

The created RAO's unique id

given_namestring

The created RAO's given name

surname_1number

The created RAO's first surname

surname_2string

The created RAO's second surname

certificateobject

An object with information about the RAO's request certificate

id_document_numberstring

The created RAO's id document number

id_document_descriptionstring

The created RAO's document description

id_document_issuerstring

The created RAO's document issuer

registration_authorityArray of numbers

The created RAO's registration authorities where he can operate

registration_authority_masterstring

The created RAO's master registration authority id

id_identificatorboolean
Response
application/json
{ "pk": 1400, "given_name": "RAO_Name", "surname_1": "RAO_Surname1", "surname_2": "RAO_Surname2", "certificate": { "profile": "EXTERNAL", "status": 0, "valid_from": "2020-01-01T16:31:00", "valid_to": "2022-01-01T16:31:00", "valid": "UNKNOW", "revokation_reason": null, "serial_number": "4501b05b35da0b54", "subject": "CN=RAO_Name RAO_Surname1 RAO_Surname2, 2.5.4.5=IDCES-12432143313213, 2.5.4.42=RAO_Name, 2.5.4.4=RAO_Surname1 RAO_Surname2, C=ES", "data": "MIIHyzCCBbOgAwIBAgIIdWWgCtrot88wDQYJKoZIhvcNAQELBQAwgb0xCzAJBgNVBAYTAkVTMUQwQgYDVQQHDDtCYXJjZWxvbmEgKHNlZSBjdXJyZW50IGFkZHJlc3MgYXQgd3d3LnVhbmF0YWNhLmNvbS9hZGR...", "issuer": "2.5.4.97=VATES-A66721499, CN=UANATACA CA1 DEVEL 2016, OU=AC-UANATACA, O=UANATACA S.A., L=Barcelona (see current address at www.uanataca.com/address), C=ES" }, "id_document_number": "Y8888888E", "id_document_description": null, "id_document_issuer": null, "registration_authority": [ 121, 122, 123 ], "registration_authority_master": 1, "is_identificator": false }

Request

Get information about a RAO.

Path
idstringrequired

The RAO's unique identifier

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

Responses

Successful Response

Bodyapplication/json
pkstring

The requested RA unique id

given_namestring

The RAO's name

surname_1string

The RAO's first surname

surname_2string

The RAO's second surname

certificateobject

A JSON object with information associated to the RAO's certificate

id_document_numberstring

The RAO's id document number

id_document_descriptionstring

The RAO's id document description

id_document_issuerstring

The RAO's id document issuer name

registration_authorityArray of arrays

The list of the RAs where the RAO can operate

registration_authority_masternumber

The master registration authority id

is_identificatorboolean
Response
application/json
{ "pk": 219, "given_name": "RAO_Name", "surname_1": "RAO_Surname1", "surname_2": "RAO_Surname2", "certificate": { "profile": "EXTERNAL", "status": 0, "valid_from": "2019-01-28T16:31:00Z", "valid_to": "2021-01-27T16:31:00Z", "valid": "VALID", "revokation_reason": null, "serial_number": "4501b05b35da0b54", "subject": "CN=RAO_Name RAO_Surname1 RAO_Surname2, 2.5.4.5=IDCES-12432143313213, 2.5.4.42=RAO_Name, 2.5.4.4=RAO_Surname1 RAO_Surname2, C=ES", "data": "MIIHyzCCBbOgAwIBAgIIdWWgCtrot88wDQYJKoZIhvcNAQELBQAwgb0xCzAJBgNVBAYTAkVTMUQwQgYDVQQHDDtCYXJjZWxvbmEgKHNlZSBjdXJyZW50IGFkZHJlc3MgYXQgd3d3LnVhbmF0YWNhLmNvbS9hZGR...", "issuer": "2.5.4.97=VATES-A66721499, CN=UANATACA CA1 DEVEL 2016, OU=AC-UANATACA, O=UANATACA S.A., L=Barcelona (see current address at www.uanataca.com/address), C=ES" }, "id_document_number": "12354232414", "id_document_description": null, "id_document_issuer": null, "registration_authority": [ 2, 3 ], "registration_authority_master": 1, "is_identificator": false }

Request

Update information about a RAO.

Path
idstringrequired

The RAO's unique identifier

Bodyapplication/json
registration_authority_masterstringrequired

The registration authority master id

registration_authoritystringrequired

The list of the RAs where the RAO can operate

certificatestringrequired

The Request certificate in Base64 format

given_namestringrequired

The RAO's name

surname_1stringrequired

The RAO's first surname

surname_2string

The RAO's second surname

id_document_numberstring

The RAO's document number

id_document_issuerstring

The document issuer

emailstring

A valid email address

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

Responses

Successful Response

Bodyapplication/json
pkstring

The requested RA unique id

given_namestring

The RAO's name

surname_1string

The RAO's first surname

surname_2string

The RAO's second surname

certificateobject

A JSON object with information associated to the RAO's certificate

id_document_numberstring

The RAO's id document number

id_document_descriptionstring

The RAO's id document description

id_document_issuerstring

The RAO's id document issuer name

registration_authorityArray of arrays

The list of the RAs where the RAO can operate

registration_authority_masternumber

The master registration authority id

is_identificatorboolean
Response
application/json
{ "pk": "1400", "given_name": "RAO_NewName", "surname_1": "RAO_Surname1", "surname_2": "RAO_Surname2", "certificate": { "profile": "EXTERNAL", "status": 0, "valid_from": "2020-01-01T16:31:00", "valid_to": "2022-01-01T16:31:00", "valid": "UNKNOW", "revokation_reason": null, "serial_number": "4501b05b35da0b54", "subject": "CN=RAO_Name RAO_Surname1 RAO_Surname2, 2.5.4.5=IDCES-12432143313213, 2.5.4.42=RAO_Name, 2.5.4.4=RAO_Surname1 RAO_Surname2, C=ES", "data": "MIIHyzCCBbOgAwIBAgIIdWWgCtrot88wDQYJKoZIhvcNAQELBQAwgb0xCzAJBgNVBAYTAkVTMUQwQgYDVQQHDDtCYXJjZWxvbmEgKHNlZSBjdXJyZW50IGFkZHJlc3MgYXQgd3d3LnVhbmF0YWNhLmNvbS9hZGR...", "issuer": "2.5.4.97=VATES-A66721499, CN=UANATACA CA1 DEVEL 2016, OU=AC-UANATACA, O=UANATACA S.A., L=Barcelona (see current address at www.uanataca.com/address), C=ES" }, "id_document_number": "Y8888888E", "id_document_description": null, "id_document_issuer": null, "registration_authority": [ 2, 3 ], "registration_authority_master": 1, "is_identificator": false }
Operations
Operations
Operations
Operations
Operations