Verify

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.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

post/v1/messaging/verify/verifications/{verificationId}/check

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/verify/verifications/{verificationId}/check
  • Auth: HTTP bearer

Path parameters

verificationIdstring required

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

codestring required

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.