Manual de Consulta e Laudo de Motoristas Autônomos - VX Consult

VERSÃO 04/12/2025

Status de Pesquisa:

URL base:

https://api-hml.vxconsult.com.br/


🔎 Busca de Pesquisas do Motorista por CPF:

[POST] /api/users-permissions/consultar


Campo (JSON):

cpf


Exemplo 1️⃣:


                {
                    "cpf": "378.304.448-03"
                }

Exemplo de resposta 1️⃣:


                {
                "data": {
                "pesquisas": [
                    {
                        "id": "189371",
                        "cpf": "378.304.448-03",
                        "data_pesquisa": "2025-05-22T15:38:12-03:00",
                        "autorizacao_s3":
                        "https://s3.sa-east-1.amazonaws.com/vx-consult-bucket-plataforma/pesquisas/autorizacao-189371.pdf",
                        "status": "Concluído",
                        "cavalo_placa": "AAA0000",
                        "carreta1_placa": null,
                        "carreta2_placa": null,
                        "carreta3_placa": null,
                        "perfil": "Autônomo",
                        "validade": "2025-08-21T15:38:12-03:00",
                        "dentro_validade": true,
                        "dias_expirar": 7862400000,
                        "pagina_renova": "https://plataforma.vxconsult.com.br/cliente/pesquisa-view.php?p=189371"
                    },
                    {
                        "id": "189371",
                        "cpf": "378.304.448-03",
                        "data_pesquisa": "2025-05-22T15:38:12-03:00",
                        "autorizacao_s3":
                        "https://s3.sa-east-1.amazonaws.com/vx-consult-bucket-plataforma/pesquisas/autorizacao-189371.pdf",
                        "status": "Concluído",
                        "cavalo_placa": "AAA0000",
                        "carreta1_placa": "",
                        "carreta2_placa": null,
                        "carreta3_placa": null,
                        "perfil": "Autônomo",
                        "validade": "2025-08-21T15:38:12-03:00",
                        "dentro_validade": true,
                        "dias_expirar": 7862400000,
                        "pagina_renova": "https://plataforma.vxconsult.com.br/cliente/pesquisa-view.php?p=189371"
                    },
                    {
                        "id": "189371",
                        "cpf": "378.304.448-03",
                        "data_pesquisa": "2025-05-22T15:38:12-03:00",
                        "autorizacao_s3":
                        "https://s3.sa-east-1.amazonaws.com/vx-consult-bucket-plataforma/pesquisas/autorizacao-189371.pdf",
                        "status": "Concluído",
                        "cavalo_placa": "AAA0000",
                        "carreta1_placa": "",
                        "carreta2_placa": "",
                        "carreta3_placa": null,
                        "perfil": "Autônomo",
                        "validade": "2025-08-21T15:38:12-03:00",
                        "dentro_validade": true,
                        "dias_expirar": 7862400000,
                        "pagina_renova": "https://plataforma.vxconsult.com.br/cliente/pesquisa-view.php?p=189371"
                    },
                    {
                        "id": "189371",
                        "cpf": "378.304.448-03",
                        "data_pesquisa": "2025-05-22T15:38:12-03:00",
                        "autorizacao_s3":
                        "https://s3.sa-east-1.amazonaws.com/vx-consult-bucket-plataforma/pesquisas/autorizacao-189371.pdf",
                        "status": "Concluído",
                        "cavalo_placa": "AAA0000",
                        "carreta1_placa": "",
                        "carreta2_placa": "",
                        "carreta3_placa": "",
                        "perfil": "Autônomo",
                        "validade": "2025-08-21T15:38:12-03:00",
                        "dentro_validade": true,
                        "dias_expirar": 7862400000,
                        "pagina_renova": "https://plataforma.vxconsult.com.br/cliente/pesquisa-view.php?p=189371"
                    },
                    {
                        "id": "188473",
                        "cpf": "378.304.448-03",
                        "data_pesquisa": "2024-08-08T15:53:37-03:00",
                        "autorizacao_s3":
                        "https://s3.sa-east-1.amazonaws.com/vx-consult-bucket-plataforma/pesquisas/autorizacao-188473.pdf",
                        "status": "Concluído",
                        "cavalo_placa": null,
                        "carreta1_placa": null,
                        "carreta2_placa": null,
                        "carreta3_placa": null,
                        "perfil": "Autônomo",
                        "validade": "2024-11-07T15:53:37-03:00",
                        "dentro_validade": false,
                        "dias_expirar": 7862400000,
                        "pagina_renova": "https://plataforma.vxconsult.com.br/cliente/pesquisa-view.php?p=188473"
                    },
                    {
                        "id": "188325",
                        "cpf": "378.304.448-03",
                        "data_pesquisa": "2024-07-31T16:01:46-03:00",
                        "autorizacao_s3":
                        "https://s3.sa-east-1.amazonaws.com/vx-consult-bucket-plataforma/pesquisas/autorizacao-188325.pdf",
                        "status": "Concluído",
                        "cavalo_placa": null,
                        "carreta1_placa": "GFY1G86",
                        "carreta2_placa": "GFY1G86",
                        "carreta3_placa": null,
                        "perfil": "Autônomo",
                        "validade": "2024-10-30T16:01:46-03:00",
                        "dentro_validade": false,
                        "dias_expirar": 7862400000,
                        "pagina_renova": "https://plataforma.vxconsult.com.br/cliente/pesquisa-view.php?p=188325"
                    }
                ]
                    },
                        "message": "Pesquisa encontrada"
                    }

