Iniciar a autorização da conta
Devolve o endereço em que você autoriza a conta e por quantos segundos ele vale. O corpo é vazio de propósito: não há nada a escolher.
Autenticação
A sessão do painel autentica esta rota, e ela é lida de forma autoritativa: não há parâmetro em que o chamador aponte para outra conta.
Esta rota não exige escopo nomeado — o que não quer dizer que ela seja aberta: sem a credencial acima ela recusa.
Exige sessão de vendedor. A conta lida e escrita é sempre a da sessão: não há campo em que o chamador escolha outra.
Parâmetros
Corpo da requisição
application/json.
{}Respostas
200 · sucesso
{
"authorizationUrl": "https://loja.exemplo.com.br/webhooks",
"expiresInSeconds": 1
}403 · proibido
Confirme a segurança da conta antes de iniciar a autorização.
409 · conflito
A autorização não pode começar agora, e o code da resposta diz qual condição bloqueou. Confira GET /kyc/status antes de repetir.
503 · indisponível
O passo de autorização está indisponível no momento; nada começou; repita em instantes.
Erros desta rota
| Status | Código | Quando | O que fazer |
|---|---|---|---|
| 409 | KYC_CONNECT_UNAVAILABLE | O passo de autorização não está disponível para esta conta agora. O cadastro ainda não chegou ao ponto em que ele começa, ou já foi resolvido por outro caminho. | Confira GET /kyc/status para ver em que ponto o cadastro está e o que falta. Repetir antes de o estado mudar devolve o mesmo 409. |
| 409 | KYC_NO_ACQUIRER_MAPPED | Esta conta ainda não tem para onde a autorização ser encaminhada. É configuração do nosso lado, e nada do que você envia altera isso. | Reporte a ocorrência a quem opera a instalação. Repetir não muda o resultado. |
| 503 | KYC_ACQUIRER_UNAVAILABLE | O passo de autorização não respondeu agora. Nada começou: não existe autorização pendente pela metade para você confirmar depois. | Repita em instantes. Aqui repetir é o conserto. |
| 403 | ACCOUNT_SECURITY_KYC_CLEARANCE_REQUIRED | A confirmação de segurança expirou ou foi invalidada; nenhuma autorização começou. | Confirme a segurança novamente e reinicie a autorização. |
Os códigos são estáveis e fazem parte do contrato. A lista completa, com todos os vocabulários, está na tabela de erros.