e-Próspera
Reference

List consented legal entities

View as Markdown
GET
/api/v1/me/legal-entities

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

oauth2 eprospera:entity.read
AuthorizationBearer <token>

In: header

Scope: eprospera:entity.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/legal-entities"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "optionId": "string",      "type": "string",      "name": "string",      "extension": "string",      "nameStartsWithExtension": true,      "formationDate": "string",      "registrationDate": "2019-08-24T14:15:22Z",      "dissolutionDate": "2019-08-24T14:15:22Z",      "residentPermitNumber": "string",      "principalOfficeAddress": {        "line1": "string",        "line2": "string",        "city": "string",        "state": "string",        "postalCode": "string",        "country": "string"      },      "createdAt": "2019-08-24T14:15:22Z"    }  ]}

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.

Get a consented legal entity 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.