e-Próspera
Reference

Create a public Visitor Pass application

View as Markdown
POST
/api/v1/visitor_pass_applications

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.

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

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",    "turnstileToken": "string"  }'
{  "success": true,  "data": {    "ok": true  }}