MOST Docs
Invoice Extraction [multipart/form-data]
POST/process-invoice/extractionLast modified: 4 months ago
:::info
Para garantir a extração adequada, recomendamos enviar arquivos contendo apenas uma página, pois a rota está otimizada para processar documentos fiscais de uma única página.
:::
Request
Header Params
Authorization
string
required
Token de autorização obtido no método user/authenticate
Example:
Bearer {{bearer_token}}
Body Params multipart/form-data
file
file
optional
🔸Requerido quando o parâmetro fileUrl não é informado.
Binário do arquivo a ser processado.
fileUrl
string
optional
🔸Requerido caso o arquivo enviado seja um PDF criptografado por senha.
A senha deve ser codificada em uma string base64, pois PDFs permitem que as senhas sejam dados binários.
Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
result
array [object {3}] | null
optional
Lista contendo o resultado do método.
score
number <float> | null
optional
Grau de confiabilidade de que o valor encontrado é o correto.
tags
array[string] | null
optional
Lista de tags relacionadas a imagem. As tags são um conjunto de identificadores que caracterizam a classe ou tipo daquela imagem.
extractions
array [object {3}] | null
optional
Lista contendo objetos do tipo source ("official" e/ou "ocr"), fields e tables. Caso não haja automação compatível com o tipo de documento enviado no request, para a consulta de autenticidade, os objetos relacionados ao source "official" não serão retornados. IMPORTANTE: a ordem dos elementos não é garantida, é obrigatório utilizar o campo name como referência para encontrar os valores.
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.
message
string | null
required
Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.
code
string
required
Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.
errors
array [object {2}] | null
required
List of objects of type Error, format is variable.
ExampleSucesso
{
"result": [
{
"score": 1,
"tags": [
"id=bra-fiscal-document-1",
"language=pt-BR",
"std-type=fiscal-document",
"type=documento-fiscal"
],
"extractions": [
{
"source": "official",
"fields": [
{
"name": "autenticidade_nota",
"value": "1",
"score": 1
},
{
"name": "chave_acesso",
"value": "00000000000000000000000000000000000000000000",
"score": 1
},
{
"name": "chave_verificacao",
"value": "1XXX.2XXX.3XXX.4XXXX",
"score": 1
},
{
"name": "codigo_servico",
"value": "99.99",
"score": 1
},
{
"name": "cpf_cnpj",
"value": "99999999999999",
"score": 1
},
{
"name": "cpf_cnpj_prestador",
"value": "99999999999900",
"score": 1
},
{
"name": "data_emissao",
"value": "2020-08-07",
"score": 1
},
{
"name": "data_emissao_rps",
"value": null,
"score": 0
},
{
"name": "download",
"value": "PD94bWwg....",
"score": 1
},
{
"name": "download_mimetype",
"value": "application/xml",
"score": 1
},
{
"name": "email",
"value": "",
"score": 1
},
{
"name": "email_prestador",
"value": "contato@companyname.com",
"score": 1
},
{
"name": "endereco_bairro",
"value": "XXXXXXXXXXX",
"score": 1
},
{
"name": "endereco_bairro_prestador",
"value": "XXXXXXXXXXX",
"score": 1
},
{
"name": "endereco_cep",
"value": "99999-000",
"score": 1
},
{
"name": "endereco_cep_prestador",
"value": "99999-000",
"score": 1
},
{
"name": "endereco_complemento",
"value": "CONJ 9999",
"score": 1
},
{
"name": "endereco_complemento_prestador",
"value": null,
"score": 0
},
{
"name": "endereco_logradouro",
"value": "XXXXXXXXXXX",
"score": 1
},
{
"name": "endereco_logradouro_prestador",
"value": "XXXXXXXXXXX",
"score": 1
},
{
"name": "endereco_municipio",
"value": "XXXXX XXXXXX",
"score": 1
},
{
"name": "endereco_municipio_prestador",
"value": "XXXXX XXXXXX",
"score": 1
},
{
"name": "endereco_numero",
"value": "100",
"score": 1
},
{
"name": "endereco_numero_prestador",
"value": "999",
"score": 1
},
{
"name": "endereco_pais",
"value": "Brasil",
"score": 1
},
{
"name": "endereco_pais_prestador",
"value": "Brasil",
"score": 1
},
{
"name": "endereco_uf",
"value": "XX",
"score": 1
},
{
"name": "endereco_uf_prestador",
"value": "XX",
"score": 1
},
{
"name": "exigibilidade_iss",
"value": "1",
"score": 1
},
{
"name": "inscricao_estadual",
"value": null,
"score": 0
},
{
"name": "inscricao_estadual_prestador",
"value": "99999",
"score": 1
},
{
"name": "iss_retido",
"value": "2",
"score": 1
},
{
"name": "local_prestacao_servico",
"value": "9999999",
"score": 1
},
{
"name": "nome",
"value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"score": 1
},
{
"name": "nome_fantasia_prestador",
"value": null,
"score": 0
},
{
"name": "nome_prestador",
"value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"score": 1
},
{
"name": "numero_nota_fiscal",
"value": "9999",
"score": 1
},
{
"name": "numero_rps",
"value": null,
"score": 0
},
{
"name": "outras_informacoes",
"value": null,
"score": 0
},
{
"name": "regime",
"value": "XXXXX",
"score": 1
},
{
"name": "serie",
"value": "XXXXX",
"score": 1
},
{
"name": "situacao",
"value": "",
"score": 1
},
{
"name": "situacao_data",
"value": "",
"score": 1
},
{
"name": "situacao_motivo",
"value": "",
"score": 1
},
{
"name": "situacao_tipo",
"value": "autorizada",
"score": 1
},
{
"name": "telefone",
"value": null,
"score": 1
},
{
"name": "telefone_prestador",
"value": "(99)999999999",
"score": 1
},
{
"name": "url",
"value": "https://www.prefeitura.uf.gov.br/documentos.action?senha=xxxx.xxxx.xxxx.xxxx",
"score": 1
},
{
"name": "valor_base_calculo",
"value": "1000.0",
"score": 1
},
{
"name": "valor_cofins",
"value": null,
"score": 0
},
{
"name": "valor_csll",
"value": null,
"score": 0
},
{
"name": "valor_deducoes",
"value": null,
"score": 0
},
{
"name": "valor_inss",
"value": null,
"score": 0
},
{
"name": "valor_irrf",
"value": null,
"score": 1
},
{
"name": "valor_iss",
"value": "50.00",
"score": 1
},
{
"name": "valor_liquido",
"value": "1000.0",
"score": 1
},
{
"name": "valor_pis",
"value": null,
"score": 0
}
],
"tables": [
{
"name": "tabela_servico",
"score": 1,
"headers": [
{
"name": "descricao_item",
"score": 1
},
{
"name": "codigo_servico_item",
"score": 1
},
{
"name": "aliquota_iss_item",
"score": 1
},
{
"name": "valor_unitario",
"score": 1
},
{
"name": "quantidade_item",
"score": 1
},
{
"name": "valor_servico",
"score": 1
}
],
"values": [
[
{
"name": "descricao_item",
"value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"score": 1
},
{
"name": "codigo_servico_item",
"value": "99.00",
"score": 1
},
{
"name": "aliquota_iss_item",
"value": "0.025",
"score": 1
},
{
"name": "valor_unitario",
"value": "1000.0",
"score": 1
},
{
"name": "quantidade_item",
"value": "1.0",
"score": 1
},
{
"name": "valor_servico",
"value": "1000.0",
"score": 1
}
]
]
}
]
},
{
"source": "iocr",
"fields": [
{
"name": "chave_verificacao",
"value": "1XXX.2XXX.3XXX.4XXXX",
"score": 1
},
{
"name": "cpf_cnpj",
"value": "99999999999999",
"score": 1
},
{
"name": "cpf_cnpj_prestador",
"value": "99999999999990",
"score": 1
},
{
"name": "data_emissao",
"value": "2020-08-07",
"score": 1
},
{
"name": "endereco",
"value": "XXXXXXXXXXX",
"score": 1
},
{
"name": "endereco_prestador",
"value": "XXXXXXXXXXX",
"score": 1
},
{
"name": "inscricao_municipal_prestador",
"value": "0000000000000000000000000",
"score": 1
},
{
"name": "municipio",
"value": "XXXXXX XXXXX",
"score": 1
},
{
"name": "municipio_prestador",
"value": "XXXXXXX XXXX",
"score": 1
},
{
"name": "nome",
"value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"score": 1
},
{
"name": "nome_prestador",
"value": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"score": 1
},
{
"name": "telefone_prestador",
"value": "+5599999999999",
"score": 1
},
{
"name": "valor_liquido",
"value": "1000.00",
"score": 1
},
{
"name": "valor_total_nota",
"value": "1000.00",
"score": 1
}
],
"tables": []
}
]
}
],
"requestId": "XXXXXXXXXXXXXXXXXXXXXX",
"elapsedMilliseconds": 5526,
"status": {
"message": "Success",
"code": "S100",
"errors": null
}
}Last modified: 4 months ago