Messages

Extract the most recent verification code or confirmation link from inbound mail

Scans recent inbound messages, newest first, for one-time verification codes and confirmation links. Returns the newest match so an agent completing a signup flow does not have to parse mail bodies itself.

get/api/v1/inboxes/{inboxId}/verification-code

Request

  • Base URL: https://machineinbox.com
  • URL: https://machineinbox.com/api/v1/inboxes/{inboxId}/verification-code
  • Auth: none required

Path parameters

inboxIdstring uuid required

Query parameters

senderstring

Only consider messages whose sender address contains this string (case-insensitive).

Response

The newest detected code and any confirmation links, or found=false when nothing matches yet.

foundboolean required
codestring nullable required

The detected one-time code, or null when only links were found.

linksstring[] required

Confirmation or verification links found in the same message.

messageIdstring uuid nullable required
subjectstring nullable required
receivedAtstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.