e-Próspera
Reference

Download proof of address

View as Markdown
GET
/api/v1/uploads/proof_of_address/{id}

Authorization

partnerKey
AuthorizationBearer <token>

Partner Key for one approved Partner Integration. Keys are lifecycle- and scope-checked, and cross-integration resources are hidden.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/octet-stream

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/uploads/proof_of_address/497f6eca-6276-4993-bfeb-53cbbbba6f08"
"string"

Upload proof of address POST

Multipart upload of a PDF, JPEG, or PNG up to 4.5 MB for a Draft owned by your integration. The declared MIME type must match the file bytes. The response carries an opaque `id` to attach through PATCH as `proofOfAddressUploadId`; no URL is returned.

Create a partner hosted-checkout session POST

Creates a hosted checkout for the application invoice. Send exactly one of `paymentProvider` or `paymentMethod`. `redirectUrl` must use an approved redirect origin; Stripe returns the payer to `redirectUrl?success=true` on success and to `redirectUrl` on cancel. The response is `{ data: { url }, invoiceId }`. Payment is confirmed asynchronously: poll the application until `nextSteps.paymentRequired` is false. Requires `Idempotency-Key`.