The businesses can use this to digitally extract data from the scanned copy of invoices.

Journey Input Data

{
    "journey_id": "pan_digital_tvs_credit_v1",
    "transaction_id": "06ab79c5-ab8e-4eba-b6d6-1e66d3003191",
    "input_data": {
        "invoice_url": "",
        "invoice_base64": ""
    }
}

Journey Output Data

{
  "transaction_id": "",
  "journey_transaction_id": "",
  "journey_id": "",
  "status": "SUCCESS|FAILURE|IN_PROGRESS",
  "status_code": "Refer to the table below",
  "message": "Refer to the table below",
  "decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
  "checks": [],
  "data": {
    "keys": {
      "invoice_data": [
        {
          "customer_name": "John Doe",
          "customer_address": "123 Main Street, City, State, ZIP",
          "customer_phone_number": "+1234567890",
          "invoice_number": "INV-001",
          "invoice_date": "2024-11-07",
          "retailer_name": "ABC Electronics",
          "retailer_address": "456 Market Road, City, State, ZIP",
          "retailer_mobile_number": "+0987654321",
          "retailer_gstin": "22AAAAA0000A1Z5",
          "cgst_amount": 50.00,
          "sgst_amount": 50.00,
          "invoice_amount_figures": 1100.00,
          "invoice_amount_text": "One Thousand One Hundred Only",
          "asset_list": [
            {
              "hsn_code": "1234",
              "type_of_asset": "Phone",
              "asset_brand": "OPPO",
              "quantity": 2,
              "model_number": "XYZ123",
              "imei_numbers": [
                "123456789012345",
                "123456789012346"
              ],
              "serial_number":"",
              "asset_cost": 500.00
            },
            {
              "hsn_code": "1234",
              "type_of_asset": "Phone",
              "asset_brand": "OPPO",
              "quantity": "2",
              "model_number": "XYZ123",
              "imei_numbers": [
                "123456789012345",
                "123456789012346"
              ],
              "serial_number":"",
              "asset_cost": "500.00"
            }
          ],
          "issuer": "",
          "decision": "",
          "checks": []
        }
      ]
    }
  }
}

📘

*Size of the image should be less than 2 MB.

*The supported formats for OCR input are JPG, JPEG and PNG.

📘
These journeys do not include any pre-configured Ownership or Fraud Checks. To add these checks, please contact your Account Manager.

Status Codes

Scenario	Http Status Code	status	status_code	message
When request is successful.	200	SUCCESS	success	Request successful
Invalid image	200	FAILURE	invalid_input	Invalid Image, please upload a valid image
Invalid Client Credentials	401	FAILURE	invalid_credentials	Invalid Client Credentials
Any unhandled error from Equal end	500	FAILURE	internal_server_error	Something went wrong, please try again.
Too many requests	429	No object will be sent, throttling happens at the gateway level.
Service Unavailable	503
Both formats(Base 64 and URL) are entered	400	FAILURE	invalid_request	Enter only one Base 64 or URL
None of the inputs (Base 64 or URL) provided	400	FAILURE	invalid_request	One of the inputs Base 64 or URL is required
Unsupported media types	400	FAILURE	invalid_request	Invalid file type, only PNG, JPG, and JPEG files are allowed
Image too large	400	FAILURE	invalid_request	File size exceeds the maximum limit of 2MB
Invalid Base 64	400	FAILURE	invalid_request	Invalid base64 content
Invalid URL	400	FAILURE	invalid_request	Invalid URL

Status (Journey Status)

Possible Values	Description
SUCCESS	Shows that the verification process was completed successfully.
FAILURE	Indicates that the verification process did not succeed.
IN_PROGRESS	Signifies that the verification process is currently underway and has not yet been completed.

Decision

Possible Values	Description
CLEAR	Indicates that the verification has been completed and the information is confirmed as accurate and legitimate.
MUST REVIEW	Signifies that further review is needed due to potential issues or inconsistencies in the verification results.
NEEDS REVIEW	Suggests that the verification has identified areas that require further investigation or clarification before a final determination can be made.

📘
Journey ID will be shared as part of Onboarding

Key Descriptions

Key	Description
transaction_id	Unique identifier for the transaction.
journey_transaction_id	Unique identifier for the journey transaction.
journey_id	Unique identifier for the journey.
status	Current status of the transaction. Possible values: SUCCESS, FAILURE, IN_PROGRESS.
status_code	Code representing the specific status of the transaction. Refer to the documentation for possible values.
message	Detailed message about the transaction status. Refer to the documentation for specific messages.
decision	Final decision based on all checks. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW.
checks	List of checks performed during the transaction.
data	Container for additional data related to the transaction.