Solicitar relatório AgRisk

POST

/clients/client-report

Solicita a criação do relatório (pdf) AgRisk na API. Este procedimento é assíncrono, portanto a resposta (201 - created) não indica que o relatório está FINALIZADO. Requer autenticação via Bearer JWT ou header x-api-key. O corpo da requisição (application/json) contém os campos esperados pelo endpoint.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201

application/json

Inferred 201 (from source code)

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/clients/client-report' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "clientIds": [
        "string"
    ],
    "path": "personalizado",
    "modules": [
        "basic_data:score",
        "basic_data:information",
        "basic_data:validations",
        "contacts:addresses",
        "contacts:emails",
        "contacts:phones",
        "sintegra:list",
        "family_group:list",
        "economic_group:list",
        "credit_restrictive:score",
        "credit_restrictive:resume",
        "credit_restrictive:appointments",
        "credit_restrictive:bad_checks",
        "credit_restrictive:past_queries",
        "credit_restrictive:partner_participation",
        "credit_restrictive:national_protests",
        "quod:score",
        "quod:resume",
        "quod:appointments",
        "bvs:score",
        "bvs:debts",
        "bvs:pastQueries",
        "protest:resume",
        "protest:list",
        "compliance:ibama",
        "compliance:icmbio",
        "compliance:sema",
        "compliance:labour",
        "compliance:criminal",
        "compliance:fiscal",
        "compliance:pep",
        "compliance:check_bioma",
        "lawsuit:resume",
        "lawsuit:list",
        "registered_warehouse:list",
        "vehicle_assets:resume",
        "vehicle_assets:list",
        "car:resume",
        "car:list",
        "registry_analysis:list",
        "rural_production:production",
        "rural_production:consolidated",
        "rural_properties:resume",
        "rural_properties:list",
        "urban_properties:resume",
        "urban_properties:list",
        "mobile_properties:resume",
        "mobile_properties:list",
        "financial:resume",
        "financial:list",
        "liabilities:resume",
        "liabilities:list"
    ],
    "companyName": ""
}'

Response Example

201 - Exemplo 1

{}

Modificado em 2026-10-13 09:47:06

Página anterior

Listar clientes da empresa

Próxima página

Consultar quantide de clientes por classificação