CFE-OCR Services

Web Service description

Classification and OCR of CFE files.

The service classifies and generates the OCR for a CFE file; this data is used to obtain the geolocation, delivering a JSON response to the obtained data.

~/api/OCRCfe

Parameters.

Tag	Type	Required	Description
cfeFile	file	yes	CFE image type .jpg, .jpeg, .png or .pdf
crossBr	bool	no	Indicates to ocr extract barcode data (default: false)

Headers.

Tag	Type	Required	Description
apikey	string	yes	Customer key.

FormData.

{
  "cfeFile": "file"
}

CURL

curl -X POST "~/api/OCRCfe?crossBr=false" \
  -H "accept: application/json" \
  -H "apikey: {YOUR_API_KEY}" \
  -H "Content-Type: multipart/form-data" \
  -F "cfeFile=@path_to_your_file"

Response.

Response:

Name	Type	Description
name	string	Name of the service owner
service	string	Number of service
address	string	Physical address of the property
rmu	string	rmu of the service owner
totalPay	string	Total cost to be paid on the receipt
paymentLimit	string	Payment deadline
cutoffDate	string	Service cut-off date
period	string	Period used for billing
rate	string	Consumer type tariff rate
rmu_bc	string	rmu in the barcode zone
barcode	string	barcode of the receipt
lat	float	The number of latitude
lng	float	The number of longitude
url	float	The url of geolocation
warnings	array	Array of objects with corresponding warnings

JSON.

  {
    "name": "",
    "service": "",
    "address": "",
    "rmu": "",
    "totalPay": "",
    "paymentLimit":"",
    "cutoffDate": "",
    "period": "",
    "rate": "",
    "rmu_bc": "",
    "barcode": "",
    "lat": 0.0,
    "lng": 0.0,
    "url": "",
    "warnings": [
      {
        "code": "string",
        "message": "string"
      }
    ]
  }

Service Messages.

Code	Message	Description
CFE001	file is required	file is required
CFE002	Maximum allowed file size is 5mb	Maximum allowed file size is 5mb
CFE003	Something was wrong, We are working on the failure	Something was wrong, We are working on the failure
CFE004	Incorrect document	Incorrect document
CFE005	File upload error	File upload error
CFE006	Json decode error	Json decode error
CFE007	Invalid json response	Invalid json response
CFE008	Error processing PDF	Error processing PDF
CFE009	Error decoding image	Error decoding image
CFE012	Missing date of issue	Missing date of issue
CFE013	Error in geolocation configuration	Error in geolocation configuration
CFE014	No information was found for this address.	No information was found for this address.
CFE015	Connection failed	Connection failed
CFE016	error in decoding geolocation	error in decoding geolocation
CFE017	The service only accepts file extension pdf, jpg, jpeg, png	The service only accepts file extension pdf, jpg, jpeg, png
CFE018	The document is incomplete	The document is incomplete
CFE019	Geolocation Service Error	Geolocation Service Error
CFE020	Invalid address provided	Invalid address provided
CFE037	The CFE service is currently unavailable, please try again later.
CFE038	Service number from barcode does not match OCR service number.	The data in the barcode is inconsistent with the data obtained through OCR processing.
CFE039	Payment limit from barcode does not match OCR payment limit.	The data in the barcode is inconsistent with the data obtained through OCR processing.
CFE040	Total payment from barcode does not match OCR total payment.	The data in the barcode is inconsistent with the data obtained through OCR processing.
CFE041	Mismatch between RMU data and RMU Barcode.	The rmu field is inconsistent with the rmu_bc field
CFE042	No valid barcode found for cross-validation.	The barcode data could not be extracted, certain segments could not be read