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

# Get entity registration data



## OpenAPI

````yaml /api-reference/openapi.json get /v2/entities/{id}/registration
openapi: 3.1.0
info:
  title: Base39 API
  description: Base39 API
  version: 1.0.0
  contact:
    name: Base39 Team
    url: https://base39.com.br
    email: suporte@base39.com.br
  termsOfService: https://base39.com.br/termos
  license:
    name: Proprietary
    url: https://base39.com.br/termos
servers:
  - url: http://localhost:3000
    description: Local
  - url: https://api.dev.base39.cloud
    description: Development
  - url: https://api.base39.com.br
    description: Production
security:
  - OAuth2: []
tags:
  - name: pages
    description: Profiles and reports pages
  - name: pipelines
    description: Pipeline boards (kanban) of pages
  - name: blocks
    description: Blocks operations
  - name: search
    description: Search across content
  - name: targets
    description: Lookup targets via datasets
  - name: CognitoTriggers
    description: Cognito triggers
paths:
  /v2/entities/{id}/registration:
    get:
      tags:
        - entities
      summary: Get entity registration data
      operationId: entities_get_registration
      parameters:
        - name: id
          required: true
          in: path
          description: CPF, CNPJ, or company id (cmp_*)
          schema:
            type: string
        - name: asOf
          required: false
          in: query
          description: Data de referência (YYYY-MM-DD)
          schema:
            type: string
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated optional response fields. Supports "summary.short",
            "summary.long", and "summary.mdx". Without summary.* the
            metadata.summary field is omitted.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityRegistrationOutput'
