e-Próspera
Reference

Identify VAT taxpayers and open quarters

View as Markdown
GET
/api/v1/me/tax/vat/context

Returns registered taxpayer identity (name, UUID, RPN), candidate open quarters, and the declaration text. Personal and entity scopes authorize only their respective subjects. Entities also require current representation and token-specific consent. Eligibility is rechecked on writes. No identity-document images are returned.

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.tax.vat.write

Query Parameters

subject?|

Response Body

application/json

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/tax/vat/context"
{  "data": {    "subjects": [      {        "subject": {          "type": "natural_person",          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string",          "residentPermitNumber": "string"        },        "periods": [          {            "type": "vat",            "period": {              "year": 0,              "quarter": 1            },            "dueDate": "2019-08-24T14:15:22Z",            "status": "open",            "filingId": "79ada8ef-98e4-495b-8d26-4e319d7aff7f"          }        ]      }    ],    "supportedCurrencies": [      "usd"    ],    "declaration": {      "version": "vat-v1",      "text": "string"    }  }}

Create a public Visitor Pass application POST

This endpoint is intentionally unauthenticated. The applicant must provide consent and a signature.

Create or resume a quarterly VAT draft POST

Use personal for the caller or a consented legal-entity UUID. Taxpayer+quarter is the retry key: returns an existing original draft without replacing figures. Already-filed quarters, multiple drafts, and BTC/amendment drafts return 409. USD originals only. A registered RPN and eligible quarter are required. 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.