Vio Extraction [application/json]

Note: When sending more than one parameter to the consumption method, using the [application/json] format, the following priority order will be considered:

1. qrCodeField

2. fileBase64

3. fileUrl

The result will be returned for one parameter only, always the one with the highest priority.

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method.

Example:

Bearer {{bearer_token}}

Body Params application/json

qrCodeField

string

optional

Required, when fileBase64 or fileUrl parameters are not provided | String containing the encoded value of the VIO QR code.

fileBase64

string <base64>

optional

Required, when qrCodeField or fileUrl parameters are not provided | Binary of the file to be processed, encoded in a text string according to the RFC3548 standard using base64 encoding.

Match pattern:

RFC3548

fileUrl

string

optional

Required, , when qrCodeField or fileBase64 parameters are not provided | Public URL of the file to be processed.

filePassword

string <base64>

optional

Password encoded in a base64 string, as PDFs allow passwords to be binary data.

Match pattern:

RFC3548

Example

{
  "qrCodeField": "",
  "fileBase64": "",
  "fileUrl": "",
  "returnCrops": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

⚪0200 Ok Sync

application/json

Body

result

array [object {4}]

required

crops

array [object {2}]

optional

fields

array [object {3}]

optional

pageNumber

integer

optional

tags

array[string]

optional

requestId

string

required

elapsedMilliseconds

integer

required

status

object

required

message

string

required

code

string

required

errors

null

required

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": "Ok",
    "code": "201",
    "errors": null
  }
}