NowCerts Endorsements API

openapi: 3.2.0
info:
  title: NowCerts Endorsements API
  description: The NowCerts API is the REST interface to the NowCerts insurance agency management system (now branded Momentum AMP; the API is still served from api.nowcerts.com).
  version: 2.1.5
  contact:
    name: NowCerts / Momentum AMP
    url: https://www.nowcerts.com
  x-modeled: Endpoint paths and methods are confirmed real from api.nowcerts.com/Help. Schemas are modeled from documented behavior and typical AMS fields, not copied from an official machine-readable spec (NowCerts does not publish OpenAPI).
servers:
- url: https://api.nowcerts.com/api
  description: NowCerts production API
security:
- bearerAuth: []
tags:
- name: Endorsements
  description: Policy endorsements and their financial detail.
paths:
  /Policy/InsertWithEndorementId:
    post:
      operationId: insertPolicyWithEndorsementId
      tags:
      - Endorsements
      summary: Insert a policy tied to an endorsement id
      description: Create or update a policy referencing an existing endorsement id. Schema modeled.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Policy'
              - type: object
                properties:
                  endorsementId:
                    type: string
                    format: uuid
      responses:
        '200':
          description: The created or updated policy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Policy'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /PolicyEndorsementDetailList:
    get:
      operationId: listPolicyEndorsementDetail
      tags:
      - Endorsements
      summary: List policy endorsements
      description: Returns endorsement records for the agency's policies, with OData-style query options.
      parameters:
      - $ref: '#/components/parameters/ODataFilter'
      - $ref: '#/components/parameters/ODataTop'
      - $ref: '#/components/parameters/ODataSkip'
      - $ref: '#/components/parameters/ODataOrderBy'
      responses:
        '200':
          description: A list of endorsements.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Endorsement'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /PolicyEndorsementAgencyCommissionDetailList:
    get:
      operationId: listEndorsementAgencyCommissionDetail
      tags:
      - Endorsements
      summary: List endorsement agency commissions
      description: Returns agency commission detail for policy endorsements.
      responses:
        '200':
          description: A list of endorsement agency commissions.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Policy:
      type: object
      description: An insurance policy. Modeled from documented policy fields.
      properties:
        databaseId:
          type: string
          format: uuid
        insuredDatabaseId:
          type: string
          format: uuid
        number:
          type: string
        carrierName:
          type: string
        lineOfBusiness:
          type: string
        effectiveDate:
          type: string
          format: date
        expirationDate:
          type: string
          format: date
        premium:
          type: number
        statusType:
          type: string
      additionalProperties: true
    Error:
      type: object
      properties:
        message:
          type: string
        error:
          type: string
      additionalProperties: true
    Endorsement:
      type: object
      description: A policy endorsement record. Modeled.
      properties:
        databaseId:
          type: string
          format: uuid
        policyDatabaseId:
          type: string
          format: uuid
        endorsementNumber:
          type: string
        effectiveDate:
          type: string
          format: date
        premiumChange:
          type: number
      additionalProperties: true
  parameters:
    ODataFilter:
      name: $filter
      in: query
      description: OData-style filter expression.
      schema:
        type: string
    ODataOrderBy:
      name: $orderby
      in: query
      description: OData-style ordering expression.
      schema:
        type: string
    ODataTop:
      name: $top
      in: query
      description: Maximum number of records to return.
      schema:
        type: integer
    ODataSkip:
      name: $skip
      in: query
      description: Number of records to skip.
      schema:
        type: integer
  responses:
    Unauthorized:
      description: Missing or invalid bearer token, or the user lacks the API Integration role.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from https://api.nowcerts.com/token via the OAuth2 password grant. The user must have the "API Integration" agent role.