Reference
Verify whether an RPN exists and is active
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.
AuthorizationBearer <token>
Personal standard API key. Send it as Authorization: Bearer sk-... and never delegate it.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/verify_rpn" \ -H "Content-Type: application/json" \ -d '{ "rpn": "string" }'{ "result": "found_legal_entity", "active": true}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}{ "error": "string", "error_description": "string", "details": [ null ]}