Skip to the documentation
API

Read the sign-in code in a message

The verification code in a message you pass in, when the reader is sure of it.

POST/tools/verification-code

Runs the real call on your workspace.

POST /tools/verification-code

The verification code in a message you pass in, when the reader is sure of it.

Example

Needs no scope. Send the whole MIME source as raw, or the subject with html or text. code comes back as you would type it, digits only or capital letters and digits, without spaces or dashes, or null when the message holds no code the reader is sure of.

curl
curl -X POST "$OE/tools/verification-code" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "subject": "Your verification code", "html": "<p>Your code is <b>396-696</b>. It expires in 10 minutes.</p>" }'
Response
{  "object": "verification_code",  "code": "396696"}

It answers only when the message holds exactly one code worded as one, such as a verification code, a one-time code or a security code, in any of the common languages. Two different codes, or a number that could be an order, a booking, a meeting, a phone number or a promotion, give code: null.

It reads only what you send, so it cannot tell whether the sender is who it claims to be. The verificationCode on a message in your mailbox also requires the sender to pass authentication. Nothing is stored and no model is called.

Reference