EPeprospera
Partner residency applications

Create a partner residency application

Changed on

Creates a Draft owned by your integration and, for an applicant without an existing eProspera password, emails a single-use 24-hour account-claim link. Requires Idempotency-Key.

post/api/v1/partner/residency_applications

Request

Headers

Idempotency-Keystring required

8-128 URL-safe characters. Retained for 24 hours per integration and route. An identical retry replays the stored response with Idempotency-Replayed: true; a different body under the same key returns 409.

Request body

referralCodestring
redirectUrlstring uri

Response

Application created.

Changes

  • 4e7a4c475288Revision changes
    • breaking

      added the pattern ^\p{L}(?:[\p{L}\p{M}]|\u200c|\u200d)*(?:(?: +|['\u2019\u02bc\u00b7-]|\. ?)\p{L}(?:[\p{L}\p{M}]|\u200c|\u200d)*)*\.?$ to the request property //

    • breaking

      added the pattern ^\p{L}(?:[\p{L}\p{M}]|\u200c|\u200d)*(?:(?: +|['\u2019\u02bc\u00b7-]|\. ?)\p{L}(?:[\p{L}\p{M}]|\u200c|\u200d)*)*\.?$ to the request property //

    • warning

      the // request property's maxLength was set to 100

    • warning

      the // request property's maxLength was set to 100

  • 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