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

# Verificações de hoje por hora: API

> Veja as verificações de hoje por hora na Didit, no seu fuso horário, com o mesmo dia da semana passada, e aprovadas, em análise ou recusadas.



Prompt da API para obter as verificações de hoje por hora
        Copiar o prompt para a área de transferência



      
      

\<pre>

\`Read today's verifications of my Didit application hour by hour.

Endpoint:
GET https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/analytics/today/

Authentication:
Use the x-api-key header with my Didit API key. Only a full-access key works: any scoped key gets 403 "This API key has no access to this endpoint.". application_id must be the application the key belongs to.

Goal:
\- Show today's verification volume by hour against the same weekday last week, and today's outcomes, in my own dashboard.

Query parameters:
\- tz - IANA time zone whose midnight starts today, for example Europe/Madrid. Omit it for UTC.

Behavior:
\- hours - 24 counts: today's user verification (KYC) sessions by the local hour they were created in. The hours still to come are 0.
\- previous_hours - the same 24 counts for previous_date, the same weekday one week before.
\- total - today's verifications so far. previous_total_so_far - the comparison day's up to the same local time, so (total - previous_total_so_far) / previous_total_so_far compares the same part of both days.
\- outcomes - of today's verifications, how many are approved, in review and declined now. The rest are not finished yet.
\- current_hour - the local hour it is now. A day on which the clocks change has 23 or 25 hours: the missing hour stays 0 and the repeated hour holds both.

Example call:
curl -X GET "https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/today/?tz=Europe%2FMadrid" \
-H "x-api-key: YOUR_API_KEY"

Failure modes:
\- 400 - {"tz": ["Unknown time zone: Europe/Atlantis."]} for a name the time zone database does not know.
\- 401 - the API key has expired.
\- 403 - missing or invalid key ({"detail": "Authentication credentials were not provided or are invalid."}), a key of another application ({"detail": "You do not have permission to perform this action."}), any scoped key, or a request from outside the key's IP list.
\- 429 - more than 600 GET requests per minute with this key.

Side effects: none. Not billed.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Colar em

A API de verificações de hoje por hora da Didit devolve as verificações de utilizadores de hoje por hora, a partir da meia-noite no fuso horário que enviar, juntamente com as mesmas horas do mesmo dia da semana da semana anterior. São os dados que alimentam o cartão de volume no Home da Business Console.| Campo | O que contém |
| - | - |
| `hours` | As verificações de hoje por hora local, a partir das 00:00. As horas que ainda não ocorreram têm o valor `0`. |
| `previous_hours` | As mesmas horas em `previous_date`, o mesmo dia da semana da semana anterior. |
| `total`, `previous_total_so_far` | Hoje até ao momento, e o dia de comparação até à mesma hora local. |
| `outcomes` | Das verificações de hoje, quantas estão agora `approved`, `in_review` e `declined`. |Os valores são lidos em tempo real das suas verificações, pelo que uma verificação criada há instantes já está contabilizada. Para um intervalo de datas e as restantes métricas do painel, use [Obter as análises da aplicação](https://docs.didit.me/pt/management-api/analytics/get.md).> [!NOTE]
>
> Só uma chave de API com acesso total pode chamar este endpoint. Uma chave com acesso limitado recebe `403`, independentemente do acesso que tenha, e o mesmo acontece com a chave de outra aplicação. Consulte [Chaves de API](https://docs.didit.me/pt/console/api-keys.md).## Relacionados- [Obter as análises da aplicação](https://docs.didit.me/pt/management-api/analytics/get.md)
- [Painel de análises](https://docs.didit.me/pt/console/analytics.md)
- [Chaves de API e acesso limitado](https://docs.didit.me/pt/console/api-keys.md)


## OpenAPI

````yaml pt/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/analytics/today/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/organization/{organization_id}/application/{application_id}/analytics/today/:
    get:
      tags:
        - Analytics
      summary: Obter as verificações de hoje por hora
      description: >-
        Sessões de verificação de utilizadores (KYC) de hoje, a partir da
        meia-noite local em `tz`, contabilizadas por hora local em que foram
        criadas, ao lado das mesmas horas do mesmo dia da semana uma semana
        antes, e divididas pelo resultado que cada uma tem agora: aprovada, em
        análise ou recusada. Este é o cartão de volume da Página Inicial da
        Business Console.


        `total` é o total de hoje até ao momento. `previous_total_so_far`
        contabiliza o dia de comparação apenas até à mesma hora local, pelo que
        uma alteração entre eles compara o mesmo período de ambos os dias. As
        horas que ainda faltam hoje têm o valor `0`. Um dia em que os relógios
        mudam de hora tem 23 ou 25 horas: a hora em falta permanece a `0` e a
        hora repetida inclui ambas.
      operationId: get_application_analytics_today
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID da organização.
          example: 11111111-2222-3333-4444-555555555555
        - name: application_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            UUID da aplicação. Deve ser a aplicação à qual a chave de API
            pertence: uma chave usada em qualquer outra aplicação recebe `403`.
          example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
        - name: tz
          in: query
          required: false
          schema:
            type: string
            default: UTC
            example: Europe/Madrid
          description: >-
            Fuso horário IANA cuja meia-noite inicia o dia de hoje, por exemplo
            `Europe/Madrid` ou `America/Mexico_City`. Omita para UTC.
      responses:
        '200':
          description: >-
            Verificações de hoje por hora local, as do dia de comparação e os
            resultados de hoje.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationAnalyticsToday'
              examples:
                Madrid, 14:00:
                  value:
                    time_zone: Europe/Madrid
                    date: '2026-10-30'
                    current_hour: 14
                    previous_date: '2026-10-23'
                    hours:
                      - 3
                      - 1
                      - 0
                      - 0
                      - 1
                      - 2
                      - 4
                      - 9
                      - 14
                      - 18
                      - 21
                      - 19
                      - 22
                      - 24
                      - 27
                      - 0
                      - 0
                      - 0
                      - 0
                      - 0
                      - 0
                      - 0
                      - 0
                      - 0
                    previous_hours:
                      - 2
                      - 1
                      - 1
                      - 0
                      - 1
                      - 3
                      - 5
                      - 8
                      - 12
                      - 16
                      - 19
                      - 18
                      - 20
                      - 22
                      - 24
                      - 26
                      - 23
                      - 19
                      - 15
                      - 12
                      - 9
                      - 7
                      - 5
                      - 3
                    total: 165
                    previous_total_so_far: 151
                    outcomes:
                      approved: 139
                      in_review: 6
                      declined: 18
        '400':
          description: >-
            Fuso horário desconhecido. O corpo é indexado pelo parâmetro, com
            uma lista de mensagens.
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
              examples:
                Unknown time zone:
                  value:
                    tz:
                      - 'Unknown time zone: Europe/Atlantis.'
        '401':
          description: >-
            A chave de API expirou. Apenas uma chave criada com uma data de
            validade pode expirar; após essa data, cada pedido com ela responde
            `401`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Expired key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            O pedido não é permitido. Consulte `detail`: uma chave de API em
            falta ou inválida (nunca `401`), uma chave de outra aplicação,
            qualquer chave com âmbito ou um pedido efetuado fora da lista de IPs
            da chave.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Missing or invalid key:
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Another application:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key:
                  value:
                    detail: This API key has no access to this endpoint.
                Outside the key's IP list:
                  value:
                    detail: This API key can't be used from this IP address.
        '429':
          description: >-
            Mais de 600 pedidos GET por minuto com esta chave de API. Aguarde o
            número de segundos indicado em `Retry-After` e tente novamente.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Throttled:
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
          headers:
            Retry-After:
              description: Segundos até que a janela atual de um minuto seja reposta.
              schema:
                type: integer
                example: 23
            X-RateLimit-Limit:
              description: Pedidos permitidos por minuto neste orçamento.
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Pedidos restantes na janela atual.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Hora Unix em que a janela é reposta.
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/today/?tz=Europe%2FMadrid'
            \
              -H 'x-api-key: YOUR_API_KEY'
components:
  schemas:
    ApplicationAnalyticsToday:
      type: object
      description: >-
        Verificações de hoje por hora local em comparação com o mesmo dia da
        semana da semana passada.
      required:
        - time_zone
        - date
        - current_hour
        - previous_date
        - hours
        - previous_hours
        - total
        - previous_total_so_far
        - outcomes
      properties:
        time_zone:
          type: string
          description: O fuso horário IANA do dia e das respetivas horas.
          example: Europe/Madrid
        date:
          type: string
          format: date
          description: O dia de hoje nesse fuso horário.
          example: '2026-10-30'
        current_hour:
          type: integer
          minimum: 0
          maximum: 23
          description: A hora local atual.
          example: 14
        previous_date:
          type: string
          format: date
          description: 'O dia de comparação: o mesmo dia da semana uma semana antes.'
          example: '2026-10-23'
        hours:
          type: array
          items:
            type: integer
            minimum: 0
          minItems: 24
          maxItems: 24
          description: >-
            Verificações criadas hoje, por hora local a partir das 00:00. As
            horas ainda por decorrer são 0.
        previous_hours:
          type: array
          items:
            type: integer
            minimum: 0
          minItems: 24
          maxItems: 24
          description: >-
            Verificações criadas no dia de comparação, por hora local a partir
            das 00:00.
        total:
          type: integer
          minimum: 0
          description: Verificações criadas hoje até ao momento.
          example: 165
        previous_total_so_far:
          type: integer
          minimum: 0
          description: Verificações criadas no dia de comparação até à mesma hora local.
          example: 151
        outcomes:
          type: object
          description: >-
            Das verificações de hoje, quantas estão aprovadas, a aguardar em
            análise e recusadas neste momento. As restantes ainda não foram
            concluídas.
          required:
            - approved
            - in_review
            - declined
          properties:
            approved:
              type: integer
              minimum: 0
            in_review:
              type: integer
              minimum: 0
            declined:
              type: integer
              minimum: 0
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        A chave de API da sua aplicação, a partir de Programadores -> Chaves de
        API na Business Console. A chave principal tem acesso total. Uma chave
        nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por
        recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de
        endereços IP e a uma data de validade. 401 significa que a chave está
        incorreta, revogada ou expirada; 403 significa que nenhuma chave foi
        enviada, que a chave não tem acesso a este recurso ou ação, ou que o
        pedido veio de um endereço fora da sua lista de IP; 404 numa rota de
        sessão significa que a sessão está fora dos fluxos ou estados da chave.
        Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs
        como nulos, e uma chave sem permissão de escrita em sessões recebe
        ligações de sessão e tokens como nulos. Consulte
        https://docs.didit.me/console/api-keys.

````

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