This section contains everything you need to integrate the Registration Authority API: full OpenAPI specification (with operation details in the llamadas folder), webhook configuration, authentication, responses, and the Postman collection.
- Registration Authority API (OpenAPI) — Full API: Registration Authority, RAO, Users, Scratchcards, Requests, eIDAS VideoID, External VideoID. All paths are under
/api/v1/. - Webhooks — Callback URL and payload for request status changes (VideoID flows).
- Postman collection — Quick API testing.
Base URL format: https://{host}/api/{version}/{resource}/
- Host —
api.uanataca.com(production),api.sandbox.uanataca.com(sandbox). For External VideoID upload:lima.uanataca.com/lima.sandbox.uanataca.com. - Version —
v1. - Resource — e.g.
requests,registrationauthorities,rao,users,scratchcards. Always end the URL with a forward slash (/).
The API is authenticated with the certificate and key of an enabled API User (client certificate). Example with cURL:
curl --key key.pem --cert cert.pem -H "Content-Type: application/json" -d @params.json -X POST https://api.uanataca.com/api/v1/requests/Example with Python (requests):
import requests
requests.get(
'https://api.uanataca.com/api/v1/scratchcards/',
cert=('/path/to/cert.pem', '/path/to/key.pem')
)- Successful responses return JSON; structure depends on the endpoint (see OpenAPI).
- Error responses include
error(string),code(HTTP-related), andid(Uanataca error id). - Paginated list responses include
count,next,previous, andresults(max 10 objects per page). See OpenAPI specification for details and HTTP status codes.