Payment Card Extraction [application/json]

Request

Header Params

Authorization

string

required

Token de autorização obtido no método user/authenticate.

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string <base64>

optional

🔸Requerido quando o parâmetro fileUrl não é informado. Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC 4648, usando a codificação base64.

fileUrl

string

optional

🔸Requerido quando o parâmetro fileBase64 não é informado. 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.

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

result

array [object {3}]

optional

Lista contendo o resultado do método (consulte na documentação específica de cada um).

type

string

required

Atributo que retorna o tipo de conteúdo identificado. Ex: documento pessoal, certidão, etc.

stdType

string

required

Tipo padronizado do documento identificado (certificate, etc.).

extractions

array [object {4}]

optional

Lista que contém objeto com informações detalhadas extraídas do documento.

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 e mensagem de status da resposta.

message

string | null

optional

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

code

string

required

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

errors

object | null

required

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

Example

{
  "result": [
    {
      "type": "payment-card",
      "stdType": "payment-card",
      "extractions": [
        {
          "source": "iocr",
          "score": 0.9,
          "tags": [
            "id=zzz-payment-card-1",
            "std-type=payment-card",
            "type=payment-card"
          ],
          "sections": [
            {
              "name": "payment_card",
              "stdName": "payment_card",
              "score": 0.9,
              "fields": [
                {
                  "name": "number",
                  "stdName": "number",
                  "value": "2221222134120012",
                  "score": 0.9
                },
                {
                  "name": "network",
                  "stdName": "network",
                  "value": "mastercard",
                  "score": 0.9
                },
                {
                  "name": "expiry_month",
                  "stdName": "expiry_month",
                  "value": "1998-06",
                  "score": 0.84
                }
              ],
              "tables": []
            }
          ]
        }
      ]
    }
  ],
  "requestId": "iW5V7X96Vb2FzWvf385Nk",
  "elapsedMilliseconds": 7070,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠400R101 A specified parameter is wrong

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed