Pular para o conteúdo principal
Este guia orienta você no processo de registro de uma pessoa física e jurídica com a opção Criar uma Entidade. A entidade é criada sem arquivos. Você os carrega na próxima etapa, Carregar Documentos e Comprovantes.

Pré-requisitos

  • Um token de acesso do ambiente Stage. Consulte Obter token de acesso.
  • O tipo de entidade: INDIVIDUAL para uma pessoa natural, COMPANY para uma pessoa jurídica.
  • O documento de identificação. Para uma pessoa: o número de identificação fiscal (CPF, CUIT, RFC, CURP) ou um documento de identidade (DNI, PASSPORT, CC). Para uma empresa: o número de identificação fiscal (CNPJ, CUIT, RFC, RUC, NIT). Ele se torna o documento principal.
  • Um externalId estável: sua própria referência, exclusiva por comerciante.
  • Se a Localpayment configurou campos personalizados para o seu comerciante, consulte o esquema. Veja Campos Personalizados.

Quais documentos declarar?

Um documento é uma identificação que contém quantos arquivos você precisar, como a frente, o verso e uma selfie de um documento de identidade. Envie o documento de identificação em document ao criar a entidade, ela se torna o documento principal. Declare todos os outros documentos com Adicionar um Documento. O par type + id deve ser único em seu estabelecimento. A lista completa de valores encontra-se em Tipos de Documento e Prova.

Dados mínimos

A ausência de dados KYC obrigatórios retorna o código 422 INCOMPLETE_KYC_DATA.

Criar uma pessoa

Request
Response
A resposta é 201 Created com o cabeçalho ETag: "0". Manter internalId (a entidade) e document.documentId (o documento principal). Os próximos passos exigem ambos.

Crie uma empresa

Uma empresa com seu número de identificação fiscal como documento principal, um endereço com linhas adicionais e campos personalizados:

Lide com erros na sua integração.

Erros comuns

Exemplo de erro de validação de campos personalizados:
Um número de identificação fiscal (CPF, CNPJ, CUIT, RFC) é um documento, não um campo da entidade. Envie-o em document. Os códigos de país devem ser ISO 3166-1 alfa-3 (BRA, não BR).

Próximos passos

Carregar documentos e comprovativos

Anexe os arquivos que comprovam cada documento declarado.

Criar uma referência de entidade

Todos os campos de solicitação, campos de resposta e códigos de erro.
Última modificação em 10 de novembro de 2026