Get agreement documents for a partner residency application
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.
Authorization
partnerKey Partner Key for one approved Partner Integration. Keys are lifecycle- and scope-checked, and cross-integration resources are hidden.
In: header
Path Parameters
uuidResponse 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/partner/residency_applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "version": "string", "fileUrl": "http://example.com", "createdAt": "2019-08-24T14:15:22Z" } ], "agreementOfCoexistence": { "aocId": "362edf67-c84f-4643-8cf8-0b739c8e06c4", "slug": "string", "version": "string", "residencyType": "string", "templatePdfUrl": "http://example.com", "accepted": true, "acceptedAt": "2019-08-24T14:15:22Z", "signerName": "string", "invalidatedAt": "2019-08-24T14:15:22Z" }, "residencyEffectiveDate": "2019-08-24T14:15:22Z"}Update a draft partner residency application PATCH
Replaces the application data of a Draft. Requires the latest `version` as `expectedVersion`. Any change to `applicationData` invalidates the current agreement acceptance and returns a fresh `nextSteps.agreementUrl`. Once the invoice is paid, `residencyType` and the applicant email are locked. Changing the applicant email sends a new claim email to the new address.
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.