Solicitar consultas

POST

/queries/

Solicita consultas para um ou mais clientes (clients) nos produtos escolhidos (products), disparando as buscas nas fontes de dados correspondentes. Retorna a consulta criada com o status inicial de cada serviço, agrupado por produto. Requer autenticação via Bearer JWT ou header x-api-key.

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

Harvested 201

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/queries/' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "clients": [
        "string"
    ],
    "products": [
        "string"
    ]
}'

Response Example

201 - Sucesso

{
    "items": [
        {
            "id": "3bfaab5f-7586-4db2-8d6f-7d173eff1912",
            "queryId": "452e3904-309a-4b40-b6c1-656f7489714d",
            "queries": {
                "dados-basicos": [
                    {
                        "queryId": "452e3904-309a-4b40-b6c1-656f7489714d",
                        "status": "FINALIZADO",
                        "createdAt": "2026-06-18T13:11:10.349Z",
                        "completedAt": "2026-06-18T13:11:12.940Z",
                        "requestedBy": {
                            "id": "string",
                            "name": "string"
                        },
                        "taxId": "***********"
                    }
                ]
            }
        }
    ]
}

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

Página anterior

Enviar matrícula para análise e vincular a um contrato

Próxima página

Listar consultas mais recentes de um cliente