ContractsV2

Get contract

Beta
GET

Path parameters

contract_idUUIDRequired

Response

This endpoint returns an object
commercial_insurance_types
union
The commercial plan insurance types this contract applies.
contract_id
UUID
contracting_provider
object
The provider under contract
effective_date
string
The starting day upon which the contract is effective
medicaid_insurance_types
union
The Medicaid plan insurance types this contract applies.
medicare_insurance_types
union
The Medicare plan insurance types this contract applies.
payer
object
The insurance company under contract
provider_count
integer
The number of linked providers who can render medical services under this contract
regions
union
The state(s) to which the contract's coverage extends. It may also be set to "national" for the entirety of the US.
rendering_provider_ids
set of UUIDs
The providers who can render medical services under the contract
authorized_signatory
objectOptional
contract_status
enumOptional
Allowed values: pendingeffectivecancelled
expiration_date
stringOptional
An optional end day upon which the contract expires

Errors

GET
1curl https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2 -H "Authorization: Bearer <token>"
1{
2 "commercial_insurance_types": {
3 "type": "allApply"
4 },
5 "contract_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6 "contracting_provider": {
7 "employment_status": "ACTIVE",
8 "is_billing": true,
9 "is_rendering": true,
10 "license_type": "MD",
11 "npi": "string",
12 "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
13 "provider_type": "INDIVIDUAL",
14 "addresses": [
15 {
16 "address": {
17 "address1": "string",
18 "city": "string",
19 "state": "AA",
20 "zip_code": "string",
21 "zip_plus_four_code": "string",
22 "address2": "string"
23 },
24 "address_type": "DEFAULT"
25 }
26 ],
27 "employment_start_date": "string",
28 "employment_termination_date": "string",
29 "first_name": "string",
30 "last_name": "string",
31 "medicaid_provider_id": "string",
32 "organization_name": "string",
33 "ptan": "string",
34 "tax_id": "string",
35 "taxonomy_code": "string"
36 },
37 "effective_date": "string",
38 "medicaid_insurance_types": {
39 "type": "allApply"
40 },
41 "medicare_insurance_types": {
42 "type": "allApply"
43 },
44 "payer": {
45 "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
46 "payer_id": "string",
47 "payer_name": "string"
48 },
49 "provider_count": 0,
50 "regions": {
51 "type": "states",
52 "states": [
53 "AA"
54 ]
55 },
56 "rendering_provider_ids": [
57 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
58 ],
59 "authorized_signatory": {
60 "first_name": "string",
61 "last_name": "string",
62 "title": "string",
63 "email": "string",
64 "phone": "string",
65 "fax": "string"
66 },
67 "contract_status": "pending",
68 "expiration_date": "string"
69}