Documentation Powered by Redocly

Mobile API (2023-01-01)

Download OpenAPI specification:Download

Google-Wallet

Get Google Wallet configuration (service email and issuer ID)

Responses

Response samples

Content type
application/json
{
  • "svc_email": "string",
  • "issuer_id": "string"
}

Claims

Get claims for a member

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "pharmacy_claims": [
    ],
  • "is_someone_missing": true,
  • "medical_claims": [
    ]
}

Download pre-filled release form

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
"string"

Get accumulators for a member plan

path Parameters
member-external-id
required
string
member-plan-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "accumulators": [
    ],
  • "individuals": [
    ],
  • "family_accumulators": [
    ],
  • "is_someone_missing": true,
  • "has_family": true
}

Download a claim EOB

path Parameters
person-external-id
required
string
claim-number
required
string

Responses

Response samples

Content type
application/json
"string"

Contact Gravie Care

Contact Us Details

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "hours_of_operation": "string",
  • "phone_numbers": {
    }
}

Submit all Inquiry types from mobile clients

path Parameters
member-external-id
required
string
Request Body schema: application/json
attachments
Array of strings or null
type
required
string
Enum: "BILL" "CLAIM" "ICHRA" "OTHER" "PROVIDER_CLAIM" "PROVIDER_ELIGIBILITY" "PROVIDER_GRAVIE"
inquiry_id
required
string
message
required
string
object

Responses

Request samples

Content type
application/json
{
  • "attachments": [
    ],
  • "type": "BILL",
  • "inquiry_id": "string",
  • "message": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Submit a file to support an inquiry.

path Parameters
member-external-id
required
string
query Parameters
inquiry_id
required
string
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{
  • "s3-key": "string"
}

Sends a secure message to Gravie Care Team

path Parameters
member-external-id
required
string
Request Body schema: application/json
message
required
string

Responses

Request samples

Content type
application/json
{
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Inquiries

Submit all Inquiry types from mobile clients

path Parameters
member-external-id
required
string
Request Body schema: application/json
attachments
Array of strings or null
type
required
string
Enum: "BILL" "CLAIM" "ICHRA" "OTHER" "PROVIDER_CLAIM" "PROVIDER_ELIGIBILITY" "PROVIDER_GRAVIE"
inquiry_id
required
string
message
required
string
object

Responses

Request samples

Content type
application/json
{
  • "attachments": [
    ],
  • "type": "BILL",
  • "inquiry_id": "string",
  • "message": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Submit a file to support an inquiry.

path Parameters
member-external-id
required
string
query Parameters
inquiry_id
required
string
Request Body schema: multipart/form-data
object

Responses

Response samples

Content type
application/json
{
  • "s3-key": "string"
}

Gravie Pay

Get gravie pay summary information

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "gravie_pay": {
    }
}

Update the standard payment schedule for a member

path Parameters
member-external-id
required
string
Request Body schema: application/json
standard_payment_schedule
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "standard_payment_schedule": 0
}

Response samples

Content type
application/json
{
  • "gravie_pay": {
    }
}

Record that the Member has viewed the EFTA message

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
null

Gravie Pay Enrollment

Initiate Gravie Pay enrollment process for the member

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "activation_status": "ACTIVATED",
  • "agreements": [
    ],
  • "payroll_integration": true
}

Complete Gravie Pay enrollment process for the member

path Parameters
member-external-id
required
string
Request Body schema: application/json
agreement_tags
required
Array of strings
standard_payment_schedule
required
integer <int64>
required
object

Responses

Request samples

Content type
application/json
{
  • "agreement_tags": [
    ],
  • "standard_payment_schedule": 0,
  • "atr": {
    }
}

Response samples

Content type
application/json
{
  • "gravie_pay": {
    }
}

Gravie Pay Agreement

Accept agreements

Accept the Paytient agreements associated with the list of tags

path Parameters
member-external-id
required
string
Request Body schema: application/json
agreement_tags
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "agreement_tags": [
    ]
}

Response samples

Content type
application/json
{
  • "gravie_pay": {
    }
}

Fetch the agreement for the given tag.

path Parameters
member-external-id
required
string
agreement-tag
required
string

Responses

Response samples

Content type
application/json
{
  • "agreement": {
    }
}

Gravie Pay Card

Get gravie pay cardholder data

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "card": {
    }
}

