Skip to Content

The ForwardingDestination type of the TypeScript SDK, part of Forwarding.

type ForwardingDestination = {
  address: string
  codeExpiresAt: number | null
  createdAt: number
  id: string
  state: ('pending' | 'verified' | 'revoked_by_recipient')
  verifiedAt: number | null
}

Fields

FieldTypeDescription
addressstringThe destination address, lowercased
codeExpiresAtnumber | nullWhen the outstanding confirmation code expires, in epoch seconds, or null when none is outstanding
createdAtnumberCreation timestamp in epoch seconds
idstringDestination ULID — the handle every route uses, so no address is path-encoded
state('pending' | 'verified' | 'revoked_by_recipient')Verification state; only 'verified' forwards
verifiedAtnumber | nullWhen the code was consumed, in epoch seconds, or null

Used in

Forwarding.

On this page