Benekiva


Benekiva API provides robust ways of interacting with Benekiva Application. Prior to accessing this documentation, you will need to contact Benekiva team so that they can provision a test server for you.

Once you have your client portal with developer credentials, please login and obtain API Key and Client Secret.

Please reach out Benekiva technical support team (techsupport@benekiva.com) to obtain your API Key, Client Secret as well as API server information exclusively prepared for you.

Once you have API key and Client Secret, run 'Get Auth Token' API to obtain AuthToken that needs to be put as part of Authorization header as Bearer Token for any further API calls. Please note - this does not apply to SSO Auth Token Request.

Files API

AUTHORIZATION

POST

Get Auth Token

Endpoint
https://api.benekiva.com/auth/authtoken

Benekiva Authorization uses JWT token. Once the user is authenticated, each subsequent request will include the JWT, allowing the user to access routes, services, and resources that are permitted with that token. Single Sign On is a feature that widely uses JWT nowadays, because of its small overhead and its ability to be easily used across different domains. Benekiva is no different.

Header response can support :

application/json

Parameter in the body :

body
This field is required.
Example of the body value:
  • {} 2 keys
    • "[API KEY]"
    • "[CLIENT SECRET]"

Responses code status and descriptions :

200
POST

Request SSO URI

Endpoint
https://api.benekiva.com/auth/generatessotoken

SSO handshake can be done between authorized client with valid apiKey and client Secret and Benekiva in the granted role of either FHD or CSR.

This is preliminary release of SSO feature and subjected to change although not architecturally.

"apiKey" and "clientSecret" can be obtained from Benekiva by login in as dev credential. Please reach out to Benekiva team if you do not have those credentials handy or needs tutorial to reset them.

"grant Role" - This can either take "CSR" or "FHD" as values.

If the supplied value is "FHD", "fhNum" becomes required field.

"incUsers" - This accepts array of email addresses for which you need to see all the claims submitted and processed too. This comes handy if one employee needs to see and process claims started by another employee. It only works for the included users whose role is the same as "grant role" above.

"authorizedEmail" is the person's email to whom authorization need to be granted. If email is not found in Benekiva, the user account will be created automatically.

In the Response object, Sso_Uri can be directly called upon to connect to single sign on into Benekiva.

Header response can support :

application/json

Parameter in the body :

