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

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 is intentionally unauthenticated. The applicant must provide consent and a signature.