Upload proof of address
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.
Authorization
partnerKey Partner Key for one approved Partner Integration. Keys are lifecycle- and scope-checked, and cross-integration resources are hidden.
In: header
Request Body
multipart/form-data
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/uploads/proof_of_address" \ -F applicationId="97ab27fa-30e2-43e3-92a3-160e80f4c0d5" \ -F file="string"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "contentType": "string", "size": 0 }}Get agreement documents for a partner residency application GET
Returns the Agreement of Coexistence the applicant accepted for this application, including the template PDF for that version, and, once the residency exists, its signed agreement and the applicant’s policy documents. Signed agreements must match this application’s residency ID; agreements for other residencies, identity-verification artifacts, and tax documents are never returned. Requires `partner:person.application.read`.
Download proof of address GET
Next Page