Skip to main content

Auth Final (Validate / Poll)

POST 
/prove/auth/:session_id

Completes or polls the possession step for the session identified by {session_id}. Behavior depends on the channel chosen at Auth Initial:

  • OTP sessions — submit the applicant's SMS code in otp_code. Returns a pass/fail (passed, sms_status).
  • Magic Link sessions — there is no code to submit; the applicant completes possession by tapping the Magic Link. Call this endpoint with an empty body to poll the result. status is pending until the applicant taps the link, then verified or failed. Poll until completed is true.

Polling note: this endpoint is a POST and responses are cached per Idempotency-Key. Send a fresh Idempotency-Key on each poll so you receive the latest status rather than a cached response.

Request​

Responses​

Possession status

Response Headers
    Agc-Applicant-Id

    The applicant id

    Agc-Api-Version

    We update the API major version whenever we introduce breaking changes. Internally, we update minor and patch versions whenever we add functionality and backward-compatible updates

    X-Rate-Limit

    The current limit on a 5-minute window.

    X-Rate-Limit-Remaining

    The remaining calls on a 5-minute window.

    Timestamp

    The timestamp of the request reception.