Getting started with the e-Próspera API

The e-Próspera API is a RESTful API that allows you to interact with e-Próspera's services programmatically. It's a personal API key, that you can use to make requests on your own behalf, as if you did them manually through the e-Próspera web app.

1. Get an API key

Go to the settings page on e-Próspera and create a new API key under the "Developer" section.

This key is secret & should not be shared with anyone. It allows computer programs to act on your behalf in e-Próspera.

2. Make your first request

The simplest API route is the verify_rpn route - here we'll ask it whether 80000000000012 corresponds to a valid resident permit number.

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

It will respond with the following JSON:

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

This indicates that 80000000000012 indeed corresponds to an active legal entity in Próspera!

3. Next steps

Read more about the verify_rpn endpoint in the API reference, or try incorporating a company with the POST legal_entity_applications endpoint.