Get payer

GET

/api/payers/v4/:payer_uuid

GET

/api/payers/v4/:payer_uuid

1 curl https://api.joincandidhealth.com/api/payers/v4/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "payer_ids": {
4     "claims_payer_id": "claims_payer_id",
5     "eligibility_payer_id": "eligibility_payer_id",
6     "remittance_payer_id": "remittance_payer_id",
7     "claims_support": "NOT_SUPPORTED",
8     "eligibility_support": "NOT_SUPPORTED",
9     "remittance_support": "NOT_SUPPORTED"
10   },
11   "payer_name": "payer_name",
12   "clearinghouse_payer_info": {
13     "CHANGE_HEALTHCARE": {
14       "payer_name": "payer_name",
15       "professional_payer_ids": {
16         "claims_payer_id": "claims_payer_id",
17         "eligibility_payer_id": "eligibility_payer_id",
18         "remittance_payer_id": "remittance_payer_id",
19         "claims_support": "NOT_SUPPORTED",
20         "eligibility_support": "NOT_SUPPORTED",
21         "remittance_support": "NOT_SUPPORTED"
22       },
23       "institutional_payer_ids": {
24         "claims_payer_id": "claims_payer_id",
25         "eligibility_payer_id": "eligibility_payer_id",
26         "remittance_payer_id": "remittance_payer_id",
27         "claims_support": "NOT_SUPPORTED",
28         "eligibility_support": "NOT_SUPPORTED",
29         "remittance_support": "NOT_SUPPORTED"
30       }
31     }
32   },
33   "street_address": {
34     "address1": "address1",
35     "city": "city",
36     "state": "AA",
37     "zip_code": "zip_code",
38     "zip_plus_four_code": "zip_plus_four_code",
39     "address2": "address2"
40   }
41 }

Path parameters

payer_uuidUUIDRequired

Response

This endpoint returns an object.

payer_uuidUUID

Auto-generated ID set on creation.

payer_idsobject

The primary national payer IDs of the payer.

payer_namestring

The primary display name of the payer.

clearinghouse_payer_infomap from enums to objects

street_addressobject or null

Path parameters

Headers

Response