- Introdução
- Consumindo a API
- Características da API
- Mensagens de Erro
- Material de Apoio
- Authentication
- Address Parsing
- Billing/DailySummary
- Content Classification
- Content Compare
- Content Extraction
- Content Extraction Async
- Content Extraction Distance
- Content Fullreader
- Enrichment
- Facematch
- Generative Content Extraction
- Image Properties
- Image Reporting - Continuous Improvement
- Invoice Extraction
- License Plate Recognition
- Liveness Detection
- Liveness Streaming
- MultiAddress Parsing
- MultiPage Content Extraction
- Payment Card Extraction
- Vio Extraction
Content Extraction [application/json]
POST
https://mostqiapi.com/process-image/content-extraction
ocriocrcontent extractiondoc extractionextração de dados
Last modified:2025-04-28 14:21:04
Request
Header Params
Authorization
string
required
Example:
Bearer {{bearer_token}}
Body Params application/json
fileBase64
string <base64>
optional
fileUrl
string
optional
filePassword
string <base64>
optional
A senha deve ser codificada em uma string base64 (RFC 4648), pois PDFs permitem que as senhas sejam dados binários.
returnImage
boolean
optional
Default:
false
returnedImageQuality
string
optional
>= 0 characters<= 100 characters
Default:
75
returnCrops
boolean
optional
Default:
false
returnMetadata
boolean
optional
metadata
, que inclui a leitura dos QRCodes presentes no documento, organizados dentro do objeto barcodes
.A extração de QRCodes será realizada para:
Default:
false
tags
array[string]
optional
Example
{
"fileBase64": "",
"fileUrl": "",
"filePassword":"",
"returnImage": false,
"returnedImageQuality" :"",
"returnCrops": false,
"returnMetadata": false,
"tags": [
""
]
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://mostqiapi.com/process-image/content-extraction' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
"fileBase64": "",
"fileUrl": "",
"filePassword":"",
"returnImage": false,
"returnedImageQuality" :"",
"returnCrops": false,
"returnMetadata": false,
"tags": [
""
]
}'
Responses
🟢200OK
application/json
Body
result
array [object {10}]
required
fields
array [object {4}] | null
field
image
string <base64> | null
optional
Match pattern:
RFC3548
score
number <float> | null
optional
>= 0<= 1
type
string | null
optional
pageNumber
integer | null
optional
tags
array[string] | null
optional
tables
array [object {5}] | null
table
crops
array [object {3}] | null
optional
stdType
string | null
optional
processType
string | null
optional
metadata
object
optional
barcodes
array [object {3}]
optional
requestId
string
required
elapsedMilliseconds
integer
required
status
object
required
code
string
required
message
string | null
required
errors
object | null
required
Examples
{ "result": [ { "fields": [ { "name": "num_registro", "stdName": null, "value": "7636377", "score": 1 }, { "name": "numero_registro", "stdName": null, "value": "7636377", "score": 1 }, { "name": "data_emissao", "stdName": null, "value": "2017-09-20", "score": 1 }, { "name": "data_expedicao", "stdName": null, "value": "2017-09-20", "score": 1 }, { "name": "data_validade", "stdName": null, "value": "2024-06-11", "score": 1 }, { "name": "nome", "stdName": null, "value": "JUNIOR CARDOSO VILARINO", "score": 0.75 }, { "name": "filiacao_2", "stdName": null, "value": "JOÃO CARLOS VILARINO", "score": 0.71 }, { "name": "filiacao_1", "stdName": null, "value": "MARIA OLIVEIRA CARDOSO", "score": 1 }, { "name": "naturalidade_uf", "stdName": null, "value": "MA", "score": 0.99 }, { "name": "naturalidade", "stdName": null, "value": "MA", "score": 0.99 }, { "name": "nacionalidade", "stdName": null, "value": "BR", "score": 0.99 }, { "name": "data_nascimento", "stdName": null, "value": "1986-05-16", "score": 1 }, { "name": "pis_pasep", "stdName": null, "value": "", "score": 0.99 }, { "name": "cpf", "stdName": null, "value": "55972690624", "score": 0.99 }, { "name": "tipo_sanguineo", "stdName": null, "value": "O+", "score": 0.99 }, { "name": "data_validade_amh", "stdName": null, "value": "Indeterminada", "score": 0.99 }, { "name": "categoria", "stdName": null, "value": "TERCEIRO SARGENTO", "score": 1 }, { "name": "documento_origem", "stdName": null, "value": "Cert Nasc LV 237 - FL 128 - Termo 212456 SÃO LUIS - MA", "score": 0.99 }, { "name": "doc_origem", "stdName": null, "value": "Cert. Nasc.: LV 237 - FL 128 - Termo 212456\nSÃO LUIS - MA", "score": 0.99 } ], "crops": [], "image": null, "score": 0.98, "type": "documento-pessoal", "stdType": "personal-document", "pageNumber": 1, "tags": [ "country=bra", "id=bra-rg-marinha-2", "language=pt-BR", "of=armed-forces", "of=military", "of=navy", "person=natural", "process-type=extraction", "region=back", "region=verso", "std-type=personal-document", "subtype=carteira-funcional", "subtype=functional-card", "subtype=identity", "subtype=rg", "type=documento-pessoal" ], "tables": [], "processType": "extraction" }, { "fields": [ { "name": "assinado", "stdName": null, "value": "1", "score": 0.94 }, { "name": "assinatura",
🟠400R101 A specified parameter is wrong
🟠400R130 Unsupported file format
🟠401R117 Invalid authorization data
🔴500E100 The request could not be processed
Modified at 2025-04-28 14:21:04