Criar enriquecimento
Enriquecimento
Criar enriquecimento
Crie ou prepare um enriquecimento e gere a assinatura temporária para upload do arquivo.
POST
Criar enriquecimento
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
Estrutura de
Estrutura de
upload_url e signature, envie o arquivo em Upload para enriquecimento.
Corpo da requisição
Tipo da base enviada. Use
pf para CPF ou pj para CNPJ.Nome do enriquecimento.
Metadados do arquivo que será enviado no serviço de upload.
ID de um enriquecimento existente ainda sem arquivo. Use apenas quando precisar gerar uma nova assinatura para um enriquecimento já criado.
Estrutura de file
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome do arquivo que será enviado. |
extension | string | Sim | Extensão do arquivo. Valores aceitos: csv, xls ou xlsx. |
Exemplo de corpo
Resposta
Código da resposta.
Mensagem descritiva da operação.
Dados do enriquecimento criado e assinatura temporária de upload.
Estrutura de result
| Campo | Tipo | Descrição |
|---|---|---|
enrichment_id | string | Identificador do enriquecimento. |
type | string | Tipo do enriquecimento: pf ou pj. |
name | string | Nome do enriquecimento. |
status | string | Status inicial. Normalmente waiting_upload. |
upload_url | string | URL do serviço de upload. |
signature | string | Assinatura temporária usada no header X-LazyData-Upload-Signature. |
signature_expires_at | string | Data de expiração da assinatura em ISO 8601. |
file | object | Metadados do arquivo esperado. |
Próximo passo
Enviar arquivo
Use
upload_url e signature para enviar o arquivo no serviço de upload.
