Getting started

The e-Próspera API is a RESTful API that lets you interact with e-Próspera services programmatically.

Base URL: https://portal.eprospera.com (production) — every path in this documentation is relative to that origin. Staging is https://staging-portal.eprospera.com. See Conventions for shared rules (auth, errors, timestamps, pagination, rate limits).

There are two API key models:

• Standard API keys (sk-) for your own backend or personal automation
• Agent Keys (ak-) for delegated access to a specific AI agent or third-party service, with explicit scopes

1. Create an API key

Sign in to the portal and open Settings > Developer.

If you are building something for your own backend, create a standard API key. If you are delegating access to an AI agent or third-party service, create an Agent Key instead and grant only the scopes that service needs.

Standard API keys should never be shared. Agent Keys are intended for controlled delegation and can be revoked independently.

Include the key as a bearer token in every request:

Authorization: Bearer sk-...

API keys act as you inside e-Próspera. Store them server-side and treat them like passwords.

2. Make your first request

The simplest endpoint is POST /api/v1/verify_rpn. It checks whether a resident permit number (RPN) belongs to a natural person or a legal entity.

curl -X POST https://portal.eprospera.com/api/v1/verify_rpn \
  -H "Authorization: Bearer <your-api-key-or-agent-key>" \
  -H "Content-Type: application/json" \
  -d '{"rpn": "80000000000012"}'

{
  "result": "found_legal_entity",
  "active": true
}

The response tells you 80000000000012 belongs to a legal entity with an active residency.

3. Next steps

• Conventions — shared rules for every endpoint (errors, status codes, timestamps, pagination, rate limits)
• Agent recipes — end-to-end curl chains for common Agent-Key workflows
• Full verify_rpn reference
• Incorporate an LLC via API
• Agent Keys guide — delegated access for AI workflows or external services
• OAuth / OIDC overview — let users sign in with their e-Próspera account