---
title: "List partner residency applications"
method: GET
path: "/api/v1/partner/residency_applications"
tags: ["Partner residency applications"]
---

# List partner residency applications

`GET /api/v1/partner/residency_applications`

## Query parameters

- `limit` integer
- `cursor` string, uuid

## Response `200`

Applications owned by this Partner Integration.

- object
  - `data` PartnerResidencyApplication[], required
    - `id` string, uuid, required
    - `version` integer, required
    - `statusId` string, required
    - `applicationVersion` string, required
    - `submittedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `approvedAt` string, date-time, nullable, required
    - `rejectedAt` string, date-time, nullable, required
    - `residentPermitNumber` string, nullable, required — 14-digit Resident Permit Number.
    - `referralCode` string, nullable, required
    - `applicationData` object, required
      - `residencyType` 'limited_e_resident' | 'e_resident' | 'resident_annual' | 'null', nullable, required
      - `aoc` object, required
        - `aocId` string, nullable, required
        - `signed` boolean, required
        - `signedByName` string, nullable, required
        - `signedAt` string, date-time, nullable, required
        - `agentAuthorized` boolean, required
      - `personalDetails` object, nullable, required
        - `givenName` string, required
        - `surname` string, required
        - `email` string, email, required
        - `dateOfBirth` string, required
        - `sex` string, required
        - `countryOfBirth` string, nullable, required
        - `citizenships` string[], required
        - `alternateNamesAttestation` boolean, required
        - `alternateNames` string, nullable, required
        - `criminalBackgroundAttestation` boolean, required
        - `proofOfAddressUploadId` string, uuid, nullable, required
        - `address` object, required
          - `line1` string, nullable, required
          - `line2` string, nullable, required
          - `city` string, nullable, required
          - `state` string, nullable, required
          - `postalCode` string, nullable, required
          - `country` string, nullable, required
        - `phoneNumber` string, nullable, required
      - `information` object, required
        - `residencyReason` string, nullable, required
        - `referralSource` string, nullable, required
    - `applicantPortalAccess` object, required
      - `email` string, email, nullable, required
      - `hasLoggedIn` boolean, required
      - `lastLogin` string, date-time, nullable, required
      - `claimLinkSent` boolean, required
      - `claimLinkSentAt` string, date-time, nullable, required
    - `nextSteps` object, required
      - `agreementUrl` string, uri, nullable, required
      - `proofOfAddressRequired` boolean, required
      - `paymentRequired` boolean, required
      - `verificationRequired` boolean, required
      - `verificationInstructions` string, nullable, required
      - `submitReady` boolean, required
  - `pagination` object, required
    - `limit` integer, required
    - `nextCursor` string, uuid, nullable, required

## Other responses

- `400` — Validation error or precondition failure.
- `401` — Missing or invalid credential.
- `403` — Credential lacks the required scope (Agent Key) or insufficient OAuth scope.
- `404` — Resource does not exist or is invisible to the caller. The two are intentionally indistinguishable.
- `409` — Conflicting state (e.g. legal-entity name already taken).
- `429` — Partner API rate limit exceeded.
- `500` — Server error.

---

[API](https://skmtc.dev/eprospera/apis/e-pro-spera-api.md) · [All operations](https://skmtc.dev/eprospera/apis/e-pro-spera-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/eprospera/e-pro-spera-api/revisions/9ecdd3ca5a8c/schema)