Consultar KYC vigente
POST/kyc/v1/current-dossier/lookup
Informa a situação do KYC vigente de um documento, num tipo de KY, sem abrir dossiê. Serve para saber se já existe um KYC válido antes de criar outro (que seria uma nova consulta paga). Não consome cota.
O campo situacao indica: nenhum (não há KYC vigente), valido (dentro do prazo de reconsulta), vencido (prazo de reconsulta vencido), em_andamento (ainda em processamento) ou erro.
O documento vai no corpo da requisição, e não na URL, para que o CPF ou CNPJ não apareça em logs de acesso.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
Situação do KYC atual.
Requisição inválida: documento malformado ou parâmetro inválido ou fora de faixa.
x-api-key ausente, desconhecida ou inválida.
Acesso negado. O campo error.code diz o motivo:
forbidden: chave revogada ou desabilitada, sem permissão para a operação, ou workspace inativo;ip_not_allowed: a chave tem restrição por IP de origem e a requisição veio de fora da lista (origem da requisição não autorizada para esta chave de API). A resposta não informa a lista nem o IP visto;quota_not_configured: a chave não tem teto diário configurado, e chave sem teto não cria dossiê. Peça ao administrador do workspace para definir o teto;route_not_in_plan: o plano de API do workspace não inclui esta rota. É verificado a cada chamada.
ky_type_not_found: o tipo de KY não existe neste workspace ou não está disponível para a chave. As duas situações têm a mesma resposta, de propósito.
Requisição inválida: documento malformado ou parâmetro inválido ou fora de faixa.