Pular para o conteúdo principal
POST
Iniciar monitoramento

Autorizações

Authorization
string
header
obrigatório

Credencial OAuth da Base39 com os escopos profile e user:org:read, ou chave de API pertencente à organização. A organização e o autor são obtidos da autenticação.

Corpo

application/json
document
string
obrigatório

CPF ou CNPJ completo a monitorar.

Pattern: ^(?:\d{11}|\d{3}\.\d{3}\.\d{3}-\d{2}|[0-9A-Za-z]{12}\d{2}|[0-9A-Za-z]{2}\.[0-9A-Za-z]{3}\.[0-9A-Za-z]{3}\/[0-9A-Za-z]{4}-\d{2})$
checks
enum<string>[]
obrigatório

Consultas de cada ciclo, cobradas pela tarifa normal.

Required array length: 1 - 12 elements
Opções disponíveis:
registration,
officers,
sanctions,
pep,
lawsuits,
protests,
quod,
serasa,
boavista,
scr,
sites,
reviews
frequency
enum<string>
padrão:daily

Periodicidade das consultas.

Opções disponíveis:
daily,
weekly,
monthly

Resposta

Objeto ou página de dados Base39; next_cursor ausente indica o fim da coleção.

document
string
obrigatório

CPF ou CNPJ completo, sem pontuação.

Pattern: ^(?:\d{11}|[0-9A-Z]{12}\d{2})$
checks
enum<string>[]
obrigatório

Consultas de cada ciclo, cobradas pela tarifa normal.

Required array length: 1 - 12 elements
Opções disponíveis:
registration,
officers,
sanctions,
pep,
lawsuits,
protests,
quod,
serasa,
boavista,
scr,
sites,
reviews
object
string
obrigatório

Item monitorado.

Allowed value: "portfolio_item"
id
string
obrigatório

ID do item monitorado.

Pattern: ^mon_[a-f0-9]{32}$
status
enum<string>
obrigatório

Estado do último ciclo de monitoramento.

Opções disponíveis:
pending,
active,
failed
created_at
string<date-time>
obrigatório

Data de criação.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
next_check_at
string<date-time>
obrigatório

Data prevista para a próxima consulta.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
last_checked_at
string<date-time> | null
obrigatório

Data do último ciclo concluído.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
last_error
string | null
obrigatório

Código da última falha; null se não houve.

frequency
enum<string>
padrão:daily

Periodicidade das consultas.

Opções disponíveis:
daily,
weekly,
monthly