Create a secure agreement and KYC embed session
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.
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
uuidRequest Body
application/json
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/partner/residency_applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/embed_sessions" \ -H "Content-Type: application/json" \ -d '{ "parentOrigin": "http://example.com", "codeChallenge": "string", "codeChallengeMethod": "S256" }'{ "data": { "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459", "embedUrl": "http://example.com", "tokenExpiresAt": "2019-08-24T14:15:22Z", "flowExpiresAt": "2019-08-24T14:15:22Z" }}Pay a partner application with a voucher POST
Applies a voucher that must cover the full invoice. Returns the updated application with `nextSteps.paymentRequired` false. Voucher errors carry a machine-readable `code`: `voucher_not_found`, `voucher_expired`, `voucher_already_redeemed`, `voucher_not_applicable`, `voucher_not_full_coverage`, `invoice_not_found`. Requires `Idempotency-Key`.
Submit a partner residency application POST
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.