Skip to main content
POST
/
v2
/
verification
/
check
import Prelude from "@prelude.so/sdk";

const client = new Prelude();

async function main() {
  const check = await client.verification.check({
    target: {
      type: "phone_number",
      value: "+30123456789",
    },
    code: "123456",
  });

  console.log(check.id);
}

main();

{
  "id": "vrf_01jc0t6fwwfgfsq1md24mhyztj",
  "status": "success",
  "metadata": {
    "correlation_id": "<string>"
  },
  "request_id": "<string>"
}
import Prelude from "@prelude.so/sdk";

const client = new Prelude();

async function main() {
  const check = await client.verification.check({
    target: {
      type: "phone_number",
      value: "+30123456789",
    },
    code: "123456",
  });

  console.log(check.id);
}

main();

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
target
object
required

The verification target. Either a phone number or an email address. To use the email verification feature contact us to discuss your use case.

​
code
string
required

The OTP code to validate.

Examples:

"12345"

Response

OK

​
status
enum<string>
required

The status of the check.

Available options:
success,
failure,
expired_or_not_found
Examples:

"success"

​
id
string

The verification identifier.

Examples:

"vrf_01jc0t6fwwfgfsq1md24mhyztj"

​
metadata
object

The metadata for this verification.

​
request_id
string