Solicitar enriquecimento

Request

Cria uma requisição de enriquecimento de dados com layout específico.

Campo parameters: Alguns layouts exigem configuração adicional.

Exemplo - Layout 3 (Standard - Email PF):

Define quantos emails por pessoa serão retornados
Limite máximo: 5 emails por pessoa
Formato: Array JSON, ex: ["2"] para 2 emails

Múltiplos Parâmetros: Devem ser enviados como array ordenado, ex: ["1", "1"]

Security

ApiKeyAuth

Bodyapplication/jsonrequired

namestring

Nome identificador do job de enriquecimento

Example:"Enriquecimento Base Clientes Janeiro"

layout_idintegerrequired

ID do layout a ser utilizado

Example:3

parametersArray of strings

Parâmetros adicionais exigidos pelo layout

Example:

[
  "2"
]

filestring, (byte)required

Arquivo em base64 contendo CPF/CNPJ para enriquecer

Example:"UEsDBBQABgAIAAAAIQ..."

callback_emailstring, (email)

Email para notificação quando processamento concluir

Example:"usuario@empresa.com"

curl -i -X POST \
  https://docs.datastone.com.br/_mock/api/enrichment/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Enriquecimento Base Clientes Janeiro",
    "layout_id": 3,
    "parameters": [
      "2"
    ],
    "file": "UEsDBBQABgAIAAAAIQ...",
    "callback_email": "usuario@empresa.com"
  }'

Responses

Enriquecimento solicitado com sucesso

Bodyapplication/json

idinteger

ID da requisição de enriquecimento

Example:98765

statusstring

Example:"requested"

Response

{
  "id": 98765,
  "status": "requested"
}