Skip to main content
POST
https://localapi.lazydata.com.br
/
v1
/
enrichment
Criar enriquecimento
curl --request POST \
  --url https://localapi.lazydata.com.br/v1/enrichment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "name": "<string>",
  "file": {},
  "enrichment_id": "<string>"
}
'
{
  "code": 200,
  "message": "Assinatura de upload gerada.",
  "result": {
    "enrichment_id": "9fcb573b-7f62-4774-978b-07e89dfef5f2",
    "type": "pf",
    "name": "Base de clientes",
    "status": "waiting_upload",
    "upload_url": "https://upload.lazydata.com.br/enrichment",
    "signature": "<assinatura_de_upload>",
    "signature_expires_at": "2026-06-22T14:00:00+00:00",
    "file": {
      "name": "base-clientes.csv",
      "extension": "csv"
    }
  }
}
Cria ou prepara um enriquecimento e retorna uma assinatura temporária para enviar o arquivo de entrada no serviço de upload. Depois de receber upload_url e signature, envie o arquivo em Upload para enriquecimento.
{
  "code": 200,
  "message": "Assinatura de upload gerada.",
  "result": {
    "enrichment_id": "9fcb573b-7f62-4774-978b-07e89dfef5f2",
    "type": "pf",
    "name": "Base de clientes",
    "status": "waiting_upload",
    "upload_url": "https://upload.lazydata.com.br/enrichment",
    "signature": "<assinatura_de_upload>",
    "signature_expires_at": "2026-06-22T14:00:00+00:00",
    "file": {
      "name": "base-clientes.csv",
      "extension": "csv"
    }
  }
}

Corpo da requisição

type
string
required
Tipo da base enviada. Use pf para CPF ou pj para CNPJ.
name
string
required
Nome do enriquecimento.
file
object
required
Metadados do arquivo que será enviado no serviço de upload.
enrichment_id
string
ID de um enriquecimento existente ainda sem arquivo. Use apenas quando precisar gerar uma nova assinatura para um enriquecimento já criado.

Estrutura de file

CampoTipoObrigatórioDescrição
namestringSimNome do arquivo que será enviado.
extensionstringSimExtensão do arquivo. Valores aceitos: csv, xls ou xlsx.

Exemplo de corpo

{
  "type": "pf",
  "name": "Base de clientes",
  "file": {
    "name": "base-clientes.csv",
    "extension": "csv"
  }
}

Resposta

code
integer
required
Código da resposta.
message
string
required
Mensagem descritiva da operação.
result
object
required
Dados do enriquecimento criado e assinatura temporária de upload.

Estrutura de result

CampoTipoDescrição
enrichment_idstringIdentificador do enriquecimento.
typestringTipo do enriquecimento: pf ou pj.
namestringNome do enriquecimento.
statusstringStatus inicial. Normalmente waiting_upload.
upload_urlstringURL do serviço de upload.
signaturestringAssinatura temporária usada no header X-LazyData-Upload-Signature.
signature_expires_atstringData de expiração da assinatura em ISO 8601.
fileobjectMetadados do arquivo esperado.
A assinatura é temporária. Se expirar antes do envio, gere uma nova assinatura usando o mesmo enrichment_id.

Próximo passo

Enviar arquivo

Use upload_url e signature para enviar o arquivo no serviço de upload.