e-Próspera
Reference

List the authenticated person’s documents

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

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.

Authorization

AuthorizationBearer <token>

In: header

Scope: eprospera:person.documents.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/documents"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "slug": "string",      "version": "string",      "fileUrl": "http://example.com",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "agreementOfCoexistence": {    "aocId": "362edf67-c84f-4643-8cf8-0b739c8e06c4",    "slug": "string",    "version": "string",    "residencyType": "string",    "effectiveDate": "2019-08-24T14:15:22Z",    "terminationDate": "2019-08-24T14:15:22Z",    "templatePdfUrl": "http://example.com",    "signedDocumentId": "9cefe7de-adf3-4e83-ac78-ca4feda409e9",    "signedDocumentUrl": "http://example.com"  }}