Paginação
GET /kyc/v1/dossiers devolve uma página de cada vez, com limit e offset. Listar não
consome cota.
| Parâmetro | Tipo | Padrão | Regra |
|---|---|---|---|
limit | inteiro | 50 | de 1 a 200 |
offset | inteiro | 0 | 0 ou mais |
A resposta traz a página e o total:
{
"items": [ { "id": "0b6f1c1e-…", "status": "vigente", "subtype": "kyc" } ],
"page": { "total": 137, "limit": 50, "offset": 0 }
}
Os números da paginação vêm dentro de page. page.total é o tamanho do conjunto inteiro que
casa com os filtros, não da página. Você terminou quando offset + len(items) >= page.total ou
quando items vem vazio.
Percorrer tudo
# página 1, 2, 3… avançando offset de limit em limit
curl -s "https://api.v3.zabit.com.br/kyc/v1/dossiers?limit=100&offset=0" -H "x-api-key: zbt_SUA_CHAVE"
curl -s "https://api.v3.zabit.com.br/kyc/v1/dossiers?limit=100&offset=100" -H "x-api-key: zbt_SUA_CHAVE"
Em código, veja o laço pronto em Exemplos.
A lista muda enquanto você pagina
Dossiês novos entram a qualquer momento. Para uma varredura consistente, fixe uma janela com
created_before (um instante anterior ao início da varredura) e pagine dentro dela.
Filtros
| Parâmetro | O que faz |
|---|---|
subtype | Recorta por tipo de KY (kyc, kye, kyp, kys ou o código configurado no workspace). |
q | Busca por documento ou nome. |
report_id | Um dossiê pelo id (uuid inteiro ou o começo dele). O que não casa devolve página vazia, nunca a lista inteira. |
created_after | Início da janela sobre a data de abertura (inclusivo), em ISO 8601. |
created_before | Fim da janela sobre a data de abertura (inclusivo), em ISO 8601. |
Parâmetro fora de faixa (por exemplo limit=500) devolve erro — veja Erros.