Page Comparison

Table of Contents

Create / update delete / retrieve insurance detail

Sample insurance schema:

...

title	Click to expand insurance schema

...

language	json

...

Table of Contents

Create / update delete / retrieve insurance detail

Info
The following APIs can be called using patient’s token or Clinic Admin token

`GET api_v3/users/`

...

`:user_id`

...

`/insurances`
Status
colour Yellow
title V3

This returns a list of insurance cards associated with this user

Expand

title	Response (200)

Code Block

language	json

{
    "data": [
        {
            "card_type": "primary",
            "insurer_code": "(sandbox) HUMANA",
            "subscriber_number": "11000022",
            "group_number": "GN00022",
            "responsible_party": "self",
            "guarantor_first_name": "VSee",
            "guarantor_middle_name": "Edward",
            "guarantor_last_name": "Patient 11000022",
            "guarantor_dob": "1986-01-01",
            "guarantor_gender": 21,
            "guarantor_address": "54 Rainbow St",
            "guarantor_address_2": "#12-22",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        },
        {
            "card_type": "secondary",
            "insurer_code": "(sandbox) CALIFORNIA MEDICAL",
            "subscriber_num": "11000023",
            "responsible_party": "child",
            "guarantor_first_name": "VSee",
            "guarantor_last_name": "Patient 11000023",
            "guarantor_middle_name": "Edward",
            "guarantor_dob": "1944-01-01",
            "guarantor_gender": 2,
            "guarantor_address": "52 Rainbow St",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        }
    ],
    "version": "2.0"
}

...

`POST api_v3/users/{user_id}/insurances/import`
...
Post in array
Status
colour Yellow
title V3

Payload should include array of up to 2 insurance detail, one is primary and the other is secondary
If insurance type already exists, it will be overwritten

Expand

title	Request payload

Code Block

language	json

{
    "insurances": [
        {
            "card_type": "primary",
            "insurer_code": "(sandbox) HUMANA",
            "subscriber_number": "11000022",
            "group_number": "GN00022",
            "responsible_party": "self",
            "guarantor_first_name": "VSee",
            "guarantor_last_name": "Patient 11000022",
            "guarantor_middle_name": "Edward",
            "guarantor_dob": "1986-01-01",
            "guarantor_gender": 21,
            "guarantor_address": "54 Rainbow St",
            "guarantor_address_2": "#12-22",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        },
        {
            "card_type": "secondary",
            "insurer_code": "(sandbox) CALIFORNIA MEDICAL",
            "subscriber_number": "11000023",
            "responsible_party": "child",
            "guarantor_first_name": "VSee",
            "guarantor_last_name": "Patient 11000023",
            "guarantor_middle_name": "Edward",
            "guarantor_dob": "1944-01-01",
            "guarantor_gender": 2,
            "guarantor_address": "52 Rainbow St",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        }
    ]
}

Expand

title	Response (200)

Code Block

language	json

{
    "data": [
        {
            "card_type": "primary",
            "insurer_code": "(sandbox) HUMANA",
            "subscriber_number": "11000022",
            "group_number": "GN00022",
            "responsible_party": "self",
            "guarantor_first_name": "VSee",
            "guarantor_middle_name": "Edward",
            "guarantor_last_name": "Patient 11000022",
            "guarantor_dob": "1986-01-01",
            "guarantor_gender": 21,
            "guarantor_address": "54 Rainbow St",
            "guarantor_address_2": "#12-22",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        },
        {
            "card_type": "secondary",
            "insurer_code": "(sandbox) CALIFORNIA MEDICAL",
            "subscriber_number": "11000023",
            "responsible_party": "child",
            "guarantor_first_name": "VSee",
            "guarantor_last_name": "Patient 11000023",
            "guarantor_middle_name": "Edward",
            "guarantor_dob": "1944-01-01",
            "guarantor_gender": 2,
            "guarantor_address": "52 Rainbow St",
            "guarantor_city": "Sunnyvale",
            "guarantor_zip": "10001",
            "guarantor_state": "CA",
            "consent": true
        }
    ],
    "version": "2.0"
}

`POST api_v3/users/{user_id}/insurances/{`

...

`primary|secondary}`

...

Status
colour Yellow
title V3

Update primary or secondary insurance

Expand

title	Request payload

Code Block

language	json

 {
    "card_type": "primary",
    "insurer_code": "(sandbox) HUMANA",
    "subscriber_number": "11000022",
    "group_number": "GN00022",
    "responsible_party": "self",
    "guarantor_first_name": "VSee",
    "guarantor_last_name": "Patient 11000022",
    "guarantor_middle_name": "Edward",
    "guarantor_dob": "1986-01-01",
    "guarantor_gender": 21,
    "guarantor_address": "54 Rainbow St",
    "guarantor_address_2": "#12-22",
    "guarantor_city": "Sunnyvale",
    "guarantor_zip": "10001",
    "guarantor_state": "CA",
    "consent": true
}

Expand

title	Response (200)

Code Block

language	json

