Sign in

v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
Payor Hierarchy

List Payor Links

If the payor is set up as part of a hierarchy you can use this API to traverse the hierarchy

get/v1/payorLinks

Query parameters

descendantsOfPayorstring uuid

The Payor ID from which to start the query to show all descendants

parentOfPayorstring uuid

Query for the parent payor details for this payor id

fieldsstring
<p>List of additional Payor fields to include in the response for each Payor</p> <p>The values of payorId and payorName are always included for each Payor by default</p> <p>You can add fields to the response for each payor by including them in the fields parameter separated by commas</p> <p>The supported fields are any combination of: primaryContactEmail,kycState</p>

Response

Details of Payor Links

Example response

{
  "payors": [
    {
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "kycState": "kycState",
      "primaryContactEmail": "primaryContactEmail",
      "payorName": "payorName"
    },
    {
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "kycState": "kycState",
      "primaryContactEmail": "primaryContactEmail",
      "payorName": "payorName"
    }
  ],
  "links": [
    {
      "toPayorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "linkId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "fromPayorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "linkType": "linkType"
    },
    {
      "toPayorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "linkId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "fromPayorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "linkType": "linkType"
    }
  ]
}