Person Payer

Table of Contents

Sample Request
Sample Response JSON
Notes on Values

Person Payers are records of insurance policies or private setups which pay for the Person’s services. A Person Payer is associated with a single Person. One Person may have multiple Person Payers.

Sample Request #

Headers	Authorization = Bearer [token]
Parameters	None
Body	None

GET https://connect.supportableapp.com/api/persons/{personId}/person-payers

Sample Response JSON #

Status: 200

{
  "id": "639947e7375b94cfdaedad3a",
  "status": true,
  "personId": "63994727375b94cfdaedad34",
  "payer": {
    "id": "633ae130ef17a93715724ef5",
    "name": "DOBIS insurance"
  },
  "payerType": {
    "id": "624eb78318c58b8291b9be72",
    "name": "Commercial"
  },
  "payerIfOther": null,
  "policyHolderName": "Liam Liamson",
  "policyHolderDob": "2001-06-15T00:00:00.000Z",
  "relationship": {
    "id": "62fdfa10e34d63f231759088",
    "name": "Self"
  },
  "relationshipOther": null,
  "groupNumber": "59391",
  "policyNumber": "689492FIZSFH",
  "pmiNumber": null,
  "policyHolderAddress": "St. Paul, MN",
  "isPrimary": false
}

Notes on Values #

Attribute	Data Type	Description
id	string	The unique identifier of the Person Payer.
status	boolean	Whether the Person Payer is active in Supportable. If false, the Person Payer has been removed from the Person’s Payer list in the application.
personId	string	The unique identifier of the Person with whom the Person Payer is associated.
payer	object	The Payer with which the Person Payer is associated.
payer.id	string	The unique identifier of the Payer.
payer.name	string	The name of the Payer Type as it appears in the application.
payerType	object	The Payer Type with which the Payer is associated.
payerType.name	string	The unique identifier of the Relationship.
payerType.name	string	The name of the Relationship as it appears in the application.
payerIfOther	string	The name of the payer associated with the Person Payer record, if not found in the Sub-Entity’s list of Payers.
policyHolderName	string	The name of the policy holder.
policyHolderDob	datetime	The ISO datetime value of the policy holder’s date of birth.
relationship	object	The Relationship of the policy holder to the Person.
relationship.id	string	The unique identifier of the Relationship.
relationship.name	string	The name of the Relationship as it appears in the application.
relationshipOther	string	The name of the policy holder’s relationship to the Person, if not found in the global list of Relationships.
groupNumber	string	The group number for the policy.
policyNumber	string	The policy number.
policyHolderAddress	string	The address for the policy holder.
isPrimary	boolean	Whether this is the primary policy for the Person.