> ## Documentation Index
> Fetch the complete documentation index at: https://docs.baselayer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List every reason code

> Return the full catalog of reason codes, deprecated ones included.



## OpenAPI

````yaml /api-reference/openapi.json get /reason_codes
openapi: 3.1.0
info:
  title: baselayer-api-service
  version: 0.1.0
servers:
  - url: https://api.baselayer.com/
security: []
paths:
  /reason_codes:
    get:
      tags:
        - Reason Codes
      summary: List every reason code
      description: Return the full catalog of reason codes, deprecated ones included.
      operationId: list_reason_codes_reason_codes_get
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/v1.ReasonCodeResponse'
                type: array
            application/vnd.baselayer.v1+json:
              schema:
                items:
                  $ref: '#/components/schemas/v1.ReasonCodeResponse'
                type: array
      security:
        - APIKeyHeader: []
components:
  schemas:
    v1.ReasonCodeResponse:
      properties:
        code:
          $ref: '#/components/schemas/v1.ReasonCode'
          description: >-
            The reason code. This is a stable identifier that can be used to
            uniquely identify a condition.
          examples:
            - SEARCH_ADDRESS_CMRA
        category:
          $ref: '#/components/schemas/v1.ReasonCodeCategory'
          description: The domain the code belongs to.
          examples:
            - address
        recommended_severity:
          $ref: '#/components/schemas/v1.ReasonCodeSeverity'
          description: Baselayer's recommended response tier
          examples:
            - high
        description:
          description: What the condition means, in a sentence or two.
          examples:
            - >-
              Submitted address is a known commercial mail receiving agency, a
              private mailbox service that can mask where a business actually
              operates.
          title: Description
          type: string
        deprecated:
          description: >-
            Whether the code is deprecated: no longer issued, though it still
            appears on results that recorded it.
          examples:
            - false
          title: Deprecated
          type: boolean
        deprecated_at:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          description: >-
            The UTC day the code is or will be deprecated, or null if none is
            scheduled.
          title: Deprecated At
        successor_code:
          anyOf:
            - $ref: '#/components/schemas/v1.ReasonCode'
            - type: 'null'
          description: >-
            The code that replaces this one, if it is deprecated and has a
            replacement.
      required:
        - code
        - category
        - recommended_severity
        - description
        - deprecated
        - deprecated_at
        - successor_code
      title: ReasonCodeResponse (v1)
      type: object
    v1.ReasonCode:
      description: >-
        Every reason code Baselayer has ever issued.


        Members are named exactly as their value so the code a customer sees is
        the

        code a developer greps for. A member is never removed: rows that
        recorded it

        still name it.
      enum:
        - ADDRESS_FAILED_TO_NORMALIZE
        - ENTITY_NOT_FOUND
        - BUSINESS_NAME_NO_MATCH
        - NO_ACTIVE_REGISTRATIONS
        - DOMESTIC_REGISTRATION_INACTIVE
        - SOLE_REGISTRATION_STATUS_UNKNOWN
        - ENTITY_AGE_UNDER_7D
        - ENTITY_AGE_UNDER_30D
        - ENTITY_AGE_UNDER_90D
        - ENTITY_AGE_UNDER_6M
        - ENTITY_AGE_UNDER_12M
        - TIN_MISMATCH
        - TIN_IS_SSN
        - ADDRESS_NO_MATCH
        - ADDRESS_PARTIAL_MATCH
        - SEARCH_ADDRESS_UNDELIVERABLE
        - SEARCH_ADDRESS_PO_BOX
        - SEARCH_ADDRESS_CMRA
        - SEARCH_ADDRESS_RESIDENTIAL
        - PRIMARY_ADDRESS_UNDELIVERABLE
        - PRIMARY_ADDRESS_PO_BOX
        - PRIMARY_ADDRESS_CMRA
        - PRIMARY_ADDRESS_RESIDENTIAL
        - NO_OFFICER_MATCH
        - SUBMITTED_DOMAIN_UNDER_7D
        - DISCOVERED_DOMAIN_UNDER_7D
        - TAX_LIEN_ACTIVE
        - TAX_LIEN_PAST
        - UCC_LIEN_ACTIVE
        - BANKRUPTCY_ACTIVE
        - BANKRUPTCY_RECENT
        - LITIGATION_ACTIVE
        - LITIGATION_RECENT
        - NETWORK_HIGH_VELOCITY
        - NETWORK_HIGH_APPLICATION_COUNT
        - ADDRESS_MISMATCH
        - NETWORK_NO_HISTORY
      title: ReasonCode
      type: string
    v1.ReasonCodeCategory:
      description: The business domain a reason code belongs to — display and grouping.
      enum:
        - identity
        - address
        - officers
        - web_presence
        - industry
        - credit
        - network
        - adverse
        - reviews
      title: ReasonCodeCategory
      type: string
    v1.ReasonCodeSeverity:
      description: Baselayer's recommended response tier. Guidance, not contract.
      enum:
        - high
        - medium
        - low
      title: ReasonCodeSeverity
      type: string
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.