EPeprospera
Verification

Verify whether an RPN exists and is active

Changed on

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.

post/api/v1/verify_rpn

Request

Request body

rpnstring required

Example request

{
  "rpn": "80000000000012"
}

Response

Lookup result.

result'found_legal_entity' | 'found_natural_person' | 'not_found' required
activeboolean required

Whether the resident has an active residency.

Changes

  • d2c5a5cda002Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status