Check Verification | AgentPhone

Check a verification code against a pending verification.

Possible results:

ok — code is correct, phone number verified
incorrect — wrong code, try again (up to 3 attempts)
exhausted — too many failed attempts, send a new code
expired — verification expired (10 min), send a new code
already_verified — this verification was already completed

Billing. An ok or already_verified result costs a $0.05 verification fee. Other results are free.

Check a verification code against a pending verification. Possible results: - `ok` — code is correct, phone number verified - `incorrect` — wrong code, try again (up to 3 attempts) - `exhausted` — too many failed attempts, send a new code - `expired` — verification expired (10 min), send a new code - `already_verified` — this verification was already completed **Billing.** An `ok` or `already_verified` result costs a $0.05 verification fee. Other results are free.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

verification_idstringRequired

Verification ID returned from /v1/verify/send

codestringRequiredformat: "^[0-9]{6}$"

6-digit verification code

Response

Successful Response

resultstring

One of ok, incorrect, exhausted, expired, or already_verified.

attempts_remaininginteger or nullOptional

Checks left before the verification is exhausted. 0 once it reaches a final state.

Errors

422

Unprocessable Entity Error

1	import { AgentPhoneClient } from "agentphone";
2
3	async function main() {
4	const client = new AgentPhoneClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.verification.checkVerification({
8	verificationId: "string",
9	code: "string",
10	});
11	}
12	main();