Skip to main content

MemberAPI

data object
accounts object[]
  • Array [
  • idinteger
    namestringnullable
  • ]
  • archivedboolean
    archived_datedate-timenullable
    archivedby object
    emailstringnullable
    idinteger
    can_make_claim_requestsboolean
    can_use_portalboolean
    createddatedate-timenullable
    date_of_birthdatenullable
    dependents object[]
  • Array [
  • createddatedate-timenullable
    date_of_birthdatenullable
    emailstringnullable
    first_namestringnullable
    gendernullable
    idinteger
    last_namestringnullable
    middle_namestringnullable
    modifieddatedate-timenullable
    new_addressnullable
    ssnstringnullable
  • ]
  • emailstringnullable
    employer object
    archivedboolean
    eligible_payers object[]
  • Array [
  • idinteger
    namestringrequired
    retrieverstringrequired
    short_namestringnullable
    supports_realtime_verificationboolean
    website_home_urlstringnullable

    i.e. https://www.medmutual.com/

  • ]
  • email_automationboolean
    employer_idinteger
    idinteger
    namestringrequired
    payers object[]
  • Array [
  • idinteger
    namestringrequired
    short_namestringnullable
  • ]
  • slugstring
    support_email_derivedstring
    support_phone_derivedstring
    tenant_logo_derivedstring
    tenant_name_derivedstring
    first_namestringnullable
    first_name_derivedstring
    full_name_derivedstring
    gender
    hire_term_daterange object
    anyOf
    objectnullable
    idinteger
    last_namestringnullable
    last_name_derivedstring
    modifieddatedate-timenullable
    new_addressnullable
    phone_homenullable
    phone_mobilenullable
    ssnstringnullable

    Possible values: >= 9 characters and <= 11 characters

    tenant object
    idinteger
    namestringrequired
    tenant_idinteger
    vendor_tenants object[]
  • Array [
  • idinteger
    key_enabledboolean
    labelstringnullable
    vendor object
    codestringrequired
    idinteger
    namestringrequired
  • ]
  • unread_countinteger
    vendor_members object[]
  • Array [
  • keystring
    vendor_tenant object
    idinteger
    labelstringnullable
    vendor object
    codestringrequired
    idinteger
    namestringrequired
  • ]
  • MemberAPI
    {
    "data": {
    "accounts": [
    {
    "id": 0,
    "name": "string"
    }
    ],
    "archived": true,
    "archived_date": "2024-07-29T15:51:28.071Z",
    "archivedby": {
    "email": "string",
    "id": 0
    },
    "can_make_claim_requests": true,
    "can_use_portal": true,
    "createddate": "2024-07-29T15:51:28.071Z",
    "date_of_birth": "2024-07-29",
    "dependents": [
    {
    "createddate": "2024-07-29T15:51:28.071Z",
    "date_of_birth": "2024-07-29",
    "email": "string",
    "first_name": "string",
    "id": 0,
    "last_name": "string",
    "middle_name": "string",
    "modifieddate": "2024-07-29T15:51:28.071Z",
    "ssn": "string"
    }
    ],
    "email": "string",
    "employer": {
    "archived": true,
    "eligible_payers": [
    {
    "id": 0,
    "name": "string",
    "retriever": "string",
    "short_name": "string",
    "supports_realtime_verification": true,
    "website_home_url": "string"
    }
    ],
    "email_automation": true,
    "employer_id": 0,
    "id": 0,
    "name": "string",
    "payers": [
    {
    "id": 0,
    "name": "string",
    "short_name": "string"
    }
    ],
    "slug": "string",
    "support_email_derived": "string",
    "support_phone_derived": "string",
    "tenant_logo_derived": "string",
    "tenant_name_derived": "string"
    },
    "first_name": "string",
    "first_name_derived": "string",
    "full_name_derived": "string",
    "gender": {},
    "hire_term_daterange": {},
    "id": 0,
    "last_name": "string",
    "last_name_derived": "string",
    "modifieddate": "2024-07-29T15:51:28.071Z",
    "ssn": "string",
    "tenant": {
    "id": 0,
    "name": "string",
    "tenant_id": 0,
    "vendor_tenants": [
    {
    "id": 0,
    "key_enabled": true,
    "label": "string",
    "vendor": {
    "code": "string",
    "id": 0,
    "name": "string"
    }
    }
    ]
    },
    "unread_count": 0,
    "vendor_members": [
    {
    "key": "string",
    "vendor_tenant": {
    "id": 0,
    "label": "string",
    "vendor": {
    "code": "string",
    "id": 0,
    "name": "string"
    }
    }
    }
    ]
    }
    }