Get payer | Candid | API Reference

1 import { CandidApiClient, CandidApi } from "candidhealth"; 2 3 const client = new CandidApiClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" }); 4 await client.payers.v4.get(CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));

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 }, 8 "payer_name": "payer_name", 9 "alternate_payer_names": [ 10 "alternate_payer_names", 11 "alternate_payer_names" 12 ], 13 "clearinghouse_payer_info": { 14 "CHANGE_HEALTHCARE": { 15 "payer_name": "payer_name", 16 "professional_payer_ids": { 17 "claims_payer_id": "claims_payer_id", 18 "eligibility_payer_id": "eligibility_payer_id", 19 "remittance_payer_id": "remittance_payer_id" 20 }, 21 "institutional_payer_ids": { 22 "claims_payer_id": "claims_payer_id", 23 "eligibility_payer_id": "eligibility_payer_id", 24 "remittance_payer_id": "remittance_payer_id" 25 }, 26 "professional_claims_support": "NOT_SUPPORTED", 27 "institutional_claims_support": "NOT_SUPPORTED", 28 "eligibility_support": "NOT_SUPPORTED", 29 "remittance_support": "NOT_SUPPORTED" 30 } 31 }, 32 "street_address": { 33 "address1": "address1", 34 "city": "city", 35 "state": "AA", 36 "zip_code": "zip_code", 37 "zip_plus_four_code": "zip_plus_four_code", 38 "address2": "address2" 39 } 40 }

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

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.

alternate_payer_nameslist of strings

The alternate display names of the payer.

clearinghouse_payer_infomap from enums to objects

street_addressobject or null