Gerar link KYC
Recebedores
Gerar link KYC
Cria um link temporário para o recebedor completar o próprio cadastro, sem passar por você.
POST
Gerar link KYC
POST /recipients/:id/kyc-link
Faz parte do recurso Recebedores — os estados do vínculo, o ciclo de aprovação
e o catálogo de pendências estão lá.
Gera uma URL que o recebedor abre para enviar documentos, completar dados pessoais e fazer a prova
de vida. A resposta é o link e a data em que ele deixa de valer.
Serve para o que você não pode fazer por ele. Documento com foto e prova de vida exigem a
presença da pessoa — não há campo de API que substitua. É o caminho quando o recebedor está em
awaiting_liveness, ou quando a análise pediu documento que você não tem.Responde
404 se o recebedor não estiver vinculado à sua conta. A rota exige o vínculo, não
só o cadastro existir.Exemplo
Resposta 201
A resposta tem só esses dois campos — não traz o recebedor. Para acompanhar o que a análise ainda
pede, use
GET /recipients/{id}.Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Path Parameters
ID do recebedor