Skip to navigation
API ReferenceCarrier Applications

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.

Authentication

AuthorizationBearer

API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

Path parameters

carrier_application_idstringRequired

Headers

X-Vitable-OrganizationstringOptional

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

This endpoint expects an object.
observed_atdatetimeRequired
When the carrier reported this status.
application_statusenum or nullOptional

The application's status at the carrier.

  • not_started - not_started
  • in_progress - in_progress
  • submitted - submitted
  • submission_failed - submission_failed
  • cancelled - cancelled
Allowed values:
last_failure_codeenum or nullOptional

Why the carrier rejected the application: carrier_submission_rejected or provider_error_unclassified. Only valid when application_status is submission_failed.

  • 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
Allowed values:
coverage_statusenum or nullOptional

The coverage status at the carrier.

  • not_submitted - not_submitted
  • pending_effectuation - pending_effectuation
  • active - active
  • cancelled - cancelled
  • terminated - terminated
Allowed values:
document_statusenum or nullOptional

The supporting-document status at the carrier.

  • unknown - unknown
  • not_required - not_required
  • required - required
  • submitted - submitted
  • under_review - under_review
  • rejected - rejected
  • satisfied - satisfied
binder_statusenum or nullOptional

The binder payment status at the carrier.

  • unknown - unknown
  • not_applicable - not_applicable
  • payment_required - payment_required
  • pending_confirmation - pending_confirmation
  • confirmed - confirmed
Allowed values:
external_application_referencestring or nullOptional1-256 characters
The carrier's reference for the application.

Response headers

X-RateLimit-Limitinteger
Maximum number of requests allowed within the rate limit window
X-RateLimit-Remaininginteger
Number of requests remaining in the current rate limit window
X-RateLimit-Resetinteger

Unix timestamp (seconds) when the rate limit window resets

Response

This endpoint returns an object.
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error