Gravie Pay Evidence

Fetch evidence list

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "evidences": [
    ]
}

Upload evidence for ID verification

path Parameters
member-external-id
required
string
Request Body schema: multipart/form-data
data
required
string

Base64 encoded data

mime
required
string
Enum: "image/jpeg" "image/jpg" "image/png" "application/pdf"
type
required
string
Enum: "DRIVERS_LICENSE" "STATE_ID" "US_PASSPORT" "MARRIAGE_LICENSE" "UTILITY_BILL" "SSN_CARD" "GREEN_CARD" "I_765_APPLICATION_FOR_EMPLOYMENT_AUTHORIZATION" "USCIS_APPLICATION_RECEIPT" "US_BIRTH_CERTIFICATE" "CERTIFICATE_OF_NATURALIZATION" "CERTIFICATE_OF_CITIZENSHIP" "REPORT_OF_BIRTH_ABROAD_OF_US_CITIZEN"

Responses

Response samples

Content type
application/json
{
  • "evidences": [
    ]
}

Gravie Pay Payment Method

Get gravie pay payment methods

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "payment_methods": [
    ],
  • "attributes": [
    ]
}

Link a bank account

The request information will come from the Plaid SDK. This endpoint should be used only after the addition of a bank account.

path Parameters
member-external-id
required
string
Request Body schema: application/json
account_id
required
string
public_token
required
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "string",
  • "public_token": "string"
}

Response samples

Content type
application/json
{
  • "payment_methods": [
    ],
  • "attributes": [
    ]
}

Retrieve a Plaid token so it can be used with the Plaid SDK

If you use the optional payment method id query param, the endpoint will return the token associated with this payment method.

path Parameters
member-external-id
required
string
query Parameters
payment-method-id
integer <int64>
ios-redirect-uri
string
android-package-name
string

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Delete a payment method

path Parameters
member-external-id
required
string
payment-method-id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "payment_methods": [
    ],
  • "attributes": [
    ]
}

Add a credit card

path Parameters
member-external-id
required
string
payment-method-id
required
string
Value: "credit-card"
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "card": {
    }
}

Response samples

Content type
application/json
{
  • "payment_methods": [
    ],
  • "attributes": [
    ]
}

Update a payment method

The only action allowed is to set the payment method as default.

path Parameters
member-external-id
required
string
payment-method-id
required
integer <int64>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "payment_method": {
    }
}

Response samples

Content type
application/json
{
  • "payment_methods": [
    ],
  • "attributes": [
    ]
}

Gravie Pay Statement

Get gravie pay statements

path Parameters
member-external-id
required
string
query Parameters
offset
integer <int64>
limit
integer <int64>
order
string
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "statements": [
    ]
}

Download statement content

path Parameters
member-external-id
required
string
statement-id
required
integer <int64>

Responses

Response samples

Content type
application/json
"string"

Gravie Pay Transaction

Get gravie pay transactions

offset is 0 and limit is 50 by default.

path Parameters
member-external-id
required
string
query Parameters
offset
integer <int64>
limit
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Fetch gravie pay transaction details (including payments)

path Parameters
member-external-id
required
string
transaction-id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "payments": [
    ],
  • "payoff_date": "2020-10-10",
  • "payment_start_date": "2020-10-10",
  • "transaction": {
    },
  • "payments_left": 0
}

Get gravie pay transaction payments

[DEPRECATED!] Use GET /member/{external-id}/transaction/{transaction-id} instead.

path Parameters
member-external-id
required
string
transaction-id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "payments": [
    ],
  • "payoff_date": "2020-10-10",
  • "payment_start_date": "2020-10-10",
  • "payments_left": 0
}

Add a one time payment to the transaction

path Parameters
member-external-id
required
string
transaction-id
required
integer <int64>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "payment": {
    }
}

Response samples

Content type
application/json
{
  • "payments": [
    ],
  • "payoff_date": "2020-10-10",
  • "payment_start_date": "2020-10-10",
  • "transaction": {
    },
  • "payments_left": 0
}

Update gravie pay transaction payment plan

path Parameters
member-external-id
required
string
transaction-id
required
integer <int64>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "payment_plan": {
    }
}

Response samples

