v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB

Policy Import Intents

Retrieve a policy import intent

Retrieves a policy_import_intent object.

get/policy_import_intents/{policy_import_intent_id}

Path parameters

policy_import_intent_idstring required

Example:pii_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

idstring required

Unique identifier for the policy import intent. Prefixed with pii_.

objectstring

Object type identifier.

status'processing' | 'failed' | 'success' required

employee_idstring required

The employee ID for the policy import. Prefixed with ee_.

group_idstring required

The group ID for the policy import. Prefixed with g_.

provider_policy_numberstring required

The provider's policy number.

member_numberstring required

The member number assigned by the provider.

policy_start_datestring date required

The start date of the policy.

policy_end_datestring date nullable

The end date of the policy. Null if the policy has no end date, or end date is not known.

Example response

{
  "id": "pii_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "policy_start_date": "2024-12-01",
  "policy_end_date": "2024-12-01",
  "associated_persons": [
    {
      "associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "start_date": "2024-12-01",
      "end_date": "2024-12-01"
    }
  ]
}