🔽 É possível filtrar as pesquisas com esse CPF incluindo as placas a serem buscadas:

Exemplo 2️⃣:


                {
                    "cpf": "378.304.448-03",
                    "placas": ["AAA0000"]
                }

Exemplo de resposta 2️⃣:


                {
            "data": {
            "pesquisas": [
                    {
                    "id": "189371",
                    "cpf": "378.304.448-03",
                    "data_pesquisa": "2025-05-22T15:38:12-03:00",
                    "autorizacao_s3":
                    "https://s3.sa-east-1.amazonaws.com/vx-consult-bucket-plataforma/pesquisas/autorizacao-189371.pdf",
                    "status": "Concluído",
                    "cavalo_placa": "AAA0000",
                    "carreta1_placa": "",
                    "carreta2_placa": "",
                    "carreta3_placa": "",
                    "perfil": "Autônomo",
                    "validade": "2025-08-21T15:38:12-03:00",
                    "dentro_validade": true,
                    "temporario": false,
                    "pagina_renova": "https://plataforma.vxconsult.com.br/cliente/pesquisa-view.php?p=189371"
                    }
                    ]
                },
                    "message": "Pesquisa encontrada"
                }


🖥️ Gerar Nova Consulta e Retornar o Laudo:

[POST] /api/users-permissions/gerarLaudoConsulta


Corpo (JSON) pesquisa: ID da pesquisa:


                {
                    "pesquisa": "188473"
                }

Exemplo de resposta (sucesso):


                {
                    "consulta": "181962",
                    "laudo":
                    "https://s3.sa-east-1.amazonaws.com/vx-consult-bucket-plataforma/consulta/autorizacao-consulta-181962.pdf",
                    "validade": "2025-11-15T15:44:12-03:00"
                }

Exemplo de resposta (erro - pesquisa invalida ou pesquisa fora da data):


                {
                    "data": null,
                    "error": 
                        {
                            "status": 400,
                            "name": "BadRequestError",
                            "message": "Nenhuma pesquisa válida encontrada para pesquisa 1893711",
                            "details": {}
                        }
                }


♻️ Renovar pesquisa:

[POST] /api/users-permissions/renovarPesquisa


Corpo de requisição (pesquisa precisa ser um ID válido, retornado depois de consultar o CPF)


                {
                    "pesquisa": "189371"
                }

Exemplo de requisição (sucesso):


                {
                    "pesquisa": "207573",
                    "pesquisaURL": "url",
                    "message": "Pesquisa renovada com sucesso!"
                }

Exemplo de requisição (ID de pesquisa não encontrada):


                {
                    "data": null,
                    "error": {
                    "status": 400,
                    "name": "BadRequestError",
                    "message": "Pesquisa não encontrada",
                    "details": {}
                    }
                }

🔎 Buscar padrão de pesquisa:

[GET] /api/users-permissions/buscaPadraoPesquisa


Exemplo de resposta:


                {
                            "padrao": [
                        {
                            "id": "522",
                            "titulo": "Básica"
                        },
                        {
                            "id": "523",
                            "titulo": "Completa"
                        },
                        {
                            "id": "524",
                            "titulo": "Completa RDO"
                        }
                    ]
                }


🚚 Criar pesquisa (até 3 carretas para cada pesquisa):

[POST] /api/users-permissions/criarPesquisa


Enviar:

Padrão => ID de um padrão válido retornado em


                    buscaPadraoPesquisa

