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": "<string>",
  "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.

Example:

"12345"

​
psd2
object

Required when checking a code issued under the prelude:psd2 template. The submitted variables must match those provided at issuance; any mismatch invalidates the code (PSD2 SCA RTS Article 5 dynamic linking). Ignored on non-PSD2 verifications.

Response

OK

​
status
enum<string>
required

The status of the check. For prelude:psd2 codes, transaction_missing is returned when the psd2 block is omitted, and transaction_mismatch when the submitted variables differ from those provided at issuance.

Available options:
success,
failure,
expired_or_not_found,
transaction_missing,
transaction_mismatch
Example:

"success"

​
id
string

The verification identifier.

Example:

"vrf_01jc0t6fwwfgfsq1md24mhyztj"

​
metadata
object

The metadata for this verification.

​
request_id
string