Age Verification

Age verification endpoints determine available verification methods and initiate age assurance flows.

Age Verification Result Object

The result of initiating an age verification flow.

Age Verification Result Structure

Incode Parameters Structure

Age Verification Method Object

An age verification method offered to the current user.

Age Verification Method Structure

Age Verification Method Icon Structure

Age Verification Method Icon Path Structure

Age Verification Method Type

Age Verification Vendor

Age Verification Methods Response Object

The available age verification methods.

Age Verification Methods Response Structure

Example Age Verification Methods Response

{
  "methods": [
    {
      "method": 1,
      "vendor": "INCODE",
      "title": "Estimate your age",
      "description": "Use a video selfie to estimate your age.",
      "provided_by": "Provided by Incode",
      "icon": {
        "paths": [
          {
            "d": "M12 2a10 10 0 1 0 0 20 10 10 0 0 0 0-20Z",
            "fill_rule": "evenodd"
          }
        ]
      }
    }
  ],
  "footer_message": null
}

Reactive Check Object

The result of the current user's reactive age verification check.

Reactive Check Structure

Reactive Check Status

Endpoints

Initiates a test age assurance flow. Returns an age verification result object on success.

JSON Params

Initiates age verification with the selected method and vendor. Returns an age verification result object on success.

JSON Params

Initiates the second version of age verification with the selected method and vendor. Returns an age verification result object on success.

JSON Params

Registers a completed Incode interview. Returns a 204 empty response on success.

JSON Params

Creates an Incode age verification session. Returns an age verification result object on success.

JSON Params

Returns the available age verification method types.

Response Body

Returns an age verification methods response object.

Returns a reactive check object.

Clears the current user's pending age verification state. Returns a 204 empty response on success.

Returns the age verification methods available to a suspended user.

JSON Params

Response Body