Content type
application/json
{
  • "payments": [
    ],
  • "payoff_date": "2020-10-10",
  • "payment_start_date": "2020-10-10",
  • "transaction": {
    },
  • "payments_left": 0
}

Get gravie pay transaction payment plan options

It may be used for displaying the payment selection when the user wants to edit the payment scheduling.

path Parameters
member-external-id
required
string
transaction-id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "payment_plan_options": [
    ]
}

Id Card

Id Card information

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "id_card": {
    }
}

Mobile App

Log for the mobile app

path Parameters
member-external-id
required
string
Request Body schema: application/json
level
required
any
Enum: "INFO" "WARN" "ERROR"
object
required
object

Responses

Request samples

Content type
application/json
{
  • "level": "INFO",
  • "metadata": {
    },
  • "data": {
    }
}

Response samples

Content type
application/json
null

Fetch mobile application notification banners

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Check if Mobile App version is supported

query Parameters
os
required
string
Default: "ios"
Enum: "ios" "android"
version
required
string <semver>
Examples:
  • version=1.4.3 - valid
  • version=1.4 - invalid

Responses

Response samples

Content type
application/json
{
  • "action": "UPGRADE_REQUIRED"
}

Fetch county list for a zip code.

query Parameters
zip-code
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Member Plan

List of plans

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "member_plans": [
    ]
}

Get member plan

path Parameters
member-external-id
required
string
member-plan-external-id
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "member_plan": {
    },
  • "type": "MEMBER"
}

Profile

Get member profile data. In the mobile app, this endpoint should be used to help building the home screen.

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "capabilities": [
    ],
  • "dependents": [
    ],
  • "person_details": {
    },
  • "effective_member_medical_plan": {
    },
  • "member_client_url": "string",
  • "home_banner": {
    },
  • "gravie_care": {
    }
}

Ability to update member & dependent's address data

path Parameters
member-external-id
required
string
Request Body schema: application/json
object or null
dependent_external_id
string or null
address_identical
required
boolean

Responses

Request samples

Content type
application/json
{
  • "mailing_address": {
    },
  • "dependent_external_id": "string",
  • "address_identical": true
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Ability to update the member credentials

path Parameters
member-external-id
required
string
Request Body schema: application/json
current_password
required
string
username
string or null
new_password
string or null

Responses

Request samples

Content type
application/json
{
  • "current_password": "string",
  • "username": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Client SSO APIs

Get ESI SSO SAML response for member

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "form_name": "string",
  • "saml_assertion": "string",
  • "relay_state": "string",
  • "action_url": "string"
}

Get Talon SSO URL for member

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

ESI SSO API

Get ESI SSO SAML response for member

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "form_name": "string",
  • "saml_assertion": "string",
  • "relay_state": "string",
  • "action_url": "string"
}

Talon SSO API

Get Talon SSO URL for member

path Parameters
member-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

Apple-Wallet-Pass-Generation

An API to return back the pkpass for a member/dependent to be used in Apple Wallet

path Parameters
member-external-id
required
string
Request Body schema: application/json
description
required
string
logoText
string
serialNumber
required
string
object
organizationName
required
string
Array of objects
required
object
formatVersion
integer <int64>
teamIdentifier
required
string
passTypeIdentifier
required
string
backgroundColor
required
string
foregroundColor
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "logoText": "string",
  • "serialNumber": "string",
  • "barcode": {
    },
  • "organizationName": "string",
  • "locations": [
    ],
  • "generic": {
    },
  • "formatVersion": 0,
  • "teamIdentifier": "string",
  • "passTypeIdentifier": "string",
  • "backgroundColor": "string",
  • "foregroundColor": "string"
}

Response samples

Content type
application/json
"string"

Account Registration

create account for a member or dependent

Request Body schema: application/json
required
object
required
object
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "person": {
    },
  • "legal_guardian": {
    },
  • "user": {
    }
}

Response samples

Content type
application/json
null

AdditionalCoverage APIs

Member+Person Additional Coverages

path Parameters
person-external-id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Member/Person Additional Coverage

