e-Próspera
Reference

List referrals for a referral code

View as Markdown
GET
/api/v1/referral-codes/{code}/referrals

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

standardApiKey
AuthorizationBearer <token>

Personal standard API key. Send it as Authorization: Bearer sk-... and never delegate it.

In: header

Path Parameters

code*string

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/referral-codes/string/referrals"
{  "code": "string",  "naturalPersons": [    {      "fullName": "string",      "referredAt": "2019-08-24T14:15:22Z"    }  ],  "legalEntities": [    {      "name": "string",      "rpn": "string",      "referredAt": "2019-08-24T14:15:22Z"    }  ]}

Download a tax assessment or filed income return GET

For a submitted individual income return, downloads the saved Form 1 PDF when available; otherwise renders it from the filed amounts and original submission date. Returns 400 when incomplete or conflicting historical filing data requires review. Hidden or admin-only saved returns are unavailable to residents and return 404. 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.

Create a public Visitor Pass application POST

This endpoint does not require an API key, but every request requires a fresh Cloudflare Turnstile token (turnstileToken) for action visitor-pass from an approved hostname. The server verifies it before any account creation, application processing, or email. Missing, invalid, expired, replayed, wrong-action, or wrong-hostname tokens return 400; verification outages or missing configuration return 503. The applicant must provide consent and a signature as a canonical base64 PNG data URL (data:image/png;base64,...), with at most 512 KiB of image data and 4 million pixels. The image must fully decode and be embeddable in the agreement PDF. Invalid signatures return 400 before an account or application is created.