Check a verification code

Verify the code the user typed. Wrong, expired, and exhausted codes answer 200 with valid: false and the settled status — only an unknown id is a 404. A correct code consumes the verification (single-use, status: approved) and fires the verification.approved webhook; the 5th wrong attempt settles it as max_attempts_reached and fires verification.failed.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

verificationIdstring

Request Body

codestring

Match^\d{4,8}$

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.verify.checkVerification({  path: {    verificationId: 'verification_abc123',  },  body: {    code: 'abc123',  },});console.log(data);

{
  "id": "string",
  "status": "pending",
  "channel": "sms",
  "to": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "attempts": 0,
  "maxAttempts": 0,
  "sendCount": 0,
  "lastSentAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "resend": true,
  "valid": true
}

{
  "error": "string",
  "type": "invalid_request_error",
  "code": "string",
  "param": "string",
  "platform": "string",
  "platformError": {},
  "details": {}
}

{
  "error": "Unauthorized"
}

Empty

Check a verification code

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Path Parameters

verificationIdstring

Request Body

codestring

Match^\d{4,8}$

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.verify.checkVerification({
  path: {
    verificationId: 'verification_abc123',
  },
  body: {
    code: 'abc123',
  },
});
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.verify.checkVerification({  path: {    verificationId: 'verification_abc123',  },  body: {    code: 'abc123',  },});console.log(data);

{
  "id": "string",
  "status": "pending",
  "channel": "sms",
  "to": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "attempts": 0,
  "maxAttempts": 0,
  "sendCount": 0,
  "lastSentAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "resend": true,
  "valid": true
}

{
  "error": "string",
  "type": "invalid_request_error",
  "code": "string",
  "param": "string",
  "platform": "string",
  "platformError": {},
  "details": {}
}

{
  "error": "Unauthorized"
}

Empty

Check a verification code

200application/json

400application/json

401application/json

404

Check a verification code

200application/json

400application/json

401application/json

404

application/json

application/json

application/json

application/json

application/json

application/json