> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server.

# Get payer

GET https://api.joincandidhealth.com/api/payers/v4/{payer_uuid}

Reference: https://docs.joincandidhealth.com/api-reference/payers/v-4/get

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://api.joincandidhealth.com` (Production, default)
- `https://api-staging.joincandidhealth.com` (Staging)
- `https://sandbox-api.joincandidhealth.com` (CandidSandbox)
- `https://staging-api.joincandidhealth.com` (CandidStaging)
- `http://localhost:5050` (Local)

## Request

### Path parameters

- `payer_uuid` (UUID, required)

## Response

### 200

- `payer_uuid` (UUID, required) — Auto-generated ID set on creation.
- `payer_ids` (PrimaryPayerIds, required) — The primary national payer IDs of the payer.
- `payer_name` (string, required) — The primary display name of the payer.
- `alternate_payer_names` (list of string, required) — The alternate display names of the payer.
- `clearinghouse_payer_info` (map from enum to ClearinghousePayerInfo, required)
- `alternate_payer_addresses` (list of StreetAddressLongZip, required)
- `payer_category` (enum, optional) — The category of the payer.
  - Allowed values: `BCBS`, `AETNA_AFFILIATED`, `CIGNA_AFFILIATED`, `UNITED_AFFILIATED`, `MEDICARE`, `NON_TRADITIONAL_MEDICARE`, `MEDICAID`, `HOSPICE`, `SNF`, `TRICARE`, `WORKERS_COMP`, `OTHER_GOVERNMENT`, `AUTO_TPL`, `LIEN`, `HUMANA`, `MOLINA`, `OTHER_FACILITY`
- `street_address` (StreetAddressLongZip, optional)

## Types

### PrimaryPayerIds

- `claims_payer_id` (string, required) — The payer ID for claim submission
- `eligibility_payer_id` (string, optional) — The payer ID for eligibility
- `remittance_payer_id` (string, optional) — The payer ID for remittance

### ClearinghousePayerInfo

- `payer_name` (string, required) — The clearinghouse display name of the payer.
- `professional_payer_ids` (PayerIds, required) — Payer IDs for professional claims
- `institutional_payer_ids` (PayerIds, required) — Payer IDs for institutional claims
- `professional_claims_support` (enum, required) — The support state for claims submission
  - Allowed values: `NOT_SUPPORTED`, `SUPPORTED_ENROLLMENT_NOT_REQUIRED`, `SUPPORTED_ENROLLMENT_REQUIRED`
- `institutional_claims_support` (enum, required) — The support state for institutional claims submission
  - Allowed values: `NOT_SUPPORTED`, `SUPPORTED_ENROLLMENT_NOT_REQUIRED`, `SUPPORTED_ENROLLMENT_REQUIRED`
- `eligibility_support` (enum, required) — The support state for eligibility
  - Allowed values: `NOT_SUPPORTED`, `SUPPORTED_ENROLLMENT_NOT_REQUIRED`, `SUPPORTED_ENROLLMENT_REQUIRED`
- `remittance_support` (enum, required) — The support state for remittance
  - Allowed values: `NOT_SUPPORTED`, `SUPPORTED_ENROLLMENT_NOT_REQUIRED`, `SUPPORTED_ENROLLMENT_REQUIRED`
- `claim_attachment_support` (enum, required) — The support state for claim attachment submission
  - Allowed values: `NOT_SUPPORTED`, `SUPPORTED_ENROLLMENT_NOT_REQUIRED`, `SUPPORTED_ENROLLMENT_REQUIRED`

### StreetAddressLongZip

- `address1` (string, required)
- `city` (string, required)
- `state` (enum, required)
  - Allowed values: `AA`, `AE`, `AP`, `AL`, `AK`, `AS`, `AZ`, `AR`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `ID`, `IL`, `IN`, `IA`, `KS`, `KY`, `LA`, `ME`, `MD`, `MA`, `MH`, `MI`, `MN`, `MP`, `MS`, `MO`, `MT`, `NE`, `NV`, `NH`, `NJ`, `NM`, `NY`, `NC`, `ND`, `OH`, `OK`, `OR`, `PA`, `PR`, `PW`, `RI`, `SC`, `SD`, `TN`, `TX`, `UT`, `VI`, `VT`, `VA`, `WA`, `WV`, `WI`, `WY`, `FC`
- `zip_code` (string, required) — 5-digit zip code
- `zip_plus_four_code` (string, required) — 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4
- `address2` (string, optional)

### PayerIds

- `claims_payer_id` (string, optional) — The payer ID for claim submission
- `eligibility_payer_id` (string, optional) — The payer ID for eligibility
- `remittance_payer_id` (string, optional) — The payer ID for remittance

## Examples

**Response**

```json
{
  "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "payer_ids": {
    "claims_payer_id": "claims_payer_id",
    "eligibility_payer_id": "eligibility_payer_id",
    "remittance_payer_id": "remittance_payer_id"
  },
  "payer_name": "payer_name",
  "alternate_payer_names": [
    "alternate_payer_names",
    "alternate_payer_names"
  ],
  "clearinghouse_payer_info": {
    "CHANGE_HEALTHCARE": {
      "payer_name": "payer_name",
      "professional_payer_ids": {
        "claims_payer_id": "claims_payer_id",
        "eligibility_payer_id": "eligibility_payer_id",
        "remittance_payer_id": "remittance_payer_id"
      },
      "institutional_payer_ids": {
        "claims_payer_id": "claims_payer_id",
        "eligibility_payer_id": "eligibility_payer_id",
        "remittance_payer_id": "remittance_payer_id"
      },
      "professional_claims_support": "NOT_SUPPORTED",
      "institutional_claims_support": "NOT_SUPPORTED",
      "eligibility_support": "NOT_SUPPORTED",
      "remittance_support": "NOT_SUPPORTED",
      "claim_attachment_support": "NOT_SUPPORTED"
    }
  },
  "alternate_payer_addresses": [
    {
      "address1": "address1",
      "city": "city",
      "state": "AA",
      "zip_code": "zip_code",
      "zip_plus_four_code": "zip_plus_four_code",
      "address2": "address2"
    },
    {
      "address1": "address1",
      "city": "city",
      "state": "AA",
      "zip_code": "zip_code",
      "zip_plus_four_code": "zip_plus_four_code",
      "address2": "address2"
    }
  ],
  "payer_category": "BCBS",
  "street_address": {
    "address1": "address1",
    "city": "city",
    "state": "AA",
    "zip_code": "zip_code",
    "zip_plus_four_code": "zip_plus_four_code",
    "address2": "address2"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.joincandidhealth.com/api/payers/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"

headers = {"Authorization": "<token>."}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.joincandidhealth.com/api/payers/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32';
const options = {method: 'GET', headers: {Authorization: '<token>.'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.joincandidhealth.com/api/payers/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<token>.")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.joincandidhealth.com/api/payers/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<token>.'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.joincandidhealth.com/api/payers/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
  .header("Authorization", "<token>.")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.joincandidhealth.com/api/payers/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', [
  'headers' => [
    'Authorization' => '<token>.',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.joincandidhealth.com/api/payers/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<token>.");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<token>."]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.joincandidhealth.com/api/payers/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```