Documentation
Log inGet started

US US Mail OCR PHP

Suggest Edits

The PHP OCR SDK supports the US Mail API.

Using the sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.
US Mail sample

Quick-Start

<?php

use Mindee\Client;
use Mindee\Product\Us\UsMail\UsMailV2;

// Init a new client
$mindeeClient = new Client("my-api-key");

// Load a file from disk
$inputSource = $mindeeClient->sourceFromPath("/path/to/the/file.ext");

// Parse the file asynchronously
$apiResponse = $mindeeClient->enqueueAndParse(UsMailV2::class, $inputSource);

echo $apiResponse->document;

Output (RST):

:Sender Name: zed
:Sender Address:
  :City: Dallas
  :Complete Address: 54321 Elm Street, Dallas, Texas 54321
  :Postal Code: 54321
  :State: TX
  :Street: 54321 Elm Street
:Recipient Names: Jane Doe
:Recipient Addresses:
  +-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+
  | City            | Complete Address                    | Is Address Change | Postal Code | Private Mailbox Number | State | Street                    |
  +=================+=====================================+===================+=============+========================+=======+===========================+
  | Detroit         | 1234 Market Street PMB 4321, Det... |                   | 12345       | 4321                   | MI    | 1234 Market Street        |
  +-----------------+-------------------------------------+-------------------+-------------+------------------------+-------+---------------------------+

Field Types

Standard Fields

These fields are generic and used in several products.

BaseField

Each prediction object contains a set of fields that inherit from the generic BaseField class.
A typical BaseField object will have the following attributes:

  • value (float|string): corresponds to the field value. Can be null if no value was extracted.
  • confidence (float): the confidence score of the field prediction.
  • boundingBox ([Point, Point, Point, Point]): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
  • polygon (Point[]): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.
  • pageId (integer): the ID of the page, always null when at document-level.
  • reconstructed (bool): indicates whether an object was reconstructed (not extracted as the API gave it).

Note: A Point simply refers to a list of two numbers ([float, float]).

Aside from the previous attributes, all basic fields have access to a custom __toString method that can be used to print their value as a string.

StringField

The text field StringField implements the following:

  • value (string): represents the value of the field as a string.
  • rawValue (string): the value of the string as it appears on the document.

Specific Fields

Fields which are specific to this product; they are not used in any other product.

Recipient Addresses Field

The addresses of the recipients.

A UsMailV2RecipientAddress implements the following attributes:

  • city (string): The city of the recipient's address.
  • complete (string): The complete address of the recipient.
  • isAddressChange (bool): Indicates if the recipient's address is a change of address.
  • postalCode (string): The postal code of the recipient's address.
  • privateMailboxNumber (string): The private mailbox number of the recipient's address.
  • state (string): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
  • street (string): The street of the recipient's address.
    Fields which are specific to this product; they are not used in any other product.

Sender Address Field

The address of the sender.

A UsMailV2SenderAddress implements the following attributes:

  • city (string): The city of the sender's address.
  • complete (string): The complete address of the sender.
  • postalCode (string): The postal code of the sender's address.
  • state (string): Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
  • street (string): The street of the sender's address.

Attributes

The following fields are extracted for US Mail V2:

Recipient Addresses

recipientAddresses ([UsMailV2RecipientAddress]): The addresses of the recipients.

foreach ($result->document->inference->prediction->recipientAddresses as $recipientAddressesElem)
{
    echo $recipientAddressesElem->value;
}

Recipient Names

recipientNames : The names of the recipients.

foreach ($result->document->inference->prediction->recipientNames as $recipientNamesElem)
{
    echo $recipientNamesElem->value;
}

Sender Address

senderAddress (UsMailV2SenderAddress): The address of the sender.

echo $result->document->inference->prediction->senderAddress->value;

Sender Name

senderName : The name of the sender.

echo $result->document->inference->prediction->senderName->value;

Questions?

Join our Slack

Updated 2 months ago