---
title: "Obter detalhes da aplicação"
method: GET
path: "/open-keys/itp/api/v2/applications/{applicationId}"
tags: ["Gerenciamento de Aplicação"]
---

# Obter detalhes da aplicação

`GET /open-keys/itp/api/v2/applications/{applicationId}`

Recupera informações detalhadas sobre uma aplicação específica incluindo todos os recursos relacionados como contas, redirecionamentos, webhooks, configurações e jornadas.

## Path parameters

- `applicationId` string, required

## Response `200`

retornou com sucesso.

- Application
  - `id` string, required — O ID da aplicação. É um número exclusivo que identifica a aplicação.
  - `createdAt` string, required
  - `updatedAt` string, required
  - `deletedAt` string, required
  - `name` string, required — Nome de identificação da aplicação
  - `description` string — Descrição da aplicação
  - `image` string, uri — URL da imagem da empresa
  - `clientId` string, required — O client_id é um identificador público para aplicativos.
  - `externalId` string, required — O externalId é o identificador externo da aplicação. Usamos este id como o do Client do Keycloak.
  - `accounts` ApplicationAccount[] — Array de contas permitidos na aplicação.
    - `id` string, required — O ID da conta da aplicação.
    - `createdAt` string, required
    - `updatedAt` string, required
    - `deletedAt` string, required
    - `applicationId` string — O ID da aplicação. É um número exclusivo que identifica a aplicação.
    - `owner` ApplicationAccountOwner, required
      - `cpfCnpj` string, required
      - `personType` 'PESSOA_NATURAL' | 'PESSOA_JURIDICA', required
      - `name` string, required
    - `paymentAccount` ApplicationAccountPaymentAccount, required
      - `accountType` 'CACC' | 'TRAN' | 'SVGS', required — Tipos de contas usadas para pagamento. Modalidades tradicionais previstas pela Resolução 4.753, não contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletrônica. Segue descrição de cada valor do ENUM. - CACC - Current - Conta Corrente. - SVGS - Savings - Conta de Poupança. - TRAN - TransactingAccount - Conta de Pagamento pré-paga.
      - `ispb` string, required — Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantâneos) somente com números.
      - `issuer` string — Código da Agência emissora da conta sem dígito. (Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória). [Restrição] Preenchimento obrigatório para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA).
      - `number` string, required — Deve ser preenchido com o número da conta do usuário recebedor, com dígito verificador (se este existir), se houver valor alfanumérico, este deve ser convertido para 0.
    - `paymentKey` ApplicationAccountPaymentKey
      - `keyType` 'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP' — Tipo de chave. _Novos tipos podem surgir_.
      - `key` string, required — Chave cadastrada no DICT pertencente ao recebedor. Os tipos de chaves podem ser: telefone, e-mail, cpf/cnpj ou chave aleatória. No caso de telefone celular deve ser informado no padrão E.1641. Para e-mail deve ter o formato xxxxxxxx@xxxxxxx.xxx(.xx) e no máximo 77 caracteres. No caso de CPF deverá ser informado com 11 números, sem pontos ou traços. Para o caso de CNPJ deverá ser informado com 14 números, sem pontos ou traços. No caso de chave aleatória deve ser informado o UUID gerado pelo DICT, conforme formato especificado na RFC41223.
  - `redirects` ApplicationRedirect[] — Array de redirects permitidos na aplicação.
    - `id` string, required — O ID do redirecionamento da aplicação.
    - `createdAt` string, required
    - `updatedAt` string, required
    - `deletedAt` string, required
    - `applicationId` string, required — O ID da aplicação. É um número exclusivo que identifica a aplicação.
    - `allowedRedirectUrl` string, uri, required — Redirect Uri autorizado pela aplicação
  - `webhooks` ApplicationWebhook[], required — Array de webhooks permitidos na aplicação.
    - `id` string, required — O ID do webhook da aplicação.
    - `createdAt` string, required
    - `updatedAt` string, required
    - `deletedAt` string, required
    - `applicationId` string, required — O ID da aplicação. É um número exclusivo que identifica a aplicação.
    - `endpointBaseUrl` string, uri, required — URL de destino
    - `authentication` ApplicationWebhookAuthentication, required
      - `authType` 'no_auth' | 'api_key' | 'basic_auth' | 'bearer_token', required
      - `data` ApplicationWebhookAuthenticationData
        - `name` string
        - `value` string
        - `token` string
        - `username` string
        - `password` string
      - `add_position` 'header'

## Other responses

- `401` — Authentication is required to access this resource. The client must provide valid credentials.
- `403` — The server understood the request but refuses to authorize it. Access is permanently forbidden and tied to the application logic.
- `409` — The request conflicts with the current state of the resource on the server.
- `422` — The request contains invalid or malformed data that cannot be processed.
- `500` — An unexpected error occurred on the server while processing the request.
- `default` — Unexpected error.

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)