SUsurgeapi
Verifications

Check a verification

Checks the code against a verification.

post/verifications/{id}/checks

Request

  • Base URL
    https://api.surge.app
  • URL
    https://api.surge.app/verifications/{id}/checks
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the verification to check against.

Example:vfn_01jayh15c2f2xamftg0xpyq1nj

Request body

codestring required

The Verification code that was received.

Example request

{
  "code": "123456"
}

Response

Correct code

result'ok' | 'incorrect' | 'exhausted' | 'expired' | 'already_verified'

The result of the code check.

Example response

{
  "result": "ok",
  "verification": {
    "attempt_count": 1,
    "id": "vfn_01jayh15c2f2xamftg0xpyq1nj",
    "phone_number": "+18015551234",
    "status": "verified"
  }
}

Changes

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