e-Próspera
Reference

Get natural-person residency status

View as Markdown
GET
/api/v1/me/natural-person/residency

Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.

Authorization

AuthorizationBearer <token>

In: header

Scope: eprospera:person.residency.read

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/me/natural-person/residency"
{  "wasEverResident": true,  "activeResidency": {    "effectiveDate": "2019-08-24T14:15:22Z",    "terminationDate": "2019-08-24T14:15:22Z",    "residencyType": "Limited e-Resident",    "version": "string"  }}

Get ID-verification artifacts GET

Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.

List the authenticated person’s documents GET

Returns the documents the portal shows the signed-in person: the signed Agreement of Coexistence, accepted policies, and other generated documents, excluding admin-only or hidden records. `agreementOfCoexistence` describes the agreement behind the active residency. Agent scope: `agent:person.documents.read`. Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.