body
This field is required.
Example of the body value:
  • {} 7 keys
    • "[apiKey]"
    • "[clientSecret]"
    • "[FHD or CSR]"
    • "[polNum]"
    • "[fhNum]"
    • [] 1 item
      • "[Email Address of Authorized Person To Be Granted]"

    Responses code status and descriptions :

    200

    AGENTS

    GET

    Get Single Agent

    Endpoint
    https://api.benekiva.com/api/agents/{agentId}

    Suitable For Single Query of a Agent with a given ID.

    Header response can support :

    application/json

    Parameter in the path :

    agentId
    This field is required.

    Parameter in the body :

    Content-Type
    This field is required.

    Responses code status and descriptions :

    200
    PATCH

    Update Single Agent

    Endpoint
    https://api.benekiva.com/api/agents/{agentId}

    Update part of AGENT payload.

    Header response can support :

    application/json

    Parameter in the path :

    agentId
    This field is required.

    Parameter in the body :

    body
    This field is required.
    Example of the body value:
    • {} 2 keys
      • "424234243"
      • "SFFAF"

    Responses code status and descriptions :

    200
    POST

    Agent Search

    Endpoint
    https://api.benekiva.com/api/agents/search

    Retrieve a list of agents by page number, size, sort, order and search text.

    Header response can support :

    application/json

    Parameter in the body :

    body
    This field is required.
    Example of the body value:
    • {} 5 keys
      • 1
      • 20
      • "updatedAt"
      • "asc"
      • "{{searchText}}"

    Responses code status and descriptions :

    200
    PUT

    Agents Bacth Upload

    Endpoint
    https://api.benekiva.com/api/agents/batchupload

    isFresh property is important as it determines whether the list needs to be inserted or simply updated.

    isFresh = true means list to be inserted.

    isFresh = false means list to be updated.

    Header response can support :

    application/json

    Parameter in the body :

    body
    This field is required.
    Example of the body value:
    • {} 2 keys
      • true
      • [] 9 items

      Responses code status and descriptions :

      200
      DELETE

      Agents Delete All

      Endpoint
      https://api.benekiva.com/api/agents/deleteall

      DELETE ALL

      Header response can support :

      application/json

      Parameter in the body :

      Content-Type
      This field is required.

      Responses code status and descriptions :

      200
      GET

      Agent List

      Endpoint
      https://api.benekiva.com/api/agents/list

      Retrieves list of all active agents

      Header response can support :

      application/json

      Parameter in the body :

      Content-Type
      This field is required.

      Responses code status and descriptions :

      200

      POLICIES

      GET

      Get Policy List

      Endpoint
      https://api.benekiva.com/api/policies

      Get Policy List

      Header response can support :

      application/json

      Parameter in the body :

      Content-Type
      This field is required.

      Responses code status and descriptions :

      200
      DELETE

      Remove All Policies

      Endpoint
      https://api.benekiva.com/api/policies/deleteall

      Remove All Policies

      Header response can support :

      application/json

      Parameter in the body :

      Content-Type
      This field is required.

      Responses code status and descriptions :

      200
      PUT

      Policies Batch Upload

      Endpoint
      https://api.benekiva.com/api/policies/batchupload

      This end point is used for uploading batch of policy holder information. Please use maximum of 1000 records for each call. Indicate "isFresh" as true if the intention is to create records from scratch.

      Header response can support :

      application/json

      Parameter in the body :

      body
      This field is required.
      Example of the body value:
      • {} 2 keys
        • true
        • [] 13 items

        Responses code status and descriptions :

        200
        GET

        Beneficiary Batch Upload

        Endpoint
        https://api.benekiva.com/api/policyholders/beneficiarybatchupload

        Beneficiary Batch Upload

        Header response can support :

        application/json

        Parameter in the body :

        Content-Type
        This field is required.

        Responses code status and descriptions :

        200
        POST

        Financial Info

        Endpoint
        https://api.benekiva.com/api/caseloads/financialinfo

        This endpoint is used for obtaining all terminated policies with the payouts information for given begin date and end date.

        Header response can support :

        application/json

        Parameter in the body :

        body
        This field is required.
        Example of the body value:
        • {} 2 keys
          • "05/21/2018"
          • "05/22/2018"

        Responses code status and descriptions :

        200
        POST

        Streamfile

        Endpoint
        https://api.benekiva.com/api/caseloads/streamfile

        This end point is called to fetch the document (currently in PDF format). In order to do so, you will need to have pdfFileId property handy and pass it as body request.

        Header response can support :

        application/json

        Parameter in the body :

        body
        This field is required.
        Example of the body value:
        • {} 1 key
          • "[FILE ID]"

        Responses code status and descriptions :

        200
        POST

        Payout Details By Transaction ID

        Endpoint
        https://api.benekiva.com/api/pay/getStatusDetails

        Get Payout details by providing transaction Id.

        Header response can support :

        application/json

        Parameter in the body :

        body
        This field is required.
        Example of the body value:
        • {} 1 key
          • "{{transactionId}}"

        Responses code status and descriptions :

        200
        POST

        Upload a Single File for Caseload

        Endpoint
        https://api.benekiva.com/api/caseloads/uploadDocument/{caseloadID}

        This end point is used to uploading document for a given caseload. This end point requires caseload id as part of the URL.

        Header response can support :

        application/json

        Parameter in the path :

        caseloadID
        This field is required.

        Parameter in the body :

        Content-Type
        This field is required.
        file
        This field is required. this is required field. a single source file is expected.

        Responses code status and descriptions :

        200

        BATCH RUN

        POST

        Post Run Batch Job

        Endpoint
        https://api.benekiva.com/batchprocess/postrun

        POST RUN BATCH JOB

        Header response can support :

        application/json

        Parameter in the body :

        body
        This field is required.
        Example of the body value:
        • {} 1 key
          • "Sep25th-0105"

        Responses code status and descriptions :

        200
        POST

        Pre Run Batch Job

        Endpoint
        https://api.benekiva.com/batchprocess/prerun

        PRE RUN BATCH JOB

        Header response can support :

        application/json

        Parameter in the body :

        body
        This field is required.
        Example of the body value:
        • {} 1 key
          • "Sep25th-0105"

        Responses code status and descriptions :

        200

        BENEFICIARIES

        Please follow the sample payload data and create your payload accordingly. the only mapper in this case is by policy number. so make sure you provide that correctly

        PUT

        Put Beneficiary Batch Upload

        Endpoint
        https://api.benekiva.com/api/policyholders/beneficiarybatchupload

        Beneficiary Batch Upload

        Header response can support :

        application/json

        Parameter in the body :

        body
        This field is required.
        Example of the body value:
        • {} 1 key
          • [] 1 item

          Responses code status and descriptions :

          200

          DEDICATED BENEFICIARIES

          These are dedicated beneficiaries who process claims on behalf of an organization on regular basis. these can be a estate or an agent or both.

          GET

          Get Single Dedicated Bene

          Endpoint
          https://api.benekiva.com/api/dedicatedbenes/{dedicatedBeneID}

          Suitable For Single Query of a DEDICATED BENE with a given ID.

          Header response can support :

          application/json

          Parameter in the path :

          dedicatedBeneID
          This field is required.

          Parameter in the body :

          Content-Type
          This field is required.

          Responses code status and descriptions :

          200
          PATCH

          Update Single Dedicated Bene

          Endpoint
          https://api.benekiva.com/api/dedicatedbenes/{dedicatedBeneID}

          Update part of DEDICATED BENE payload.

          Header response can support :

          application/json

          Parameter in the path :

          dedicatedBeneID
          This field is required.

          Parameter in the body :

          body
          This field is required.
          Example of the body value:
          • {} 2 keys
            • "424234243"
            • "SFFAF"

          Responses code status and descriptions :

          200
          POST

          Dedicated Bene Search

          Endpoint
          https://api.benekiva.com/api/dedicatedbenes/search

          Retrieve a list of dedicated beneficiaries by page number, size, sort, order and search text.

          Header response can support :

          application/json

          Parameter in the body :

          body
          This field is required.
          Example of the body value:
          • {} 5 keys
            • 1
            • 20
            • "updatedAt"
            • "asc"
            • "{{searchText}}"

          Responses code status and descriptions :

          200
          PUT

          Dedicated Bene Batch Upload

          Endpoint
          https://api.benekiva.com/api/dedicatedbenes/batchupload

          isFresh property is important as it determines whether the list needs to be inserted or simply updated.

          isFresh = true means list to be inserted.

          isFresh = false means list to be updated.

          Header response can support :

          application/json

          Parameter in the body :

          body
          This field is required.
          Example of the body value:
          • {} 2 keys
            • true
            • [] 9 items

            Responses code status and descriptions :

            200
            DELETE

            Dedicated Bene Delete ALl

            Endpoint
            https://api.benekiva.com/api/dedicatedbenes/deleteall

            DELETE ALL

            Header response can support :

            application/json

            Parameter in the body :

            Content-Type
            This field is required.

            Responses code status and descriptions :

            200
            GET

            Dedicated Bene List

            Endpoint
            https://api.benekiva.com/api/dedicatedbenes/list

            Retrieves list of all active DEDICATED BENEFICIARIES

            Header response can support :

            application/json

            Parameter in the body :

            Content-Type
            This field is required.

            Responses code status and descriptions :

            200

            FUNERAL HOMES

            GET

            Get Single FH

            Endpoint
            https://api.benekiva.com/api/funeralhomes/{funeralHomeID}

            Suitable For Single Query of a Funeral Home With a given ID.

            Header response can support :

            application/json

            Parameter in the path :

            funeralHomeID
            This field is required.

            Parameter in the body :

            Content-Type
            This field is required.

            Responses code status and descriptions :

            200
            PATCH

            Update Single FH

            Endpoint
            https://api.benekiva.com/api/funeralhomes/{funeralHomeID}

            Update part of Funeral home payload.

            Header response can support :

            application/json

            Parameter in the path :

            funeralHomeID
            This field is required.

            Parameter in the body :

            body
            This field is required.
            Example of the body value:
            • {} 2 keys
              • "424234243"
              • "SFFAF"

            Responses code status and descriptions :

            200
            POST

            FH Search

            Endpoint
            https://api.benekiva.com/api/funeralhomes/search

            Retrieve a list of funeral homes by page number, size, sort, order and search text.

            Header response can support :

            application/json

            Parameter in the body :

            body
            This field is required.
            Example of the body value:
            • {} 5 keys
              • 1
              • 20
              • "updatedAt"
              • "asc"
              • "{{searchText}}"

            Responses code status and descriptions :

            200
            PUT

            Funeral Homes Batch Upload

            Endpoint
            https://api.benekiva.com/api/funeralhomes/batchupload

            isFresh property is important as it determines whether the list needs to be inserted or simply updated.

            isFresh = true means list to be inserted.

            isFresh = false means list to be updated.

            Header response can support :

            application/json

            Parameter in the body :

            body
            This field is required.
            Example of the body value:
            • {} 2 keys
              • true
              • [] 9 items

              Responses code status and descriptions :

              200
              DELETE

              Funeral Homes Delete All

              Endpoint
              https://api.benekiva.com/api/funeralhomes/deleteall

              DELETE ALL

              Header response can support :

              application/json

              Parameter in the body :

              Content-Type
              This field is required.

              Responses code status and descriptions :

              200
              GET

              Funeral Homes List

              Endpoint
              https://api.benekiva.com/api/funeralhomes/list

              Funeral Homes List

              Header response can support :

              application/json

              Parameter in the body :

              Content-Type
              This field is required.

              Responses code status and descriptions :

              200

              STAY IN TOUCH

              Subscribe to our newsletter and be informed about newest trends.

              Loading...

              VIRTUAL OFFICE

              301 North Main Road Suite 2400
              Winston-Salem Nc 27101
              United States