Skip to main content
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.
O link é efêmero: gere um a cada envio, não guarde. Ele expira na data de expiresAt, e um link vencido no e-mail do recebedor vira suporte. Gere na hora de enviar — chamar a rota de novo não custa nada e não invalida o cadastro.
Quem tem o link mexe no cadastro. Ele autentica pela posse, sem login, porque é assim que o recebedor consegue completar os dados sozinho. Envie pelo canal do titular e não o deixe em log nem em URL de analytics.
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

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID do recebedor

Response

Link KYC gerado

kycUrl
string

URL para conclusão do processo de verificação (KYC) do recebedor.

expiresAt
string<date-time>

Data e hora em que o registro expira (ISO 8601).