Vio Extraction [application/json]

NOTE

Ao enviar mais de um parâmetro para o método de consumo, através do formato [application/json], será considerada a seguinte ordem de prioridades:

qrCodeField

fileBase64

fileUrl

O resultado será retornado apenas para um parâmetro, sendo sempre o de maior prioridade.

Request

Header Params

Authorization

string

required

Token de autorização obtido no método Authentication/Authenticate

Example:

Bearer {{bearer_token}}

Body Params application/json

qrCodeField

string

optional

🔸Requerido quando os parâmetros fileBase64 ou fileUrl não são informados.
String contendo o valor codificado do qrcode VIO.

fileBase64

string <base64>

optional

🔸Requerido quando os parâmetros qrCodeField ou fileUrl não são informados.
Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC 4648 usando a codificação base64.

Match pattern:

RFC3548

fileUrl

string

optional

🔸Requerido quando os parâmetros qrCodeField ou fileBase64 não são informados.
URL pública do arquivo a ser processado.

filePassword

string <base64>

optional

🔸Requerido caso o arquivo enviado seja um PDF criptografado por senha.
A senha deve ser codificada em uma string base64 (RFC 4648), pois PDFs permitem que as senhas sejam dados binários.

Match pattern:

RFC3548

Example

{    
    "qrCodeField": "",
    "fileBase64": "",
    "fileUrl":"",
    "filePassword": ""
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200S100 Success

application/json

Body

result

array [object {4}] | null

optional

Lista contendo o resultado do método.

crops

array [object {3}]

optional

Lista contendo os recortes dos binários das imagens contidas em um documento tipificado, com a perspectiva corrigida, como recortes de foto, assinatura, código de barras e impressão digital. Consulte a lista de documentos lidos para visualizar todos os crops disponíveis.

fields

array [object {3}]

optional

Lista contendo cada um dos campos localizados no conteúdo. Há a possibilidade de não serem retornados campos (lista vazia) no caso em que um documento é apenas tipificado. Importante: A ordem dos elementos não é garantida, é obrigatório utilizar o campo name como referência para encontrar os valores.

pageNumber

integer

optional

Número da página na qual o conteúdo foi encontrado.

tags

array[string]

optional

Lista de tags relacionadas a imagem. As tags são um conjunto de identificadores que caracterizam a imagem e seus elementos.

requestId

string

required

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

Objeto contendo o código de status e a mensagem de resposta.

code

string

required

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

message

string | null

required

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

array [object {2}] | null

required

Lista de objetos do tipo Error, o formato é variável.

Example

{
    "result": [
        {
            "crops": [
                {
                    "name": "foto",
                    "value": "iVBORw0KGg9AABBANSUhERgAAAUiogFIIWM2f3z8+vC1Jj...."
                }
            ],
            "fields": [
                {
                    "name": "nome",
                    "score": 1,
                    "value": "PAULO LIMA DOS SANTOS"
                },
                {
                    "name": "rg",
                    "score": 1,
                    "value": "MG11111111 SSP MG"
                },
                {
                    "name": "cpf",
                    "score": 1,
                    "value": "43944172019"
                },
                {
                    "name": "data_nascimento",
                    "score": 1,
                    "value": "1974-10-23"
                },
                {
                    "name": "filiacao_2",
                    "score": 1,
                    "value": "FELISBERTO JOAO DOS SANTOS"
                },
                {
                    "name": "filiacao_1",
                    "score": 1,
                    "value": "FELIX PEIREIA DE SOUSA SANTOS"
                },
                {
                    "name": "permissao",
                    "score": 1,
                    "value": "0"
                },
                {
                    "name": "acc",
                    "score": 1,
                    "value": ""
                },
                {
                    "name": "cat_hab",
                    "score": 1,
                    "value": "B"
                },
                {
                    "name": "registro",
                    "score": 1,
                    "value": "13284365385"
                },
                {
                    "name": "data_validade",
                    "score": 1,
                    "value": "2023-07-27"
                },
                {
                    "name": "data_primeira_habilitacao",
                    "score": 1,
                    "value": "2004-09-15"
                },
                {
                    "name": "observacoes",
                    "score": 1,
                    "value": "99"
                },
                {
                    "name": "local_uf",
                    "score": 1,
                    "value": "MG"
                },
                {
                    "name": "data_emissao",
                    "score": 1,
                    "value": "2021-10-06"
                },
                {
                    "name": "codigo_seguranca",
                    "score": 1,
                    "value": "06919786843"
                },
                {
                    "name": "renach",
                    "score": 1,
                    "value": "MG65225188"
                },
                {
                    "name": "local_cidade",
                    "score": 1,
                    "value": "NOVA LIMA"
                }
            ],
            "pageNumber": 1,
            "tags": [
                "country=bra",
                "subtype=cnh",
                "subtype=driving-license"
            ]
        }
    ],
    "requestId": "ePTBwhDSDRkitB1lf3WRRU",
    "elapsedMilliseconds": 476,
    "status": {
        "message": "Success",
        "code": "S100",
        "errors": null
    }
}

🟠401R117 Invalid authorization data

🟠400R101 A specified parameter is wrong

🟠400R130 Unsupported file format

🔴500E100 The request could not be processed