path Parameters
person-external-id
required
string
Request Body schema: application/json
policy_type
any or null
Enum: "INDIVIDUAL" "SUPPLEMENTAL" "OTHER"
coverage_type
required
any
Enum: "MEDICARE" "MEDICAID" "PRIVATE" "GOVERNMENT" "COMMERCIAL" "GROUP" "INDIVIDUAL" "UNKNOWN"
medicare_entitlement
any or null
Enum: "AGE" "DISABLED" "ESRD"
person_external_id
required
string
primary_coverage_holder
any or null
Enum: "MEMBER" "POLICY_HOLDER"
policy_holder_first_name
string or null
effective_from_date
string or null
medicare_part_c_effective_from
string or null
divorce_decree_indicator
any or null
Enum: "YES" "NO"
last_updated
string or null
carrier_name
required
string
medicare_part_b_effective_from
string or null
product_type
required
any
Enum: "MEDICAL" "HRA" "HSA" "DENTAL" "VISION" "LIFE" "SUPPLEMENTAL" "CASH_OUT"
medicare_part_a_effective_from
string or null
group_id
string or null
policy_holder_relationship
any or null
Enum: "CHILD_OF" "DIVORCED_FROM" "MARRIED_TO" "NEVER_MARRIED_LIVES_WITH" "NEVER_MARRIED_LIVES_APART" "PARENT_OF" "SEPARATED_FROM" "SELF"
medicare_part_c_effective_thru
string or null
effective_thru_date
string or null
medicare_part_a_effective_thru
string or null
medicare_part_b_effective_thru
string or null
assigned_user
string or null
gravie_status
any or null
Enum: "PRIMARY" "SECONDARY" "UNKNOWN"
policy_holder_last_name
string or null
coverage_id
string or null
date_created
string or null
policy_holder_birth_date
string or null

Responses

Request samples

Content type
application/json
{
  • "policy_type": "INDIVIDUAL",
  • "coverage_type": "MEDICARE",
  • "medicare_entitlement": "AGE",
  • "person_external_id": "string",
  • "primary_coverage_holder": "MEMBER",
  • "policy_holder_first_name": "string",
  • "effective_from_date": "string",
  • "medicare_part_c_effective_from": "string",
  • "divorce_decree_indicator": "YES",
  • "last_updated": "string",
  • "carrier_name": "string",
  • "medicare_part_b_effective_from": "string",
  • "product_type": "MEDICAL",
  • "medicare_part_a_effective_from": "string",
  • "group_id": "string",
  • "policy_holder_relationship": "CHILD_OF",
  • "medicare_part_c_effective_thru": "string",
  • "effective_thru_date": "string",
  • "medicare_part_a_effective_thru": "string",
  • "medicare_part_b_effective_thru": "string",
  • "assigned_user": "string",
  • "gravie_status": "PRIMARY",
  • "policy_holder_last_name": "string",
  • "coverage_id": "string",
  • "date_created": "string",
  • "policy_holder_birth_date": "string"
}

Response samples

Content type
application/json
{
  • "policy_type": "INDIVIDUAL",
  • "coverage_type": "MEDICARE",
  • "medicare_entitlement": "AGE",
  • "person_external_id": "string",
  • "primary_coverage_holder": "MEMBER",
  • "policy_holder_first_name": "string",
  • "effective_from_date": "string",
  • "medicare_part_c_effective_from": "2020-10-10",
  • "divorce_decree_indicator": "YES",
  • "last_updated": "string",
  • "carrier_name": "string",
  • "medicare_part_b_effective_from": "2020-10-10",
  • "product_type": "MEDICAL",
  • "medicare_part_a_effective_from": "2020-10-10",
  • "group_id": "string",
  • "policy_holder_relationship": "CHILD_OF",
  • "medicare_part_c_effective_thru": "2020-10-10",
  • "effective_thru_date": "string",
  • "medicare_part_a_effective_thru": "2020-10-10",
  • "external_id": "string",
  • "medicare_part_b_effective_thru": "2020-10-10",
  • "assigned_user": "string",
  • "gravie_status": "PRIMARY",
  • "policy_holder_last_name": "string",
  • "coverage_id": "string",
  • "date_created": "string",
  • "policy_holder_birth_date": "2020-10-10"
}

Delete Member/Person's Additional Coverage

path Parameters
person-external-id
required
string
additional-coverage-external-id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Update Member/Person's Additional Coverage

