Callback | Estrutura

Nossa API de captura utiliza callback para retornar automaticamente o resultado de cada consulta realizada. No momento em que realizar uma nova consulta, basta informar uma url existente e válida no sistema do cliente. Caso a url seja inválida, inexistente ou estiver offline, nossa API retornará erro após atingir o máximo de tentativas de envio.

Quando utilizar o endpoint /autorequest, será gerado retorno de callback individuais para cada consulta gerada pela nossa API, retornando em tempos diferentes.

Exemplo

Atenção!

É o mesmo formato de um consulta individual.

callback

{
    "action": "requestStatusChanged",
    "requestId": "",
    "respondedAt": "2019-11-01T07:00:00.944Z",
    "status": "success"
}

Exemplo format allRequests

callback

{
    "action": "autoRequestFinished",
    "id": "0b3feca1-5235-4e45-a2d7-cc18fb77e33d",
    "respondedAt": "2025-07-27T16:00:01.125Z",
    "status": "finished",
    "data": {
        "id": "0b3feca1-5235-4e45-a2d7-cc18fb77e33d",
        "key": "cnj",
        "value": "1001077-15.2018.5.02.0002",
        "requests": [
            {
                "id": "f34589f6-c1d6-487d-9836-817d5e30d4b1",
                "status": "error",
                "source": "courts",
                "platform": "custom",
                "query": "principal",
                "court": "trt2",
                "search": "trt2",
                "uf": "SP",
                "param": {
                    "key": "cnj",
                    "value": "1001077-15.2018.5.02.0002"
                },
                "makeDownload": false,
                "respondedAt": "2025-07-27T15:59:34.624Z",
                "createdAt": "2025-07-27T15:59:30.240Z",
                "credentialId": "832363f6-bb49-4c39-af17-83e5b896e099",
                "credentials": false
            },
            {
                "id": "0352df42-c9cb-4cff-afe2-bfe235a6af6c",
                "status": "success",
                "source": "courts",
                "platform": "pje-jt-web",
                "query": "unificada",
                "court": "trt2",
                "search": "trt2",
                "uf": "SP",
                "param": {
                    "key": "cnj",
                    "value": "1001077-15.2018.5.02.0002"
                },
                "makeDownload": false,
                "respondedAt": "2025-07-27T15:59:53.615Z",
                "createdAt": "2025-07-27T15:59:30.240Z",
                "credentialId": "832363f6-bb49-4c39-af17-83e5b896e099",
                "credentials": false
            },
            {
                "id": "bc02f4d4-f866-42a6-ad12-2699081c4e91",
                "status": "success",
                "source": "courts",
                "platform": "pje-jt",
                "query": "unificada",
                "court": "trt2",
                "search": "trt2",
                "uf": "SP",
                "param": {
                    "key": "cnj",
                    "value": "1001077-15.2018.5.02.0002"
                },
                "makeDownload": false,
                "respondedAt": "2025-07-27T16:00:01.125Z",
                "createdAt": "2025-07-27T15:59:30.240Z",
                "credentialId": "832363f6-bb49-4c39-af17-83e5b896e099",
                "credentials": false
            },
            {
                "id": "755f8f20-489d-4b61-aa15-f6ac43c1b704",
                "status": "warning",
                "source": "courts",
                "platform": "superiores",
                "query": "unificada",
                "court": "stj",
                "search": "stj",
                "uf": "DF",
                "param": {
                    "key": "cnj",
                    "value": "1001077-15.2018.5.02.0002"
                },
                "makeDownload": false,
                "respondedAt": "2025-07-27T15:59:35.573Z",
                "createdAt": "2025-07-27T15:59:30.240Z",
                "credentialId": "832363f6-bb49-4c39-af17-83e5b896e099",
                "credentials": false
            }
        ],
        "createdAt": "2025-07-27T15:59:30.240Z"
    }
}