PensionMembership

  • appliesFromDate
    Type: stringFormat: date
    required

    First date on which the Employment is enrolled in the Pension Scheme. It cannot be before the Employment's start date.

  • confirmedAt
    Type: stringFormat: date-time
    required

    When the employer confirmed the enrolment.

  • confirmedByPartnerUserId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    ID of the employer user in the Partner's product who confirmed the enrolment. This may differ from the user or service making the API request.

  • enrolmentReason
    Type: stringenum
    required

    How the employee came to be enrolled. Pension providers receive this as the enrolment event.

    values
    automatic_enrolmentopt_involuntary_joinercontractual_enrolment
  • partnerPensionSchemeId
    Type: string
    min length:  
    1
    max length:  
    200
    required

    Stable ID from the Partner's product for a Pension Scheme configured for this Employer during Partner onboarding.

  • status
    enum
    const:  
    enrolled
    required

    Employer-confirmed membership state. This version accepts only enrolled.

  • partnerSourceId
    Type: string
    min length:  
    1
    max length:  
    200

    ID of a separate supporting record in the Partner's product.