path Parameters
person-external-id
required
string
additional-coverage-external-id
required
string
Request Body schema: application/json
policy_type
any or null
Enum: "INDIVIDUAL" "SUPPLEMENTAL" "OTHER"
coverage_type
required
any
Enum: "MEDICARE" "MEDICAID" "PRIVATE" "GOVERNMENT" "COMMERCIAL" "GROUP" "INDIVIDUAL" "UNKNOWN"
medicare_entitlement
any or null
Enum: "AGE" "DISABLED" "ESRD"
person_external_id
required
string
primary_coverage_holder
any or null
Enum: "MEMBER" "POLICY_HOLDER"
policy_holder_first_name
string or null
effective_from_date
string or null
medicare_part_c_effective_from
string or null
divorce_decree_indicator
any or null
Enum: "YES" "NO"
last_updated
string or null
carrier_name
required
string
medicare_part_b_effective_from
string or null
product_type
required
any
Enum: "MEDICAL" "HRA" "HSA" "DENTAL" "VISION" "LIFE" "SUPPLEMENTAL" "CASH_OUT"
medicare_part_a_effective_from
string or null
group_id
string or null
policy_holder_relationship
any or null
Enum: "CHILD_OF" "DIVORCED_FROM" "MARRIED_TO" "NEVER_MARRIED_LIVES_WITH" "NEVER_MARRIED_LIVES_APART" "PARENT_OF" "SEPARATED_FROM" "SELF"
medicare_part_c_effective_thru
string or null
effective_thru_date
string or null
medicare_part_a_effective_thru
string or null
external_id
required
string
medicare_part_b_effective_thru
string or null
assigned_user
string or null
gravie_status
any or null
Enum: "PRIMARY" "SECONDARY" "UNKNOWN"
policy_holder_last_name
string or null
coverage_id
string or null
date_created
string or null
policy_holder_birth_date
string or null

Responses

Request samples

Content type
application/json
{
  • "policy_type": "INDIVIDUAL",
  • "coverage_type": "MEDICARE",
  • "medicare_entitlement": "AGE",
  • "person_external_id": "string",
  • "primary_coverage_holder": "MEMBER",
  • "policy_holder_first_name": "string",
  • "effective_from_date": "string",
  • "medicare_part_c_effective_from": "string",
  • "divorce_decree_indicator": "YES",
  • "last_updated": "string",
  • "carrier_name": "string",
  • "medicare_part_b_effective_from": "string",
  • "product_type": "MEDICAL",
  • "medicare_part_a_effective_from": "string",
  • "group_id": "string",
  • "policy_holder_relationship": "CHILD_OF",
  • "medicare_part_c_effective_thru": "string",
  • "effective_thru_date": "string",
  • "medicare_part_a_effective_thru": "string",
  • "external_id": "string",
  • "medicare_part_b_effective_thru": "string",
  • "assigned_user": "string",
  • "gravie_status": "PRIMARY",
  • "policy_holder_last_name": "string",
  • "coverage_id": "string",
  • "date_created": "string",
  • "policy_holder_birth_date": "string"
}

Response samples

Content type
application/json
{
  • "policy_type": "INDIVIDUAL",
  • "coverage_type": "MEDICARE",
  • "medicare_entitlement": "AGE",
  • "person_external_id": "string",
  • "primary_coverage_holder": "MEMBER",
  • "policy_holder_first_name": "string",
  • "effective_from_date": "string",
  • "medicare_part_c_effective_from": "2020-10-10",
  • "divorce_decree_indicator": "YES",
  • "last_updated": "string",
  • "carrier_name": "string",
  • "medicare_part_b_effective_from": "2020-10-10",
  • "product_type": "MEDICAL",
  • "medicare_part_a_effective_from": "2020-10-10",
  • "group_id": "string",
  • "policy_holder_relationship": "CHILD_OF",
  • "medicare_part_c_effective_thru": "2020-10-10",
  • "effective_thru_date": "string",
  • "medicare_part_a_effective_thru": "2020-10-10",
  • "external_id": "string",
  • "medicare_part_b_effective_thru": "2020-10-10",
  • "assigned_user": "string",
  • "gravie_status": "PRIMARY",
  • "policy_holder_last_name": "string",
  • "coverage_id": "string",
  • "date_created": "string",
  • "policy_holder_birth_date": "2020-10-10"
}

Resources

Fetch a given static public image

Used as a proxy for our S3 public images so we can support, for example, dark mode.

query Parameters
url-b64
required
string
dark
boolean

Responses

Response samples

Content type
application/json
"string"