{
    "data": {
        "card_type": "primary",
        "insurer_code": "(sandbox) HUMANA",
        "subscriber_number": "11000022",
        "group_number": "GN00022",
        "responsible_party": "self",
        "guarantor_first_name": "VSee",
        "guarantor_middle_name": "Edward",
        "guarantor_last_name": "Patient 11000022",
        "guarantor_dob": "1986-01-01",
        "guarantor_gender": 21,
        "guarantor_address": "54 Rainbow St",
        "guarantor_address_2": "#12-22",
        "guarantor_city": "Sunnyvale",
        "guarantor_zip": "10001",
        "guarantor_state": "CA",
        "consent": true
    },
    "version": "2.0"
}

`GET api_v3/users/{user_id}/insurances/{`

...

`primary|secondary}`
Status
colour Yellow
title V3

Retrieve primary or secondary insurance

Expand

title	Response (200)

Code Block

language	json

{
    "data": {
        "card_type": "primary",

         "insurer_code": "(sandbox) HUMANA",
          "subscriber_number": "11000022",
 
        "group_number": "GN00022",

         "responsible_party": "self",
          "guarantor_first_name": "VSee",
        "guarantor_middle_name": "Edward",
        "guarantor_last_name": "Patient 11000022",
        "guarantor_dob": "1986-01-01",
        "guarantor_middle_namegender": "Edward"1,

         "guarantor_dobaddress": "1986-01-0154 Rainbow St",
 
        "guarantor_address_2": "54 Rainbow St#12-22",
 
        "guarantor_city": "Sunnyvale",
 
        "guarantor_zip": "10001",

         "guarantor_state": "CA",
 
        "consent": true
    },
    "version": "2.0"
}

`DELETE api_v3/users/{user_id}/insurances/{`

...

`primary|secondary}`
Status
colour Yellow
title V3

Expand

title	Response (204)

Code Block
204 No Content

Eligibility check

`POST api_v3/users/{user_id}/insurances/primary/eligibility/check`
Status
colour Yellow
title V3

Check and return queue status and current eligibility statusKnown issue: every post will submit new check (to optimize later)

Expand

title	Response 1 (200 OK)

Code Block

language	json

{
    "data": {
        "job_id": "6552fefa-e620-4caa-9990-26940a7d6499",
        "status": "pending"
    }
}

Expand

title	Response 2 (429 Too Many Requests)

Code Block

language	json

{
    "code": 429,
    "message": "Started at Tue, 14 Nov 2023 12:05:00 +0700"
}

`GET api_v3/users/{user_id}/insurances/primary/eligibility`
Status
colour Yellow
title V3

Return queue status and current eligibility status

...

Versions Compared

Old Version 57

New Version Current

Key

Create / update delete / retrieve insurance detail

Create / update delete / retrieve insurance detail

`GET api_v3/users/`

`:user_id`

`/insurances`
Status
colour Yellow
title V3

`POST api_v3/users/{user_id}/insurances/import`
...
Post in array
Status
colour Yellow
title V3

`POST api_v3/users/{user_id}/insurances/{`

`primary|secondary}`

Status
colour Yellow
title V3

`GET api_v3/users/{user_id}/insurances/{`

`primary|secondary}`
Status
colour Yellow
title V3

`DELETE api_v3/users/{user_id}/insurances/{`

`primary|secondary}`
Status
colour Yellow
title V3

Eligibility check

`POST api_v3/users/{user_id}/insurances/primary/eligibility/check`
Status
colour Yellow
title V3

`GET api_v3/users/{user_id}/insurances/primary/eligibility`
Status
colour Yellow
title V3

Page Comparison

Versions Compared

Old Version 57

New Version Current

Key

Create / update delete / retrieve insurance detail

Create / update delete / retrieve insurance detail

GET api_v3/users/

:user_id

/insurances StatuscolourYellowtitleV3

POST api_v3/users/{user_id}/insurances/import...Post in array StatuscolourYellowtitleV3

POST api_v3/users/{user_id}/insurances/{

primary|secondary}

StatuscolourYellowtitleV3

GET api_v3/users/{user_id}/insurances/{

primary|secondary} StatuscolourYellowtitleV3

DELETE api_v3/users/{user_id}/insurances/{

primary|secondary} StatuscolourYellowtitleV3

Eligibility check

POST api_v3/users/{user_id}/insurances/primary/eligibility/check StatuscolourYellowtitleV3

GET api_v3/users/{user_id}/insurances/primary/eligibility StatuscolourYellowtitleV3

`GET api_v3/users/`

`:user_id`

`/insurances`
Status
colour Yellow
title V3

`POST api_v3/users/{user_id}/insurances/import`
...
Post in array
Status
colour Yellow
title V3

`POST api_v3/users/{user_id}/insurances/{`

`primary|secondary}`

Status
colour Yellow
title V3

`GET api_v3/users/{user_id}/insurances/{`

`primary|secondary}`
Status
colour Yellow
title V3

`DELETE api_v3/users/{user_id}/insurances/{`

`primary|secondary}`
Status
colour Yellow
title V3

`POST api_v3/users/{user_id}/insurances/primary/eligibility/check`
Status
colour Yellow
title V3

`GET api_v3/users/{user_id}/insurances/primary/eligibility`
Status
colour Yellow
title V3