DOCSEARCHbyAlgolia
Submit Docs

SheerID Developer Center

website·Indexed 40 days ago

https://developer.sheerid.com

Developer resources for connecting with the SheerID digital verification platform to add instant verification of gated offers.

Tokens
451
Snippets
1
Records
6
Agent score
9%

What's inside SheerID

  1. Overview of SheerID Integration Options

    SheerID provides two primary ways to integrate identity verification for gated offers:

    1. JavaScript Library: A client for the REST API that also acts as an engine for rendering verification forms (Embedded Iframes or Modal Lightboxes) and collecting data on your site.
    2. REST API: Provides full control over the verification process, allowing developers to start verifications, submit user data, and handle outcomes (success, document upload, or pending) end-to-end.

  2. Manage Reward Offer Codes

    SheerID can deliver reward (offer) codes to verified users via the API. This includes managing reward strategies, handling response fields, and uploading code pools within the MySheerID portal. The API handles the logic for when a code pool is exhausted.

  3. Securely Create Verifications via Backend

    To ensure that verification IDs only originate from the authorized merchant, SheerID recommends creating verifications from an authenticated backend rather than the client side. Once created on the backend, users can be redirected to the hosted verification form.

  4. Implement SheerID Webhooks

    SheerID webhooks allow you to receive event payloads and act on verification events. The implementation process involves:

    1. Setting up webhooks in the MySheerID dashboard.
    2. Receiving the event payload.
    3. Verifying the webhook signature for security.
    4. Calling the Verification Details API to act on the event.

  5. Test SheerID Integration Outcomes

    Developers can simulate every possible verification outcome (success, failure, pending, etc.) using Test Mode and Live Mode testing by utilizing specific test trigger values.

  6. Access the SheerID REST API Specification

    The SheerID REST API is documented via an OpenAPI specification. Developers can use the machine-readable YAML file to generate typed API clients or use the interactive human-readable reference.

    Base URL: https://services.sheerid.com/rest/v2 OpenAPI Spec: https://services.sheerid.com/rest/v2/swagger.yaml