e-Próspera
Reference

Create a public Visitor Pass application

View as Markdown
POST
/api/v1/visitor_pass_applications

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/visitor_pass_applications" \  -H "Content-Type: application/json" \  -d '{    "firstName": "string",    "lastName": "string",    "dateOfBirth": "string",    "email": "user@example.com",    "signature": "string",    "consentToBackgroundCheck": true,    "referralSource": "string"  }'
{  "success": true,  "data": {    "ok": true  }}

List referrals for a referral code 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.

Identify VAT taxpayers and open quarters GET

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.