e-Próspera
Reference

Get natural-person residency status

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

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"  }}
{  "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  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}
{  "error": "string",  "error_description": "string",  "details": [    null  ]}