Create

Beta

POST

/api/non-insurance-payers/v1

POST

/api/non-insurance-payers/v1

$ curl -X POST https://api.joincandidhealth.com/api/non-insurance-payers/v1 \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "name"
> }'

1 {
2   "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "name": "name",
4   "enabled": true,
5   "clinical_trials": [
6     {
7       "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
8       "clinical_trial_number": "clinical_trial_number",
9       "is_active": true,
10       "name": "name",
11       "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12       "clinical_trial_phase": "Phase 1"
13     },
14     {
15       "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16       "clinical_trial_number": "clinical_trial_number",
17       "is_active": true,
18       "name": "name",
19       "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
20       "clinical_trial_phase": "Phase 1"
21     }
22   ],
23   "description": "description",
24   "category": "category",
25   "payer_id": "payer_id",
26   "address": {
27     "address1": "address1",
28     "city": "city",
29     "state": "AA",
30     "zip_code": "zip_code",
31     "address2": "address2",
32     "zip_plus_four_code": "zip_plus_four_code"
33   }
34 }

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.

namestringRequired

Max 50 characters allowed

descriptionstringOptional

Max 255 characters allowed

categorystringOptional

Max 255 characters allowed

payer_idstringOptional

The identifier used to route claims to this payer. Required in order to submit an 837 to this payer. Must be between 2 and 80 characters.

addressobjectOptional

clinical_trialslist of objectsOptional

The same name cannot be used across several clinical trials

Response

This endpoint returns an object.

non_insurance_payer_idUUID

namestring

enabledboolean

clinical_trialslist of objects

descriptionstringOptional

categorystringOptional

payer_idstringOptional

The identifier used to route claims to this payer. Required in order to submit an 837 to this payer. Must be between 2 and 80 characters.

addressobjectOptional

Errors

404

Entity Not Found Error

409

Entity Conflict Error