Check Verification
Check the code entered by the user for a verification.
Check the code entered by the user. A well-formed code check consumes an attempt.
Scope: verify.verifications.write
Path Parameters
idstringrequiredVerification ID with the vrf_ prefix.
Request Body
codestringrequiredThe code entered by the user. It must contain only digits and have the verification's code_length.
Sample Request
Request
curl -X POST "https://api.maileroo.com/v1/verify/verifications/vrf_0123456789abcdef01234567/check" \
-H "Authorization: Bearer roo_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"code":"482916"}'Sample Response
Returns 200 OK. status is the check result; the nested verification has its lifecycle status.
Response
{
"data": {
"status": "approved",
"attempts_remaining": 0,
"verification": {
"id": "vrf_0123456789abcdef01234567",
"account_id": "12345",
"sender_profile_id": "prf_0123456789abcdef01234567",
"channel": "sms",
"to": "+61412345678",
"country": "AU",
"code_length": 6,
"status": "verified",
"attempts": 1,
"max_attempts": 3,
"expires_at": "2025-01-01T12:15:00Z",
"verified_at": "2025-01-01T12:02:00Z",
"created_at": "2025-01-01T12:00:00Z",
"updated_at": "2025-01-01T12:02:00Z"
}
}
}The max_attempts value is illustrative; the response reports the applicable value. Check results can be approved, incorrect, expired, failed, or cancelled. Only an incorrect result reports remaining attempts.
Errors
Common authentication, rate-limit, and service-availability errors are described in the Introduction. This endpoint can also return:
400 Bad Request— invalid JSON or a code that is not the required number of digits.404 Not Found— the verification does not exist for this account.