US Utility Bill Extraction

overview this api is designed to extract detailed addresses and basic account information associated with the bill from different utility and telecom bills in the united states utility bills are a common and reliable source for address verification, making this api help businesses requiring proof of residence for customer verification purposes usecase this api is primarily used for customer onboarding in sectors where proof of residence is required, such as banking, telecommunications, and rental services by automating the extraction of address data from utility and telecom bills, the api facilitates quicker customer verification processes and improves the accuracy of data capture api details request body production curl location 'https //api preproduction signzy app/api/v3/us api/utility bill extraction' \\ \ header 'content type application/json' \\ \ header 'authorization < auth token >' \\ \ data '{ "fileurl" "https //persist signzy tech/api/files/992527839/download/68148f24ch38bf74v7329bfe5e21deb3b22cdd141b29bc317239874b pdf" }' preproduction curl location 'https //api signzy app/api/v3/us api/utility bill extraction' \\ \ header 'content type application/json' \\ \ header 'authorization < auth token >' \\ \ data '{ "fileurl" "https //persist signzy tech/api/files/992527839/download/68148f24ch38bf74v7329bfe5e21deb3b22cdd141b29bc317239874b pdf" }' request body parameters input parameter data type description fileurl string the url where the utility or telecom bill pdf is stored for download response body { "result" { "name" "name string", "address" { "streetaddress" "street address string", "city" "city string", "state" "state string", "zipcode" "zip code string", "country" "country string" }, "billdate" "date string", "accountnumber" "account number string", "companyname" "company name string" } } response body parameters output parameter data type description name string the name of the individual or entity the bill is issued to address streetaddress string the street address as listed on the bill address city string the city as listed on the bill address state string the state as listed on the bill address zipcode string the postal zip code as listed on the bill address country string the country as listed on the bill billdate string the date the bill was issued accountnumber string the account number associated with the bill companyname string the name of the company issuing the bill error cases the api can encounter the following error cases invalid url if the fileurl provided does not link to a valid or accessible pdf document unsupported document type if the document at the fileurl is not a utility or telecom bill parsing error if the document's structure prevents data extraction service unavailability when the service is temporarily unavailable due to maintenance or unexpected outages error codes description http status code description 400 invalid url the url provided is malformed or inaccessible 400 unsupported document type the document is not a recognized utility or telecom bill format 401 invalid authentication credentials 503 service unavailability the extraction service is temporarily unavailable error code response & mapping 400(bad request) { "error" { "name" "error", "message" "password protected pdf files are not allowed", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } 400(bad request) { "error" { "name" "error", "message" "pdf of more than 10 pages are not allowed", "status" 400, "reason" "validation error", "type" "bad request", "statuscode" 400 } } 409(upstream down) { "error" { "name" "error", "message" "upstream down", "status" 409, "reason" "error", "type" "bad request", "statuscode" 409 } }