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

# Obter uma entidade

Retorna a entidade completa: dados de KYC, documentos declarados com suas provas ativas, status derivados e, para uma COMPANY, o resumo de UBO.

* O exemplo é uma COMPANY com dois proprietários vinculados: uboCount: 2, uboRequirementMet: true.
* Entidades CLOSED continuam legíveis por id.
* Um entityId que não seja UUID retorna 400.

Erros usam `application/problem+json` com um `code` estável. Catálogo completo: [Status de Entidades e Códigos de Erro](https://docs.localpayment.com/pt-br/reference/entity-statuses-and-error-codes.md).


## OpenAPI

````yaml openapi/pt-br/localpayment.json GET /api/entity/v1/entities/{entityId}
openapi: 3.1.0
info:
  version: '1.0'
  title: Localpayment
  contact:
    name: Support
    url: mailto:support@localpayment.com
servers:
  - url: https://api.stage.localpayment.com
    description: Stage
security:
  - token: []
paths:
  /api/entity/v1/entities/{entityId}:
    get:
      summary: Obter uma entidade
      operationId: get-entity
      parameters:
        - name: Authorization
          in: header
          description: >-
            Token de acesso Bearer para autenticação. Este token é obtido nos
            endpoints [Obter token de acesso](/pt-br/reference/get-token) ou
            [Renovar token de acesso](/pt-br/reference/refresh-token). Sua conta
            de comerciante e o usuário que realiza a ação são identificados a
            partir dele.
          required: true
          schema:
            type: string
            examples:
              - Bearer <your_access_token>
        - name: X-Correlation-ID
          in: header
          description: >-
            Identificador de rastreamento (UUID). Exibido na resposta; gerado
            pelo Localpayment se ausente.
          required: false
          schema:
            type: string
            examples:
              - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
        - name: entityId
          in: path
          description: ID interno da entidade.
          required: true
          schema:
            type: string
            examples:
              - 5aced5da-40c1-4bec-85ff-c8cd1bcb4526
            format: uuid
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                type: object
                properties:
                  internalId:
                    type: string
                    examples:
                      - 7c9e6679-7425-40de-944b-e07fc1f90ae7
                    format: uuid
                    description: >-
                      Identificador da entidade na Localpayment. Use-o em todos
                      os outros endpoints de Entities.
                  externalId:
                    type: string
                    examples:
                      - f47ac10b-58cc-4372-a567-0e02b2c3d479
                    description: Seu identificador, conforme enviado.
                  type:
                    type: string
                    examples:
                      - COMPANY
                    enum:
                      - INDIVIDUAL
                      - COMPANY
                    description: PESSOA FÍSICA ou EMPRESA.
                  status:
                    type: string
                    examples:
                      - PENDING_KYC
                    enum:
                      - PENDING_KYC
                      - IN_REVIEW
                      - ACTIVE
                      - REJECTED
                      - BLOCKED
                      - CLOSED
                    description: >-
                      Status da entidade. Consulte Status da entidade e Códigos
                      de erro.
                  name:
                    type: string
                    examples:
                      - Example Company S.A.
                  lastname:
                    type:
                      - string
                      - 'null'
                  birthdate:
                    type:
                      - string
                      - 'null'
                    format: date
                  gender:
                    type:
                      - string
                      - 'null'
                  nationality:
                    type:
                      - string
                      - 'null'
                  birthCountry:
                    type:
                      - string
                      - 'null'
                  residenceCountry:
                    type:
                      - string
                      - 'null'
                  occupation:
                    type:
                      - string
                      - 'null'
                  isPep:
                    type: boolean
                    examples:
                      - false
                  incorporationDate:
                    type: string
                    examples:
                      - '2020-01-15'
                    format: date
                  incorporationCountry:
                    type: string
                    examples:
                      - BRA
                  website:
                    type: string
                    examples:
                      - https://www.example.com/new
                  legalRepresentativeName:
                    type: string
                    examples:
                      - Jane Doe
                  email:
                    type: string
                    examples:
                      - test@example.com
                  phone:
                    type: object
                    properties:
                      countryCode:
                        type: string
                        examples:
                          - '55'
                      areaCode:
                        type: string
                        examples:
                          - '11'
                      number:
                        type: string
                        examples:
                          - '999990099'
                  address:
                    type: object
                    properties:
                      street:
                        type: string
                        examples:
                          - Rua Exemplo
                      city:
                        type: string
                        examples:
                          - São Paulo
                      state:
                        type: string
                        examples:
                          - SP
                      zipCode:
                        type: string
                        examples:
                          - 01310-100
                      number:
                        type: string
                        examples:
                          - '200'
                      comment:
                        type: string
                        examples:
                          - Sala 1
                      country:
                        type: string
                        examples:
                          - BRA
                      line2:
                        type: string
                        examples:
                          - Sala 100
                      line3:
                        type: string
                        examples:
                          - Torre A
                  attributes:
                    type: object
                    properties:
                      emailPixKey:
                        type: string
                        examples:
                          - test@example.com
                      socialMedia:
                        type: string
                        examples:
                          - https://www.linkedin.com/company/example
                      numberOfEmployees:
                        type: string
                        examples:
                          - 11-50
                      countryTaxResidence:
                        type: string
                        examples:
                          - BRA
                      sourceOfFundsAndIncome:
                        type: string
                        examples:
                          - sales_of_goods_and_services
                      reasonForAccountOpening:
                        type: string
                        examples:
                          - receive_payments_for_goods_and_services
                      estimatedAnnualRevenueUsd:
                        type: string
                        examples:
                          - 1m_to_10m
                      estimatedMonthlyVolumeUsd:
                        type: string
                        examples:
                          - '50000'
                      businessActivityDescription:
                        type: string
                        examples:
                          - >-
                            Online retail of home goods. Receives payments from
                            end customers in Brazil via PIX.
                  documentationStatus:
                    type: string
                    examples:
                      - COMPLETE
                    enum:
                      - NO_FILES
                      - PARTIAL
                      - COMPLETE
                    description: >-
                      NO_FILES, PARTIAL ou COMPLETE: indica se nenhum, alguns ou
                      todos os documentos declarados possuem pelo menos um
                      arquivo. Mede a presença de arquivos, não a aprovação.
                  document:
                    type: object
                    properties:
                      documentId:
                        type: string
                        examples:
                          - 91eaf0c8-844b-42a1-a614-304edbcfa57d
                        format: uuid
                      entityId:
                        type: string
                        examples:
                          - 7c9e6679-7425-40de-944b-e07fc1f90ae7
                        format: uuid
                      type:
                        type: string
                        examples:
                          - CNPJ
                        enum:
                          - DNI
                          - NATIONAL_ID
                          - DRIVER_LICENSE
                          - PASSPORT
                          - CE
                          - CC
                          - CUIT
                          - CUIL
                          - RFC
                          - CURP
                          - CPF
                          - CNPJ
                          - RUC
                          - NIT
                          - TAX_ID
                          - ARTICLES_OF_INCORPORATION
                          - POWER_OF_ATTORNEY
                          - TAX_CERTIFICATE
                          - PAYSLIP
                          - ARCA_REGISTRATION
                          - PROOF_OF_ADDRESS
                          - PROOF_OF_FUNDS
                          - OTHER
                        description: PESSOA FÍSICA ou EMPRESA.
                      id:
                        type: string
                        examples:
                          - '00000000000100'
                      issuingCountry:
                        type: string
                        examples:
                          - BRA
                      issueDate:
                        type:
                          - string
                          - 'null'
                        format: date
                      expirationDate:
                        type:
                          - string
                          - 'null'
                        format: date
                      isPrimary:
                        type: boolean
                        examples:
                          - true
                      status:
                        type: string
                        examples:
                          - VERIFIED
                        enum:
                          - PENDING
                          - VERIFIED
                          - REJECTED
                          - EXPIRED
                        description: >-
                          Status derivado do documento: EXPIRED se a
                          expirationDate tiver passado, REJECTED se alguma prova
                          ativa for rejeitada, VERIFIED se todas as provas
                          ativas forem aprovadas, caso contrário PENDING.
                      metadata:
                        type:
                          - object
                          - 'null'
                      proofs:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              examples:
                                - ab62c0eb-e921-4d78-9887-25aa57c56c94
                            documentId:
                              type: string
                              examples:
                                - 91eaf0c8-844b-42a1-a614-304edbcfa57d
                              format: uuid
                            proofType:
                              type: string
                              examples:
                                - DOCUMENT
                              enum:
                                - FRONT
                                - BACK
                                - SELFIE
                                - DOCUMENT
                                - OTHER
                            fileName:
                              type: string
                              examples:
                                - proof_of_address_company.pdf
                            mimeType:
                              type: string
                              examples:
                                - application/pdf
                            sizeBytes:
                              type: integer
                              examples:
                                - 53248
                            verificationStatus:
                              type: string
                              examples:
                                - APPROVED
                              enum:
                                - PENDING
                                - IN_REVIEW
                                - APPROVED
                                - REJECTED
                            verifiedBy:
                              type: string
                              examples:
                                - '67890'
                            verifiedAt:
                              type: string
                              examples:
                                - '2024-01-15T17:20:45Z'
                              format: date-time
                            verificationReason:
                              type:
                                - string
                                - 'null'
                            uploadedBy:
                              type: string
                              examples:
                                - '12345'
                            uploadedAt:
                              type: string
                              examples:
                                - '2024-01-15T17:19:54Z'
                              format: date-time
                            status:
                              type: string
                              examples:
                                - CURRENT
                              enum:
                                - CURRENT
                                - SUPERSEDED
                                - DELETED
                              description: >-
                                Ciclo de vida da prova: CURRENT (ativa),
                                SUPERSEDED (substituída por um upload mais
                                recente do mesmo proofType) ou DELETED.
                                Independente de verificationStatus.
                            supersededAt:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            supersededBy:
                              type:
                                - string
                                - 'null'
                            replacedByProofId:
                              type:
                                - string
                                - 'null'
                              format: uuid
                            deletedAt:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            deletedBy:
                              type:
                                - string
                                - 'null'
                            inVerification:
                              type: boolean
                              examples:
                                - false
                      createdAt:
                        type: string
                        examples:
                          - '2024-01-15T17:18:53Z'
                        format: date-time
                        description: Carimbos de data/hora UTC ISO 8601.
                      updatedAt:
                        type: string
                        examples:
                          - '2024-01-15T17:19:26Z'
                        format: date-time
                        description: Carimbos de data/hora UTC ISO 8601.
                    description: >-
                      O documento principal com seu documentId (necessário para
                      enviar arquivos), o status derivado e as proofs[] atuais.
                  documents:
                    type: array
                    items:
                      type: object
                      properties:
                        documentId:
                          type: string
                          examples:
                            - a4f9d2ed-c365-4a0b-b775-9278c039af93
                          format: uuid
                        entityId:
                          type: string
                          examples:
                            - 7c9e6679-7425-40de-944b-e07fc1f90ae7
                          format: uuid
                        type:
                          type: string
                          examples:
                            - ARTICLES_OF_INCORPORATION
                          enum:
                            - DNI
                            - NATIONAL_ID
                            - DRIVER_LICENSE
                            - PASSPORT
                            - CE
                            - CC
                            - CUIT
                            - CUIL
                            - RFC
                            - CURP
                            - CPF
                            - CNPJ
                            - RUC
                            - NIT
                            - TAX_ID
                            - ARTICLES_OF_INCORPORATION
                            - POWER_OF_ATTORNEY
                            - TAX_CERTIFICATE
                            - PAYSLIP
                            - ARCA_REGISTRATION
                            - PROOF_OF_ADDRESS
                            - PROOF_OF_FUNDS
                            - OTHER
                          description: PESSOA FÍSICA ou EMPRESA.
                        id:
                          type: string
                          examples:
                            - ART-00000000000100
                        issuingCountry:
                          type: string
                          examples:
                            - BRA
                        issueDate:
                          type:
                            - string
                            - 'null'
                          format: date
                        expirationDate:
                          type:
                            - string
                            - 'null'
                          format: date
                        isPrimary:
                          type: boolean
                          examples:
                            - false
                        status:
                          type: string
                          examples:
                            - VERIFIED
                          enum:
                            - PENDING
                            - VERIFIED
                            - REJECTED
                            - EXPIRED
                          description: >-
                            Status derivado do documento: EXPIRED se a
                            expirationDate tiver passado, REJECTED se alguma
                            prova ativa for rejeitada, VERIFIED se todas as
                            provas ativas forem aprovadas, caso contrário
                            PENDING.
                        metadata:
                          type:
                            - object
                            - 'null'
                        proofs:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                examples:
                                  - 0b2e18fb-1b61-402c-be80-863735d3fa4d
                              documentId:
                                type: string
                                examples:
                                  - a4f9d2ed-c365-4a0b-b775-9278c039af93
                                format: uuid
                              proofType:
                                type: string
                                examples:
                                  - DOCUMENT
                                enum:
                                  - FRONT
                                  - BACK
                                  - SELFIE
                                  - DOCUMENT
                                  - OTHER
                              fileName:
                                type: string
                                examples:
                                  - certificate_of_incorporation.pdf
                              mimeType:
                                type: string
                                examples:
                                  - application/pdf
                              sizeBytes:
                                type: integer
                                examples:
                                  - 55296
                              verificationStatus:
                                type: string
                                examples:
                                  - APPROVED
                                enum:
                                  - PENDING
                                  - IN_REVIEW
                                  - APPROVED
                                  - REJECTED
                              verifiedBy:
                                type: string
                                examples:
                                  - '67890'
                              verifiedAt:
                                type: string
                                examples:
                                  - '2024-01-15T17:20:43Z'
                                format: date-time
                              verificationReason:
                                type:
                                  - string
                                  - 'null'
                              uploadedBy:
                                type: string
                                examples:
                                  - '12345'
                              uploadedAt:
                                type: string
                                examples:
                                  - '2024-01-15T17:19:52Z'
                                format: date-time
                              status:
                                type: string
                                examples:
                                  - CURRENT
                                enum:
                                  - CURRENT
                                  - SUPERSEDED
                                  - DELETED
                                description: >-
                                  Ciclo de vida da prova: CURRENT (ativa),
                                  SUPERSEDED (substituída por um upload mais
                                  recente do mesmo proofType) ou DELETED.
                                  Independente de verificationStatus.
                              supersededAt:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                              supersededBy:
                                type:
                                  - string
                                  - 'null'
                              replacedByProofId:
                                type:
                                  - string
                                  - 'null'
                                format: uuid
                              deletedAt:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                              deletedBy:
                                type:
                                  - string
                                  - 'null'
                              inVerification:
                                type: boolean
                                examples:
                                  - false
                        createdAt:
                          type: string
                          examples:
                            - '2024-01-15T17:18:53Z'
                          format: date-time
                          description: Carimbos de data/hora UTC ISO 8601.
                        updatedAt:
                          type: string
                          examples:
                            - '2024-01-15T17:19:26Z'
                          format: date-time
                          description: Carimbos de data/hora UTC ISO 8601.
                    description: >-
                      Os demais documentos declarados (o principal está apenas
                      em document), com a mesma estrutura.
                  version:
                    type: integer
                    examples:
                      - 3
                    description: >-
                      Versão da entidade. Igual ao cabeçalho ETag; envie-o de
                      volta como If-Match no PATCH.
                  createdAt:
                    type: string
                    examples:
                      - '2024-01-15T17:18:53Z'
                    format: date-time
                    description: Carimbos de data/hora UTC ISO 8601.
                  updatedAt:
                    type: string
                    examples:
                      - '2024-01-15T17:19:26Z'
                    format: date-time
                    description: Carimbos de data/hora UTC ISO 8601.
                  customFieldSchemaVersion:
                    type: integer
                    examples:
                      - 9
                    description: >-
                      Versão do esquema de campos personalizados usado para
                      validar atributos, ou nulo.
                  uboCount:
                    type: integer
                    examples:
                      - 2
                    description: >-
                      Número de vínculos de UBO ativos. Apenas no detalhe de uma
                      entidade COMPANY; null nos demais casos.
                  uboRequirementMet:
                    type: boolean
                    examples:
                      - true
                    description: >-
                      Verdadeiro quando uboCount for igual ou superior a 1.
                      Apenas nos detalhes de uma EMPRESA.
              examples:
                Example 1:
                  value:
                    internalId: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                    externalId: f47ac10b-58cc-4372-a567-0e02b2c3d479
                    type: COMPANY
                    status: PENDING_KYC
                    name: Example Company S.A.
                    lastname: null
                    birthdate: null
                    gender: null
                    nationality: null
                    birthCountry: null
                    residenceCountry: null
                    occupation: null
                    isPep: false
                    incorporationDate: '2020-01-15'
                    incorporationCountry: BRA
                    website: https://www.example.com/new
                    legalRepresentativeName: Jane Doe
                    email: test@example.com
                    phone:
                      countryCode: '55'
                      areaCode: '11'
                      number: '999990099'
                    address:
                      street: Rua Exemplo
                      city: São Paulo
                      state: SP
                      zipCode: 01310-100
                      number: '200'
                      comment: Sala 1
                      country: BRA
                      line2: Sala 100
                      line3: Torre A
                    attributes:
                      emailPixKey: test@example.com
                      socialMedia: https://www.linkedin.com/company/example
                      numberOfEmployees: 11-50
                      countryTaxResidence: BRA
                      sourceOfFundsAndIncome: sales_of_goods_and_services
                      reasonForAccountOpening: receive_payments_for_goods_and_services
                      estimatedAnnualRevenueUsd: 1m_to_10m
                      estimatedMonthlyVolumeUsd: '50000'
                      businessActivityDescription: >-
                        Online retail of home goods. Receives payments from end
                        customers in Brazil via PIX.
                    documentationStatus: COMPLETE
                    document:
                      documentId: 91eaf0c8-844b-42a1-a614-304edbcfa57d
                      entityId: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                      type: CNPJ
                      id: '00000000000100'
                      issuingCountry: BRA
                      issueDate: null
                      expirationDate: null
                      isPrimary: true
                      status: VERIFIED
                      metadata: null
                      proofs:
                        - id: ab62c0eb-e921-4d78-9887-25aa57c56c94
                          documentId: 91eaf0c8-844b-42a1-a614-304edbcfa57d
                          proofType: DOCUMENT
                          fileName: proof_of_address_company.pdf
                          mimeType: application/pdf
                          sizeBytes: 53248
                          verificationStatus: APPROVED
                          verifiedBy: '67890'
                          verifiedAt: '2024-01-15T17:20:45Z'
                          verificationReason: null
                          uploadedBy: '12345'
                          uploadedAt: '2024-01-15T17:19:54Z'
                          status: CURRENT
                          supersededAt: null
                          supersededBy: null
                          replacedByProofId: null
                          deletedAt: null
                          deletedBy: null
                          inVerification: false
                      createdAt: '2024-01-15T17:18:53Z'
                      updatedAt: '2024-01-15T17:19:26Z'
                    documents:
                      - documentId: a4f9d2ed-c365-4a0b-b775-9278c039af93
                        entityId: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                        type: ARTICLES_OF_INCORPORATION
                        id: ART-00000000000100
                        issuingCountry: BRA
                        issueDate: null
                        expirationDate: null
                        isPrimary: false
                        status: VERIFIED
                        metadata: null
                        proofs:
                          - id: 0b2e18fb-1b61-402c-be80-863735d3fa4d
                            documentId: a4f9d2ed-c365-4a0b-b775-9278c039af93
                            proofType: DOCUMENT
                            fileName: certificate_of_incorporation.pdf
                            mimeType: application/pdf
                            sizeBytes: 55296
                            verificationStatus: APPROVED
                            verifiedBy: '67890'
                            verifiedAt: '2024-01-15T17:20:43Z'
                            verificationReason: null
                            uploadedBy: '12345'
                            uploadedAt: '2024-01-15T17:19:52Z'
                            status: CURRENT
                            supersededAt: null
                            supersededBy: null
                            replacedByProofId: null
                            deletedAt: null
                            deletedBy: null
                            inVerification: false
                        createdAt: '2024-01-15T17:18:53Z'
                        updatedAt: '2024-01-15T17:19:26Z'
                      - documentId: 5ca3e868-2b76-4390-b25a-5d10c0db8516
                        entityId: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                        type: TAX_ID
                        id: 00.000.000/0001-00
                        issuingCountry: BRA
                        issueDate: '2024-01-15'
                        expirationDate: '2034-01-15'
                        isPrimary: false
                        status: VERIFIED
                        metadata:
                          tin: formatted
                        proofs:
                          - id: 13db8888-d5e6-4c47-95ce-1b962a63645c
                            documentId: 5ca3e868-2b76-4390-b25a-5d10c0db8516
                            proofType: DOCUMENT
                            fileName: company_tax_identification_document.pdf
                            mimeType: application/pdf
                            sizeBytes: 53248
                            verificationStatus: APPROVED
                            verifiedBy: '67890'
                            verifiedAt: '2024-01-15T17:20:44Z'
                            verificationReason: null
                            uploadedBy: '12345'
                            uploadedAt: '2024-01-15T17:19:53Z'
                            status: CURRENT
                            supersededAt: null
                            supersededBy: null
                            replacedByProofId: null
                            deletedAt: null
                            deletedBy: null
                            inVerification: false
                        createdAt: '2024-01-15T17:18:54Z'
                        updatedAt: '2024-01-15T17:19:32Z'
                    version: 3
                    createdAt: '2024-01-15T17:18:53Z'
                    updatedAt: '2024-01-15T17:19:26Z'
                    customFieldSchemaVersion: 9
                    uboCount: 2
                    uboRequirementMet: true
          headers:
            ETag:
              description: >-
                Versão da entidade. Envie-a de volta como If-Match em Update an
                Entity.
              schema:
                type: string
                examples:
                  - '"0"'
        '400':
          description: >-
            Solicitação inválida. VALIDATION_ERROR: Um campo, cabeçalho, caminho
            ou parâmetro de consulta está ausente, é desconhecido ou inválido.
            details[] lista o campo e o problema.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - VALIDATION_ERROR:
                  value:
                    type: about:blank
                    title: Validation error
                    status: 400
                    detail: >-
                      A field, header, path or query parameter is missing,
                      unknown or invalid. details[] lists field and issue.
                    instance: >-
                      /api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    code: VALIDATION_ERROR
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details:
                      - field: externalId
                        issue: REQUIRED
        '401':
          description: 'Não autorizado. UNAUTHORIZED: Token de acesso ausente ou inválido.'
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - UNAUTHORIZED:
                  value:
                    type: about:blank
                    title: Unauthorized
                    status: 401
                    detail: Missing or invalid access token.
                    instance: >-
                      /api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    code: UNAUTHORIZED
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
        '404':
          description: >-
            Não encontrado. ENTITY_NOT_FOUND: A entidade não existe ou pertence
            a outro comerciante.
          content:
            application/problem+json:
              schema:
                type: object
                description: >-
                  Detalhes do problema segundo a RFC 9457
                  (application/problem+json).
                properties:
                  type:
                    type: string
                    examples:
                      - about:blank
                  title:
                    type: string
                    description: Breve resumo do problema.
                  status:
                    type: integer
                    description: Código de status HTTP.
                  detail:
                    type: string
                    description: Explicação em linguagem acessível a humanos.
                  instance:
                    type: string
                    description: Caminho da solicitação.
                  code:
                    type: string
                    description: >-
                      Código de erro estável e legível por máquina. Faça a
                      ramificação da lógica com base nesse valor.
                  correlationId:
                    type: string
                    format: uuid
                    description: >-
                      Identificador da solicitação. Informe-o ao entrar em
                      contato com o suporte.
                    examples:
                      - 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                  details:
                    type: array
                    description: Campos problemáticos, quando aplicável.
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          examples:
                            - numberOfEmployees
                        issue:
                          type: string
                          examples:
                            - NOT_IN_OPTIONS
              examples:
                Example 1 - ENTITY_NOT_FOUND:
                  value:
                    type: about:blank
                    title: Not found
                    status: 404
                    detail: The entity does not exist or belongs to another merchant.
                    instance: >-
                      /api/entity/v1/entities/5aced5da-40c1-4bec-85ff-c8cd1bcb4526
                    code: ENTITY_NOT_FOUND
                    correlationId: 0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10
                    details: []
      security:
        - token: []
components:
  securitySchemes:
    token:
      type: http
      scheme: bearer

````

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