Create a new policy under the authenticated organization

POST /api/v1/policy

Creates a new policy with details such as owner and pet information, effective dates, and coverage slug. Requires authentication and several required fields.

application/json

Body Required

internalID string

Internal identifier for the policy
number integer

Unique policy number identifier
cvc string

CVC of the policy
ownerFirstname string

First name of the policy owner
ownerLastname string

Last name of the policy owner
ownerDOB string(date)

Date of birth of the policy owner
petName string

Name of the pet covered by the policy
petDOB string(date)

Date of birth of the pet covered by the policy
effectiveDate string(date)

Policy's effective start date
expirationDate string(date)

Policy's expiration date
coverageSlug string

Coverage slug associated with the policy

Responses

200 application/json

Policy successfully created with details including coverage and charges.
Hide response attributes Show response attributes object
- internalID string
  
  Internal ID of the created policy
- number integer
  
  Unique policy number
- ownerFirstname string
  
  First name of the policy owner
- ownerLastname string
  
  Last name of the policy owner
- petName string
  
  Name of the pet covered by the policy
- coverage object
  
  Coverage details associated with the policy
  
  Additional properties are allowed.
- charges array
  
  Charges associated with the policy
400

Invalid request. Required fields are missing.
401

Not authenticated. The user must be logged in to access this endpoint.

POST /api/v1/policy

curl \
 -X POST https://ark.collegecanine.com/api/v1/policy \
 -H "Content-Type: application/json" \
 -d '{"internalID":"string","number":42,"cvc":"string","ownerFirstname":"string","ownerLastname":"string","ownerDOB":"2024-05-04","petName":"string","petDOB":"2024-05-04","effectiveDate":"2024-05-04","expirationDate":"2024-05-04","coverageSlug":"string"}'

Request examples

{
  "internalID": "string",
  "number": 42,
  "cvc": "string",
  "ownerFirstname": "string",
  "ownerLastname": "string",
  "ownerDOB": "2024-05-04",
  "petName": "string",
  "petDOB": "2024-05-04",
  "effectiveDate": "2024-05-04",
  "expirationDate": "2024-05-04",
  "coverageSlug": "string"
}

Response examples (200)

{
  "internalID": "string",
  "number": 42,
  "ownerFirstname": "string",
  "ownerLastname": "string",
  "petName": "string",
  "coverage": {},
  "charges": []
}