components:
  schemas:
    EntityRegistrationOutput:
      type: object
      properties:
        object:
          type: string
          description: Object type identifier
          default: list
        results:
          type: array
          description: Array of results for current page
          items:
            oneOf:
              - $ref: '#/components/schemas/EntityRegistrationCompanyRecordOutput'
              - $ref: '#/components/schemas/EntityRegistrationPersonRecordOutput'
            discriminator:
              propertyName: object
              mapping:
                company:
                  $ref: '#/components/schemas/EntityRegistrationCompanyRecordOutput'
                person:
                  $ref: '#/components/schemas/EntityRegistrationPersonRecordOutput'
        next_cursor:
          type: string
          description: Opaque cursor for next page. null if no more results.
          nullable: true
        has_more:
          type: boolean
          description: Whether more results exist beyond this page
        type:
          type: string
          description: Type of results (Notion-compatible)
        metadata:
          $ref: '#/components/schemas/EntityDomainMetadataOutput'
      required:
        - object
        - results
        - has_more
        - metadata
    EntityRegistrationCompanyRecordOutput:
      type: object
      properties:
        sourceDataset:
          type: string
          example: quod
        observedAt:
          type: string
          example: '2026-05-08T12:30:00.000Z'
        object:
          type: string
          enum:
            - company
          example: company
        companyId:
          type: string
          nullable: true
          example: cmp_abc123
        document:
          type: string
          example: '11222333000181'
          nullable: true
        legalName:
          type: string
          nullable: true
          example: Empresa Teste S.A.
        tradeName:
          type: string
          nullable: true
          example: Empresa Teste
        addressState:
          type: string
          nullable: true
          example: SP
        addressType:
          type: string
          nullable: true
          example: Rua
        addressStreet:
          type: string
          nullable: true
          example: Base39
        addressNumber:
          type: string
          nullable: true
          example: '39'
        addressComplement:
          type: string
          nullable: true
          example: Sala 1201
        addressNeighborhood:
          type: string
          nullable: true
          example: Centro
        addressZipCode:
          type: string
          nullable: true
          example: '01001000'
        addressCity:
          type: string
          nullable: true
          example: São Paulo
        registrationStatus:
          type: string
          nullable: true
          example: '02'
        registrationStatusDate:
          type: string
          nullable: true
          example: '2024-01-15'
        email:
          type: string
          nullable: true
          example: contato@empresa.test
        phones:
          example:
            - '1133334444'
          type: array
          items:
            type: string
        companySize:
          type: string
          nullable: true
          example: DEMAIS
        capital:
          type: number
          nullable: true
          example: 100000
        legalNatureCode:
          type: string
          nullable: true
          example: '2062'
        simplesOption:
          type: boolean
          nullable: true
          example: true
        simplesOptionDate:
          type: string
          nullable: true
          example: '2021-01-01'
        meiOption:
          type: boolean
          nullable: true
          example: false
        meiOptionDate:
          type: string
          nullable: true
          example: null
        mainCnae:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/EntityCnaeOutput'
        secondaryCnaes:
          type: array
          items:
            $ref: '#/components/schemas/EntityCnaeOutput'
        isHeadquarter:
          type: boolean
          nullable: true
          example: true
        activityStartDate:
          type: string
          nullable: true
          example: '2020-05-12'
      required:
        - sourceDataset
        - observedAt
        - object
        - phones
        - secondaryCnaes
    EntityRegistrationPersonRecordOutput:
      type: object
      properties:
        sourceDataset:
          type: string
          example: quod
        observedAt:
          type: string
          example: '2026-05-08T12:30:00.000Z'
        object:
          type: string
          enum:
            - person
          example: person
        name:
          type: string
          nullable: true
          example: JOÃO DA SILVA
        gender:
          type: string
          nullable: true
          example: M
        age:
          type: number
          nullable: true
          example: 29
        birthDate:
          type: string
          nullable: true
          example: '1996-08-05T00:00:00Z'
        birthCountry:
          type: string
          nullable: true
          example: BRASILEIRA
        motherName:
          type: string
          nullable: true
          example: MARIA SILVA
        fatherName:
          type: string
          nullable: true
          example: JOSÉ SILVA
        taxIdNumber:
          type: string
          nullable: true
          example: '15000000000'
        taxIdStatus:
          type: string
          nullable: true
          example: REGULAR
        taxIdStatusDate:
          type: string
          nullable: true
          example: '2016-08-23T00:00:00Z'
        taxIdOrigin:
          type: string
          nullable: true
          example: RECEITA FEDERAL
        taxIdCountry:
          type: string
          nullable: true
          example: BRAZIL
        taxIdFiscalRegion:
          type: string
          nullable: true
          example: ES-RJ
        taxIdStatusRegistrationDate:
          type: string
          nullable: true
          example: '2009-12-14T00:00:00Z'
        hasObitIndication:
          type: boolean
          nullable: true
          example: false
        lastUpdateDate:
          type: string
          nullable: true
          example: '2025-08-20T00:00:00Z'
        creationDate:
          type: string
          nullable: true
          example: '2016-08-23T00:00:00Z'
        aliases:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/EntityRegistrationPersonAliasesOutput'
      required:
        - sourceDataset
        - observedAt
        - object
    EntityDomainMetadataOutput:
      type: object
      properties:
        status:
          type: string
          enum:
            - NOT_QUERIED
            - QUERY_SUCCEEDED
            - QUERY_OUTDATED
            - QUERY_FAILED
            - QUERY_PARTIALLY_SUCCEEDED
        summary:
          description: >-
            Rendered domain summary markdown or MDX when requested via
            ?fields=summary.short, summary.long, and/or summary.mdx. Single
            format → string. Multiple formats → object { short, long, mdx }.
          oneOf:
            - type: string
            - type: object
              properties:
                short:
                  type: string
                long:
                  type: string
                mdx:
                  type: string
        provenance:
          $ref: '#/components/schemas/EntityDomainProvenanceOutput'
      required:
        - status
        - provenance
    EntityCnaeOutput:
      type: object
      properties:
        code:
          type: string
          example: '6201501'
        description:
          type: string
          nullable: true
          example: Desenvolvimento de programas de computador sob encomenda
      required:
        - code
    EntityRegistrationPersonAliasesOutput:
      type: object
      properties:
        commonName:
          type: string
          nullable: true
          example: JOÃO SILVA
        standardizedName:
          type: string
          nullable: true
          example: JOÃO DA SILVA
    EntityDomainProvenanceOutput:
      type: object
      properties:
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/EntityDatasetProvenanceOutput'
      required:
        - datasets
    EntityDatasetProvenanceOutput:
      type: object
      properties:
        queryId:
          type: string
          nullable: true
        datasetSlug:
          type: string
        requirement:
          type: string
          enum:
            - required
            - optional
        visible:
          type: boolean
        onRefresh:
          type: boolean
        sourcePriority:
          type: number
        observedAt:
          type: string
          nullable: true
        recordedAt:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - NOT_QUERIED
            - QUERY_SUCCEEDED
            - QUERY_OUTDATED
            - QUERY_FAILED
            - QUERY_PARTIALLY_SUCCEEDED
        errorCode:
          type: string
          enum:
            - upstream_error
            - upstream_unauthorized
            - upstream_not_found
            - upstream_rate_limit
            - upstream_invalid_request
            - upstream_unavailable
            - upstream_timeout
            - upstream_invalid_response
            - mock_response_missing
            - provider_execution_failed
            - query_persistence_failed
            - workflow_failed
          nullable: true
      required:
        - datasetSlug
        - requirement
        - visible
        - onRefresh
        - sourcePriority
        - status
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://id.local.base39.cloud/oauth2/authorize
          tokenUrl: https://id.local.base39.cloud/oauth2/token
          scopes:
            profile: Read user profile
            email: Read user email
            openid: OpenID authentication
      description: OAuth2 Authorization Code flow

````