CustomersPolicies
Create customer policy
Create a new policy for a customer
Authorization
x-api-key x-api-key<token>
API key required for authentication.
Keys begin with 'cc_' prefix. Get your API key from the Developer Dashboard.
In: header
Path Parameters
string
Customer ID
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Formatuuid
Request Body
application/json
POST /v2/customers/:id/policies Request body
TypeScript Definitions
Use the request body type in TypeScript.
string
Value in"MA" | "MAPD" | "PDP" | "MS" | "ACA" | "LTC" | "Individual Health" | "FE" | "Annuity" | "Life" | "Dental" | "Vision" | "Hospital Indemnity" | "Cancer" | "Accident" | "Group"
string | null
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Formatuuid
string | null
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Formatuuid
string | null
Lengthlength <= 100
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Name of the carrier
Lengthlength <= 255
string | null
Name of the policy
Lengthlength <= 255
string | null
Plan code of the policy
Lengthlength <= 255
string | null
2 Letter State of the policy
Lengthlength <= 2
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Value in"Catastrophic" | "Bronze" | "Expanded Bronze" | "Silver" | "Gold" | "Platinum"
string | null
The current status of the policy
Default"Active"Value in"Active" | "Pending" | "Pending Effectuation" | "Pending Followup" | "Suspended" | "Cancelled" | "Terminated" | "Future Cancel" | "Deceased" | "Not Approved"
string | null
string | null
string | null
string | null
string | null
string | null
string | null
Value in"IEP" | "AEP" | "OEP" | "SEP" | "ICEP" | "MA-OEP"
string | null
string | null
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Formatuuid
string | null
Agent Of Record First Name
Lengthlength <= 255
string | null
Agent Of Record Last Name
Lengthlength <= 255
string | null
Agent Of Record NPN
Lengthlength <= 50
string | null
Lengthlength <= 50
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
Lengthlength <= 100
string | null
string | null
boolean | null
string | null
string | null
string | null
string | null
string | null
string | null
boolean | null
string | null
Value in"Monthly" | "Quarterly" | "Semi-Annual" | "Annual"
string | null
string | null
string | null
string | null
string | null
integer | null
Number of lives covered by the policy
Range-2147483648 <= value <= 2147483647
boolean | null
string | null
Value in"New Business" | "Like Plan Change" | "Unlike Plan Change" | "Reinstatement" | "Rewrite"
string | null
Lengthlength <= 255
boolean | null
string | null
Lengthlength <= 255
string | null
Lengthlength <= 255
string | null
integer | null
Range-2147483648 <= value <= 2147483647
integer | null
Range-2147483648 <= value <= 2147483647
boolean | null
string | null
integer | null
Range-2147483648 <= value <= 2147483647
string | null
string | null
string | null
Value in"FFM" | "SBM" | "SBM FP" | "OFF EXCHANGE" | "PRIVATE EXCHANGE" | "UNKNOWN"
string | null
Lengthlength <= 100
string | null
boolean | null
string | null
string | null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.carecycle.ai/v2/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/policies" \ -H "Content-Type: application/json" \ -d '{ "carrierName": "Aetna", "planName": "Medicare Elite", "planCode": "H1290-036-001", "planState": "CA", "aorFirstName": "John", "aorLastName": "Doe", "aorNpn": "123456789", "policyLives": 3 }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createdAt": "string",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"updatedAt": "string",
"updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e",
"customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
"policyType": "MA",
"policySubType": "string",
"policyNumber": "string",
"applicationId": "string",
"carrierName": "string",
"planName": "string",
"planCode": "string",
"planState": "st",
"planCounty": "string",
"carrierAssignedPolicyId": "string",
"healthSherpaPolicyId": "string",
"sunFireEnrollmentCode": "string",
"hiosId": "string",
"metalLevel": "Catastrophic",
"status": "Active",
"applicationApprovalDate": "string",
"effectiveDate": "string",
"terminationDate": "string",
"renewalDate": "string",
"enrollmentDate": "string",
"cancelledDate": "string",
"electionPeriod": "IEP",
"gracePeriodStartDate": "string",
"paidThroughDate": "string",
"ffmApplicationId": "string",
"ffmSubscriberId": "string",
"aorAgentId": "b69824d9-b3c3-46ff-b624-5d3573bdf8fa",
"aorFirstName": "string",
"aorLastName": "string",
"aorNpn": "string",
"writingAgentNpn": "string",
"writingAgentName": "string",
"sepType": "string",
"sepCode": "string",
"sepStartDate": "string",
"sepEndDate": "string",
"sepDocumentationReceived": true,
"sepDocumentationDate": "string",
"sepNotes": "string",
"monthlyPremium": "string",
"deductible": "string",
"outOfPocketMax": "string",
"subsidyAmount": "string",
"usingSubsidy": true,
"premiumMode": "Monthly",
"grossPremium": "string",
"netPremium": "string",
"initialCommission": "string",
"renewalCommission": "string",
"spifAmount": "string",
"policyLives": -2147483648,
"wasAgent": true,
"writtenAs": "New Business",
"isReplacing": "string",
"isRewrite": true,
"hospitalNetwork": "string",
"pcpNetwork": "string",
"dailyBenefit": "string",
"eliminationPeriod": -2147483648,
"benefitPeriod": -2147483648,
"hasCola": true,
"deathBenefit": "string",
"term": -2147483648,
"maturityDate": "string",
"riders": "string",
"exchangeStatus": "FFM",
"billingMethod": "string",
"benefitReminder": "string",
"surveyCompleted": true,
"reasonForPurchase": "string",
"policyNotes": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "string"
}{
"message": "string",
"code": "VALIDATION_ERROR",
"errors": [
{
"path": [
"string"
],
"message": "string",
"expected": "string",
"received": "string",
"code": "string"
}
]
}{
"message": "string",
"code": "string",
"retryAfter": 0
}{
"message": "string",
"code": "string"
}