---
title: "EntitiesV1"
url: "https://developer.agentsync.io/apis/producer-sync-api/versions/953bc6f0-354b-4960-adc0-3acdb3d638a2/schemas/EntitiesV1"
---

> Full API specification: https://developer.agentsync.io/apis/producer-sync-api/versions/953bc6f0-354b-4960-adc0-3acdb3d638a2.md

# EntitiesV1

## OpenAPI definition

```yaml
openapi: 3.1.1
info:
  title: ProducerSync API
  version: v2.80.2
servers:
  - url: https://api.sandbox.agentsync.io
    description: Sandbox
components:
  schemas:
    EntitiesBaseResponse:
      type: object
      description: Common entity fields shared across versions.
      properties:
        id:
          type: integer
          format: int64
          example: 1234567
          description: Unique identifier for the entity.
        npn:
          type: string
          example: "18551108"
          description: National Producer Number associated with the entity.
        transactionId:
          type: string
          format: uuid
          example: ae51f10b-8b5e-40ba-98a9-8f860392b344
        type:
          type: string
          enum:
            - INDIVIDUAL
            - FIRM
          example: INDIVIDUAL
          description: Type of entity - individual or firm.
        feinId:
          type:
            - string
            - "null"
          example: "123456789"
          description: Federal Employer Identification Number. Expected to be NULL for
            individuals.
        companyName:
          type:
            - string
            - "null"
          example: Acme Insurance Group
          description: Name of the firm. Expected to be NULL for individuals.
        firstName:
          type: string
          example: Jeff
        middleName:
          type: string
          example: Lee
        lastName:
          type: string
          example: Android
        dateOfBirth:
          type:
            - string
            - "null"
          format: date
          example: 1983-12-15
          description: Date of birth for the producer. Expected to be NULL for a firm.
        createdAt:
          type: string
          format: date
          example: 2021-04-04
          description: Date of the creation of this record in AgentSync.
        updatedAt:
          type: string
          format: date
          example: 2024-12-02
          description: Date of the most recent update to this record in AgentSync.
        noLicenses:
          type: boolean
          example: false
        subscriptionCount:
          type: integer
          example: 4
        niprDeleted:
          type: boolean
          example: false
          description: Indicates if the entity was marked deleted by NIPR.
    EntitiesV1Metadata:
      type: object
      properties:
        no_licenses:
          type: boolean
          example: false
        last_nipr_entity_update:
          type: string
          format: date-time
          example: 2024-11-20T12:42:43.519662+00:00
    EntitiesLinks:
      type: object
      properties:
        self:
          type: object
          properties:
            href:
              type: string
              format: uri
              example: https://api.sandbox.agentsync.io/v1/entities/1000013
        addresses:
          type: object
          properties:
            href:
              type: string
              format: uri
              example: https://api.sandbox.agentsync.io/v1/entities/1000013/addresses
        contactInfos:
          type: object
          properties:
            href:
              type: string
              format: uri
              example: https://api.sandbox.agentsync.io/v1/entities/1000013/contactInfos
        appointments:
          type: object
          properties:
            href:
              type: string
              format: uri
              example: https://api.sandbox.agentsync.io/v1/entities/1000013/appointments
        licenses:
          type: object
          properties:
            href:
              type: string
              format: uri
              example: https://api.sandbox.agentsync.io/v1/entities/1000013/licenses
        residentLicense:
          type: object
          properties:
            href:
              type: string
              format: uri
              example: https://api.sandbox.agentsync.io/v2/entities/1000013/residentLicense
    EntitiesV1:
      allOf:
        - $ref: "#/components/schemas/EntitiesBaseResponse"
        - type: object
          properties:
            metadata:
              $ref: "#/components/schemas/EntitiesV1Metadata"
            links:
              $ref: "#/components/schemas/EntitiesLinks"
```
