---
title: "Geração do ticket de acesso ao WebView"
method: POST
path: "/consent-flow/ticket"
tags: ["Geração de tickets"]
---

# Geração do ticket de acesso ao WebView

`POST /consent-flow/ticket`

## Request

- Base URL: `https://api-mtls.sandbox.bankly.com.br`
- URL: `https://api-mtls.sandbox.bankly.com.br/consent-flow/ticket`
- Auth: HTTP bearer

<div class="bkly-ref-description">
  <p>Gere um <i>ticket</i> que dará acesso ao <i>WebView</i> para iniciar a transmissão de dados de seu cliente no ecossistema Open Finance.</p> 
  <span class="bkly-ref-small-stable-tag">stable</span>
  <span class="bkly-ref-scope-tag">scope: openfinance.ticket.write</span>
</div>
[block:callout]
{
  "type": "info",
  "title": "Nota",
  "body": "Para mais informações, confira a documentação [Geração do ticket de acesso ao WebView](/docs/geracao-ticket-webview)."
}
[/block]

## Headers

- `Authorization` string, required: <i>Token</i> de autorização do tipo Bearer.
- `api-version` string, required
- `x-correlation-id` string, required: Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.
- `Idempotency-Key` string

## Request body

- CreateTicketRequest
  - `documentNumber` string, required: Número do documento do cliente. Informe somente números
  - `requestUri` string, required: Valor coletado pelo parceiro via <code>querystring</code> através do <i>deep link</i> de redirecionamento.
  - `clientId` string, required: Código do cliente. Esse valor é coletado pelo parceiro via <code>querystring</code> através do <i>deep link</i> de redirecionamento.

## Response `201`

<i>Ticket</i> criado com sucesso.

- CreateTicketResponse
  - `ticketId` string: Identifica o <i>ticket</i> gerado pelo parceiro, com tempo de vida de 60 segundos.
  - `companyKey` string: Chave que identifica o parceiro dentro do Bankly.
  - `documentNumber` string: Número do documento do cliente.
  - `requestUri` string: Valor coletado pelo parceiro via <code>querystring</code> através do <i>deep link</i> de redirecionamento, com tempo de vida de 60 segundos.
  - `clientId` string: Código do cliente. Esse valor é coletado pelo parceiro via <code>querystring</code> através do <i>deep link</i> de redirecionamento, com tempo de vida de 60 segundos.
  - `status` 'USED' | 'UNUSED': Situação do ticket.
  - `createdAt` string, date-time: Data e hora de criação do <i>ticket</i>.
  - `updatedAt` string, date-time: Data e hora de atualização do <i>ticket</i>.

## Other responses

- `400`: Há algum problema com a sua requisição.
- `401`: Acesso não autorizado.
- `500`: Ocorreu algum erro inexperado em nosso servidor.

---

[API](https://skmtc.dev/bankly/apis/open-finance.md) - [All operations](https://skmtc.dev/bankly/apis/open-finance/llms.txt) - [OpenAPI document](https://skmtc.dev/bankly/apis/open-finance/revisions/16664923d2f6?raw)