POST verify_rpn

Verify whether a resident permit number (RPN) corresponds to a valid resident in Próspera.

Endpoint

POST /api/v1/verify_rpn

Authentication

Requires a valid API key in the Authorization header:

Authorization: Bearer <your-api-key>

Request Body

Field	Type	Required	Description
rpn	string	Yes	The resident permit number to verify

Example Request

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"}'

Response

Success Response (200 OK)

Field	Type	Description
result	string	One of: "found_legal_entity", "found_natural_person", or "not_found"
active	boolean	Whether the resident has active residency status

Example Response

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

Error Responses

400 Bad Request

Missing or invalid rpn parameter:

{
  "error": "Missing `rpn` parameter"
}

401 Unauthorized

Invalid or missing API key:

{
  "error": "Invalid API key"
}

429 Too Many Requests

Rate limit exceeded:

{
  "error": "Rate limit exceeded. Maximum 5000 calls per day, 50 calls per minute."
}

500 Internal Server Error

Server error:

{
  "error": "Internal server error"
}

Rate Limits

• Per day: 5,000 requests
• Per minute: 50 requests

Rate limits are applied per API key.

Result Types

• found_legal_entity: The RPN belongs to a legal entity (company)
• found_natural_person: The RPN belongs to a natural person (individual)
• not_found: No resident found with this RPN

Active Status

The active field indicates whether the resident has current, non-expired residency status in Próspera.