# Get Status

This API fetches the status of notices based on Erisa EIN and Erisa Plan Number or date range.

Endpoint: POST /api/v1/Participants/status
Version: v1

## Request fields (application/json):

  - `erisaPlanRecords` (array,null)

  - `erisaPlanRecords.erisaEIN` (string,null)

  - `erisaPlanRecords.erisaPlanNumber` (string,null)

  - `from` (string,null)
    Start of the date range filter (in UTC).

  - `to` (string,null)
    End of the date range filter (in UTC).

  - `skip` (integer,null)
    Number of records to skip before returning results.

  - `take` (integer,null)
    Maximum number of records to return.

## Response 200 fields (application/json):

  - `noticeParticipantRequestId` (string)
    Unique identifier for the notice participant request.

  - `erisaEIN` (string,null)
    ERISA Employer Identification Number associated with the plan sponsor.

  - `erisaPlanNumber` (string,null)
    ERISA plan number associated with the participant's plan.

  - `externalReferenceId` (string,null)
    External Reference Id passed in the rollout notice request. Empty string if it was not provided

  - `reason` (string,null)
    The reason the rollout is being requested. Valid values: SBR or TERM

  - `firstName` (string,null)
    Participant First Name

  - `lastName` (string,null)
    Participant Last Name

  - `ssn` (string,null)
    Participant SSN passed in the rollout notice request. Empty string if it was not provided

  - `addressLine1` (string,null)
    Participant Address Line 1

  - `addressLine2` (string,null)
    Participant Address Line 2

  - `city` (string,null)
    Participant City

  - `state` (string,null)
    Participant State

  - `zip` (string,null)
    Participant Zip

  - `countryCode` (string,null)
    Participant Country Code

  - `totalBalance` (number,null)
    Participant Total Balance. Required For TERM

  - `vestedBalance` (number,null)
    Participant Vested Balance. Required For SBR

  - `deliveryStatus` (string,null)
    Delivery Statuses:
                        
                            Pending: – a request for the rollout has been accepted and is going through Plan Notices internal processes. 
                            Sent: The request has been mailed
                            Success: The mail was successfully delivered
                            ReturnToSender: The mail could not be delivered and was returned to the sender by the postal service.
                            Undeliverable: The mail could not be delivered and was not returned (e.g., due to an invalid address or recipient refusal).

  - `noticeId` (string,null)
    The NoticeId created for the Rollout

  - `gracePeriod` (integer,null)
    The amount of time the participant have to respond to the rollout notice

  - `gracePeriodExpiration` (string,null)
    The exact date and time when the participant's response deadline for the rollout notice expires.

  - `skipped` (boolean)
    Indicates whether the participant was skipped during the processing of the notice participant request.

  - `skippedReason` (string,null)
    Specifies the reason why the participant was skipped during the notice participant request processing.