Pular para o conteúdo principal
Entidades permite que você registre as pessoas (INDIVIDUAL) e empresas (COMPANY) com quem você trabalha, declare a identidade deles e os documentos comprobatórios, faça o upload dos arquivos que os comprovem e acompanhe o resultado da análise KYC/KYB realizada pela Localpayment. A entidade é compartilhada entre recebimentos e pagamentos: a mesma entidade pode ser usada em todos os produtos da Localpayment. Este guia destina-se a desenvolvedores que integram clientes, beneficiários ou parceiros comerciais por meio da API.
Entidades armazena dados de identidade e comprovantes e registra o resultado da análise. Você solicita a análise com Solicitar verificação, mas nunca a aprova: quem decide é a Conformidade da Localpayment. Entidades não valida números de documentos em registros governamentais e não mantém saldos.

Objetos

Como funciona

Sua integração tem cinco etapas. A última, verify, informa à Localpayment que o upload foi concluído e inicia a análise. Com verify, a sua parte do upload termina: você não precisa consultar o status da entidade depois disso. Você só volta a agir sobre a entidade se a Localpayment solicitar uma correção. Se a Localpayment precisar de uma correção, ela indica o que deve ser corrigido: cada arquivo rejeitado contém seu verificationReason. Envie uma substituição com o mesmo proofType ou corrija os dados e, em seguida, chame Solicitar verificação novamente. Consulte Acompanhe a revisão e corrija as rejeições.

Status das entidades

“Editável” significa que os dados, documentos e arquivos KYC ainda podem ser alterados. Editar um documento redefine seus arquivos aprovados para PENDING. Editar outros dados da entidade não altera uma revisão já registrada.

Status dos documentos e comprovantes

O Localpayment Compliance define o status de cada comprovante. O status de um documento é derivado de seus comprovantes e de sua validade. documentationStatus na entidade resume a cobertura de arquivos: NO_FILES (nenhum documento possui arquivo), PARTIAL (alguns possuem) ou COMPLETE (todos possuem). Não expressa aprovação.

Convenções

Próximos passos

Criar uma entidade

Cadastre uma pessoa física ou jurídica com seu documento principal.

Carregar documentos e comprovantes

Anexe os arquivos que comprovam cada documento.

Acompanhe a revisão e corrija as rejeições

Acompanhe a análise e corrija o que a Localpayment solicitar.

Compartilhar informações KYB por meio de entidades

Enviar os dados KYB de um beneficiário de Conta Virtual.
Última modificação em 10 de novembro de 2026