Getting Started

Our self-service APIs allow you to build an experience for end users to sign up for services from your website and update any existing services. All of our self-service APIs operate contracts and will create amendment quotes in the background to track the change just like any other amendment. Even though there are quotes created in the background, self-service flows will skip any rules evaluations.

Errors

Errors for the APIs on this page will come in form of:

type Error = {
  errorCode: string;
  details: string;
  context?: Record<string, unknown>;
}

type ApiErrorResponse = {
  operation: string;
  error: Error;
}