Verify residents and entities as a compliance vendor

Confirm Resident Permit Numbers and look up registry records in real time for KYC, AML, and background-check workflows.

You run a KYC/AML product, a background-check service, or a compliance desk, and you need to confirm that a Próspera resident or legal entity is real and in good standing.

Credential: a standard API key (sk-) is enough for registry-level checks. Person-level reads (residency status, ID verification) additionally require an Agent Key (ak-) delegated by the person, or an OAuth token with their consent.

1. Verify an RPN

Given a 14-digit Resident Permit Number (entities start with 8, natural persons with 9), confirm it exists and is active:

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

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

result is one of found_legal_entity, found_natural_person, or not_found. This endpoint is rate-limited to 5,000/day and 50/minute per key — cache results where your compliance policy allows. See POST verify_rpn.

2. Resolve a name to a registry record

When you have a company name instead of an RPN, search the public legal-entity registry:

curl -s -X POST https://portal.eprospera.com/api/v1/registries/legal_entities/search \
  -H "Authorization: Bearer sk-..." \
  -H "Content-Type: application/json" \
  -d '{"query": "Acme Holdings"}'

Each match includes the entity id, name, extension, and residentPermitNumber. See POST registries/legal_entities/search.

3. Pull entity details and documents

With the entity id, fetch the full record and its certificates and filings:

Agent-key visibility

With an Agent Key, GET /legal_entities/{id} only returns entities created via the API. Registry search is the broad lookup across all registered entities — resolve through search first.

4. Person-level KYC (requires delegation)

To read a natural person's residency status or ID-verification state, the person must delegate access — there is no vendor-wide lookup of personal data. Two options:

Agent Key issued by the person with agent:person.details.read, agent:person.residency.read, agent:person.id_verification.read — see Agent recipes → account-holder profile.
OAuth consent flow with the eprospera:person.* scopes — see Sign in with e-Próspera.

Endpoints: natural person · residency · ID verification.

What this API does not do

No public webhooks — re-verify on your own schedule instead of waiting for pushes.
No bulk export of the registry; query per entity.
No personal-data lookup without the person's delegation or consent.

Next steps

Getting started — create your API key
Conventions — error envelope, status codes, rate limits
Testing in staging