Reserve leads

Reserves a batch of active leads to your project for the reservation TTL. Returns the leads plus a cota block describing your per-minute quota state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The response returns only the partner-facing fields listed in the table below.

Quota exhausted (200, reservados: 0) — when your per-minute quota is spent,
reservados is 0 and cota.janela_reinicia_em_segundos tells you when to retry.

Example with a 600/min limit: a first call asking 500 returns 500; a second call
asking 500 returns only 100 (quota now 0); a third returns 0 until the minute rolls.

cota block

FieldDescription
limite_por_minutoYour per-minute lead quota.
consumido_na_janelaLeads delivered to you in the current clock-minute.
restante_na_janelaLeads still available to you this minute.
janela_reinicia_em_segundosSeconds until the minute rolls and the quota resets.

lead object (fields in data.data[])

FieldTypeDescription
hashstring (uuid)Public lead identifier (use it to fetch lead detail).
id_dataprevstring (int)Dataprev request id. This is the idSolicitacaoProposta you send back in a counter-proposal.
cpfstringWorker CPF.
nome_trabalhadorstringWorker full name.
data_nascimentodate Y-m-dBirth date.
matriculastringEmployment registration.
inscricao_empregador_codigostringEmployer registration type code.
inscricao_empregador_descricaostringEmployer registration type (e.g. CNPJ).
numero_inscricao_empregadorstringEmployer registration number.
data_admissaodate Y-m-dHire date.
valor_liberadodecimal stringAmount available for the loan.
nro_parcelasstring (int)Number of installments offered.
data_hora_validade_solicitacaodatetimeRequest validity deadline.
margem_disponiveldecimal stringAvailable margin.
elegivel_emprestimoY/NLoan-eligible.
pessoa_exposta_politicamente_codigostringPEP code.
pessoa_exposta_politicamente_descricaostringPEP description.
tem_garantiasY/NWhether the lead has an FGTS guarantee. Drives the temGarantias flag you must send.
valor_saldo_disponivel_garantia_fgtsdecimal string | nullFGTS available balance (null when no guarantee).
valor_multa_rescisoria_garantia_fgtsdecimal string | nullFGTS termination penalty (null when no guarantee).
perc_verba_rescisoria_garantiadecimal string | nullTermination allowance % (null when no guarantee).
statusstringLead status — reservado when delivered to you.
expires_atdatetimeWhen the lead itself expires (Dataprev validity).
reservado_atedatetimeWhen your reservation expires and the lead returns to the pool.
Query Params
int32

How many leads to reserve. Defaults to 500; capped at the per-request limit and at your remaining quota.

string
enum

Filter: only leads with/without FGTS guarantee.

Allowed:
string
enum

Filter: loan-eligible leads.

Allowed:
string

Filter by CPF.

string
enum

Filter: only leads that carry alerts.

Allowed:
Headers
string
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json