OCR Sync

This service performs the OCR on the sent document and returns the extracted data in the same request.

Run synchronous OCR

Send images of an individual's document to get the data extracted by OCR.

post

/transactions

Header parameters

Authorizationstringrequired

Customer access token. See more in the 'Authentication' topic of this section.

Example: Bearer your_token_here

Body

templateobjectrequired

filesobject[]required

List of files to be analysed.

forceDocTypestring

Force the use of a specific template and skip the document type identification step, improving the request's response time. This must be the same value returned by the Document Detector SDK. Allowed values: cnh, cnh_new, rg, rg_new, rne, rnm, ctps, passport, crlv, crlv_new, cin.

Example: rg

returnSelectedImagesboolean

Whether or not to return 'images.selectedFront' and/or 'images.selectedBack' attributes as URLs to download processed images.

Example: false

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.combateafraude.com/v1/transactions' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "template": {
      "services": [
        "ocr_sync"
      ]
    },
    "files": [
      {
        "data": "https://my-image-name.jpg",
        "type": "FRONT",
        "mimeType": "image/jpeg"
      }
    ],
    "forceDocType": "rg",
    "returnSelectedImages": false
  }'

200

400

401

500

200

{
  "requestId": "6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9",
  "id": "6021a21b3811c35ecb8dea20",
  "type": "rg",
  "data": {
    "federativeUnit": "ESTADO DA BAHIA",
    "rg": "00.000.000-00",
    "via": "",
    "issueDate": "13/04/2015",
    "name": "JANE DOE",
    "fatherName": "JOHN DOE",
    "motherName": "MARIA DOE",
    "birthPlace": "JAGUAQUARA BA",
    "birthDate": "25/02/1952",
    "referenceDocument": "C.NAS. CM JAGUAQUARA BA",
    "cpf": "00000000000",
    "issueState": "BA",
    "issuingAuthority": "SSP",
    "rgIssuingAuthority": "SSP",
    "rgIssueState": "BA"
  }
}

Success