> ## 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 histórico de status

Retorna o histórico de transições de status da entidade, com o ator, o motivo e o ID de correlação de cada mudança.

* As entradas são ordenadas cronologicamente.
* As transições realizadas pela Localpayment (IN\_REVIEW, ACTIVE, REJECTED, BLOCKED e o retorno a PENDING\_KYC para correções) aparecem aqui com seu motivo.

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}/status-history
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}/status-history:
    get:
      summary: Obter histórico de status
      operationId: get-entity-status-history
      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: array
                items:
                  type: object
                  properties:
                    fromStatus:
                      type: string
                      examples:
                        - PENDING_KYC
                      enum:
                        - PENDING_KYC
                        - IN_REVIEW
                        - ACTIVE
                        - REJECTED
                        - BLOCKED
                        - CLOSED
                      description: Transição.
                    toStatus:
                      type: string
                      examples:
                        - IN_REVIEW
                      enum:
                        - PENDING_KYC
                        - IN_REVIEW
                        - ACTIVE
                        - REJECTED
                        - BLOCKED
                        - CLOSED
                      description: Transição.
                    reason:
                      type: string
                      examples:
                        - Review started
                      description: >-
                        Motivo informado pelo ator (sempre presente em REJECTED
                        e BLOCKED).
                    changedBy:
                      type: string
                      examples:
                        - '12345'
                      description: >-
                        Usuário que fez a alteração: um usuário da sua conta (a
                        partir do token de acesso) ou um usuário de Conformidade
                        do Localpayment.
                    correlationId:
                      type: string
                      examples:
                        - b68165b9-1d60-4f9d-9919-7fee12411714
                      format: uuid
                      description: ID de correlação da solicitação que causou a alteração.
                    createdAt:
                      type: string
                      examples:
                        - '2024-01-15T17:03:15Z'
                      format: date-time
                      description: Quando aconteceu.
              examples:
                Example 1:
                  value:
                    - fromStatus: PENDING_KYC
                      toStatus: IN_REVIEW
                      reason: Review started
                      changedBy: '12345'
                      correlationId: b68165b9-1d60-4f9d-9919-7fee12411714
                      createdAt: '2024-01-15T17:03:15Z'
                    - fromStatus: IN_REVIEW
                      toStatus: ACTIVE
                      reason: KYC approved
                      changedBy: '67890'
                      correlationId: b07a3416-11fb-48d8-8671-be471694f0a2
                      createdAt: '2024-01-15T17:03:22Z'
        '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/status-history
                    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/status-history
                    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.