carrierApplications

Record a carrier application status update

Records the latest status the carrier reported for an application completed directly with the carrier, and returns the updated application. Include only the statuses that changed; sending the same statuses with a later observed_at confirms they are still current. Returns 409 when the application doesn't accept status updates, the update conflicts with its current status, or a more recent observed_at has already been recorded, and 404 when the application doesn't exist or isn't accessible.

post/v1/carrier-applications/{carrier_application_id}/status-updates

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/carrier-applications/{carrier_application_id}/status-updates
  • Auth: HTTP bearer

Path parameters

carrier_application_idstring required

Headers

X-Vitable-Organizationstring

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Request body

application_status'not_started' | 'in_progress' | 'submitted' | 'submission_failed' | 'cancelled'
  • not_started - Not Started
  • in_progress - In Progress
  • submitted - Submitted
  • submission_failed - Submission Failed
  • cancelled - Cancelled
last_failure_code'application_validation_failed' | 'supporting_document_rejected' | 'payment_method_failed' | 'carrier_submission_rejected' | 'provider_error_unclassified'
  • application_validation_failed - application_validation_failed
  • supporting_document_rejected - supporting_document_rejected
  • payment_method_failed - payment_method_failed
  • carrier_submission_rejected - carrier_submission_rejected
  • provider_error_unclassified - provider_error_unclassified
coverage_status'not_submitted' | 'pending_effectuation' | 'active' | 'cancelled' | 'terminated'
  • not_submitted - Not Submitted
  • pending_effectuation - Pending Effectuation
  • active - Active
  • cancelled - Cancelled
  • terminated - Terminated
document_status'unknown' | 'not_required' | 'required' | 'submitted' | 'under_review' | 'rejected' | 'satisfied'
  • unknown - Unknown
  • not_required - Not Required
  • required - Required
  • submitted - Submitted
  • under_review - Under Review
  • rejected - Rejected
  • satisfied - Satisfied
binder_status'unknown' | 'not_applicable' | 'payment_required' | 'pending_confirmation' | 'confirmed'
  • unknown - Unknown
  • not_applicable - Not Applicable
  • payment_required - Payment Required
  • pending_confirmation - Pending Confirmation
  • confirmed - Confirmed
external_application_referencestring nullable

The carrier's reference for the application.

observed_atstring date-time required

When the carrier reported this status.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.