EPeprospera
Partner residency applications

Create a secure agreement and KYC embed session

Changed on

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.

post/api/v1/partner/residency_applications/{id}/embed_sessions

Request

Path parameters

idstring uuid required
Example:4e368230-84e3-4cb8-9225-a6d972e425fc

Request body

parentOriginstring uri required
codeChallengestring required
codeChallengeMethod'S256' required
locale'en' | 'es'

Response

Single-use embed session created.

Changes

  • d2c5a5cda002Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status