Skip to main content
[POST]
{{baseUrl}}/api/v1/document/analysis/utility_bill
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
AuthorizationstringPrivate/secret key. Use <key> not Bearer <key>

Body parameter

ParameterTypeDescriptionRequired
input_typestringurl, defaults to urlrequired
input_valuestringImage URL of the Utility Billrequired

Response

Response
{
    "entity": {
        "result": {
            "status": "success",
            "message": ""
        },
        "identity_info": {
            "full_name": "JOHN DOE",
            "meter_number": "SBX12345678"
        },
        "address_info": {
            "street": "123 Sandbox Street SBX001",
            "city": "Testville",
            "state": "SB",
            "country": "Sandbox Country"
        },
        "provider_name": "Sandbox Power Company",
        "bill_issue_date": "2025-01-15",
        "amount_paid": "100",
        "metadata": {
            "extraction_date": "2025-08-15T00:00:00.000Z",
            "is_recent": true
        }
    }
}

Response Fields

FieldTypeDescription
entityobjectContains the response data
entity.resultobjectOperation result status
entity.result.statusstringProcessing status (e.g., success)
entity.result.messagestringAdditional status message, empty on success
entity.identity_infoobjectIdentity information extracted from the utility bill
entity.identity_info.full_namestringFull name of the account holder
entity.identity_info.meter_numberstringMeter or account number on the bill
entity.address_infoobjectAddress information extracted from the utility bill
entity.address_info.streetstringStreet address
entity.address_info.citystringCity name
entity.address_info.statestringState or province
entity.address_info.countrystringCountry name
entity.provider_namestringName of the utility service provider
entity.bill_issue_datestringDate the bill was issued (YYYY-MM-DD format)
entity.amount_paidstringAmount paid on the bill
entity.metadataobjectAdditional extraction metadata
entity.metadata.extraction_datestringTimestamp of when the data was extracted (ISO 8601 format)
entity.metadata.is_recentbooleanWhether the bill is considered recent