Tipo_motorista:


                1: Autonomo
                2: RH
                3: Frota
                4: Agregado


Exemplo de requisição:


                {
                "padrao": "524",
                "tipo_motorista": "1",
                "motorista": {
                    "nome_completo": "TESTE CELSO",
                    "cpf": "37830444803",
                    "rg": "1234250123",
                    "cnh": "02513123254",
                    "cep": "99240000",
                    "logradouro": "Distrito d Santa Barbara ",
                    "numero": "1",
                    "complemento": "",
                    "bairro": "Interior ",
                    "cidade": "São Valentim do Sul",
                    "estado": "RS",
                    "telefone_residencial": "Vagner trentin ",
                    "telefone_residencial_contato": "54999138845",
                    "telefone_comercial": "",
                    "telefone_comercial_contato": "",
                    "telefone_referencia": "",
                    "telefone_referencia_contato": "(54) 99658-1956"
                },
                "cavalo": {
                    "nome_proprietario": "TRANS ETC LTDA",
                    "rntc_proprietario": "0310204500",
                    "cpf_cnpj_proprietario": "31.701.111/0001-02",
                    "telefone_residencial_proprietario": "Etc ",
                    "telefone_residencial_contato_proprietario": "(54) 98125-7772",
                    "telefone_comercial_proprietario": "Abc ",
                    "telefone_comercial_contato_proprietario": "(54) 98125-7772",
                    "placa": "AAA0A00"
                },
                "carretas": [
                    {
                    "nome_proprietario": "TRANS ETC LTDA",
                    "rntc_proprietario": "0310204500",
                    "cpf_cnpj_proprietario": "31.701.111/0001-02",
                    "telefone_residencial_proprietario": "Etc ",
                    "telefone_residencial_contato_proprietario": "(54) 98125-7772",
                    "telefone_comercial_proprietario": "Abc ",
                    "telefone_comercial_contato_proprietario": "(54) 98125-7772",
                    "placa": "AAA0A00"
                    }
                ],
                "arquivos": [
                    {
                    "title": "Comprovante de Endereco",
                    "path": "URL_PUBLIC"
                    },
                    {
                    "title": "CNH",
                    "path": "URL_PUBLIC"
                    },
                    {
                    "title": "Veículo",
                    "path": "URL_PUBLIC"
                    },
                    {
                    "title": "Documento Cavalo",
                    "path": "URL_PUBLIC"
                    },
                    {
                    "title": "Documento Carreta",
                    "path": "URL_PUBLIC"
                    }
                ]
                }


Exemplo de sucesso:


                {
                    "pesquisa": "901444",
                    "message": "Pesquisa criada com sucesso"
                }


Exemplo de falha:


                {
                    "pesquisa": false,
                    "message": "Erro: motorista já com pesquisa ativa"
                }


💻 Acompanhamento de pesquisa ativa:

[POST] api/users-permissions/pesquisaAtiva


Exemplo de requisição:


                {
	                "pesquisa": "207735"
                }


Exemplo de resposta:


                {
                    "pesquisa": {
                        "id": "207735",
                        "cpf": "378.304.448-03",
                        "data_pesquisa": "1751054896",
                        "autorizacao_s3": null,
                        "status": "Em Análise",
                        "tipo": "1",
                        "cavalo_placa": "AAA0A00",
                        "carreta1_placa": "AAA0A00",
                        "carreta2_placa": "AAA0A00",
                        "carreta3_placa": "AAA0A00",
                        "perfil": "Autônomo"
                        "data": "2025-05-22T15:38:12-03:00"
                        "data_validade": "2025-12-25T15:44:12-03:00"
                    }
                }


Exemplo de resposta (erro):


                {
                    "pesquisa": false,
                    "message": "Pesquisa inexistente"
                }


#️⃣ Upload Base64:

[POST] /api/users-permissions/uploadBase64


Exemplo de requisição:


                {
	                "fileName": "Teste",
	                "mimeType": "image/png",
	                "file": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAM"
                }
fileName -> Nome do arquivo
mimeType -> mime type
file -> dados em base64 sem o mime / base64 (apenas dados depois da vírgula)


Exemplo de resposta:


                {
                    "url": "https://vx-consult-bucket-plataforma.s3.sa-east-1.amazonaws.com/strapi/Teste_226a6c477d.png"
                }


Exemplo de resposta (erro):


                {
                    "data": null,
                    "error": {
                        "status": 400,
                        "name": "BadRequestError",
                        "message": "Por favor enviar o parâmetro mimeType",
                        "details": {}
	                }
                }