Mail Items

{
  id: string;
  from: string;
  archivedAt: string;
  readAt: string;
  barcodeId: string;
  /**
   * @deprecated Use the `recipients` field to get the recipient information
   */
  businessRecipient: string;
  /**
   * @deprecated Use the `recipients` field to get the recipient information
   */
  individualRecipient: string;
  recipients: {
    line1: { text: string };
    line2?: { text: string };
    individual?: { id: string; firstName: string; lastName: string };
    business?: { id: string; name: string };
  };
  clearAt: string;
  imageUrl: string;
  ocrResultUrls: string[];
  location: Location;
  depositDetails: {
    trackingNumber: string;
    status: 'processing' | 'completed';
  }
  forwardDetails: {
    trackingNumber: string;
    cost: number;
    status: 'processing' | 'completed';
  }
  scanDetails: {
    imageUrl: string;
    status: 'processing' | 'completed';
    ocrResultUrls?: string[];
  }
  shredDetails: {
    status: 'processing' | 'completed';
  }
  checks: {
    id: string;
    amount: number;
    currency: string;
    payer?: string;
    payee?: string;
    checkNumber?: string;
    status: 'notRequested' | ' processing' | 'completed' | 'failed'
  }[],
  tags: {
    id: string;
    name: string;
    createdAt: string;
    assignedAt: string;
  }[],
}

Attributes

id string
Unique identifier for the object

from string
Who this piece of mail is from.

archivedAt string
When the piece of mail was archived.

barcodeId string
The unique Stable barcode associated with this piece of mail.

readAt string
When the piece of mail was read.

businessRecipient string
Deprecated. Use the recipients field to get the recipient information

individualRecipient string
Deprecated. Use the recipients field to get the recipient information

recipients object
The transcribed recipient information and any matched recipients.

clearAt string
When the piece of mail will be physically removed from storage.

imageUrl string
A temporary URL that renders an image of the mail item envelope.

ocrResultUrls Array<string>
A list of temporary URLs referencing OCR data from the outside of this piece of mail.

location Location
The location where this piece of mail was received.

depositDetailsobject
Additional information about the deposit of a check in this piece of mail.

forwardDetailsobject
Additional information about the forwarding of this piece of mail.

scanDetailsobject
Additional information about the internal document scan of this piece of mail.

shredDetailsobject
Additional information about the shredding of this piece of mail.

checksArray<object>
Additional information about checks contained in this piece of mail.

tagsArray<object>
A list of tags assigned to this piece of mail.