e-Próspera
Reference

Submit a partner residency application

View as Markdown
POST
/api/v1/partner/residency_applications/{id}/submit

Moves a Draft to Pending Review. Requires current agreement acceptance, proof of address, a paid invoice, and approved identity verification. Given name and surname must each contain 1–100 characters after trimming, beginning with a letter and containing only Unicode letters, combining marks, joiners, spaces, hyphens, apostrophes, middle dots or periods. Email addresses and numbers are invalid names. Obvious placeholder names require manual review. No request body; not idempotent.

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/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/partner/residency_applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/submit"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "version": 1,    "statusId": "Draft",    "applicationVersion": "string",    "submittedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "approvedAt": "2019-08-24T14:15:22Z",    "rejectedAt": "2019-08-24T14:15:22Z",    "residentPermitNumber": "string",    "referralCode": "string",    "applicationData": {      "residencyType": "limited_e_resident",      "aoc": {        "aocId": "string",        "signed": true,        "signedByName": "string",        "signedAt": "2019-08-24T14:15:22Z",        "agentAuthorized": true      },      "personalDetails": {        "givenName": "string",        "surname": "string",        "email": "user@example.com",        "dateOfBirth": "string",        "sex": "string",        "countryOfBirth": "st",        "citizenships": [          "st"        ],        "alternateNamesAttestation": true,        "alternateNames": "string",        "criminalBackgroundAttestation": true,        "proofOfAddressUploadId": "374d34cb-fcc3-469a-9edd-37075e3acebb",        "address": {          "line1": "string",          "line2": "string",          "city": "string",          "state": "string",          "postalCode": "string",          "country": "st"        },        "phoneNumber": "string"      },      "information": {        "residencyReason": "string",        "referralSource": "string"      }    },    "applicantPortalAccess": {      "email": "user@example.com",      "hasLoggedIn": true,      "lastLogin": "2019-08-24T14:15:22Z",      "claimLinkSent": true,      "claimLinkSentAt": "2019-08-24T14:15:22Z"    },    "nextSteps": {      "agreementUrl": "http://example.com",      "proofOfAddressRequired": true,      "paymentRequired": true,      "verificationRequired": true,      "verificationInstructions": "string",      "submitReady": true    }  }}

Create a secure agreement and KYC embed session POST

Requires `partner:person.embed_session.create`. The application must be partner-owned, complete except for agreement/KYC, and paid. The one-time URL is bound to the parent-held PKCE verifier and may only be framed by the selected allow-listed origin. Issuance is not idempotent: retrying this operation creates a replacement link and revokes any previously active embed session for the application.

Get the authenticated natural person GET

Account deactivation revokes personal API keys, including Agent Keys, and OAuth authorizations. Account reactivation requires new API keys, including new Agent Keys, and consent; previously issued credentials remain invalid.