Appearance
Verify whether an RPN exists and is active
POST
/api/v1/verify_rpn
Look up a Resident Permit Number and report whether it belongs to a
legal entity, a natural person, or is unknown — and whether the
resident currently has an active residency.
Rate-limited to 5,000 requests per 24 hours and 50 per minute, per
API key. Exceeding either bound returns 429.
Accepts standard API keys (sk-) and Agent Keys (ak-) holding the
agent:verify_rpn scope.
Authorizations
bearerApiKey
Standard API key (sk-...) or Agent Key (ak-...). Agent Keys are scope-checked. See https://portal.eprospera.com/api-docs/agent-keys.
Type
HTTP (bearer)
Request Body
application/json
JSON "rpn": "80000000000012"
{
}
Responses
Lookup result.
application/json
JSON "result": "string", "active": true
{
}