Global

Get long url from short code

get

Path parameters

short_idstringRequired

Responses

200Success

No content

get

/url/{short_id}

HTTPcURLJavaScriptPython

GET /url/{short_id} HTTP/1.1
Host: 
Accept: */*

200Success

No content

Get certificate information for a non owner (public view)

get

Path parameters

certificate_idstringRequired

Header parameters

Accept-LanguagestringOptional

Responses

200Success

application/json

get

/{certificate_id}

HTTPcURLJavaScriptPython

GET /{certificate_id} HTTP/1.1
Host: 
Accept: */*

200Success

{
  "certificate": {
    "id": "text",
    "image": {
      "uri": "text",
      "path": "text",
      "fileName": "text",
      "mime": "text"
    },
    "image_video": {
      "uri": "text",
      "path": "text",
      "fileName": "text",
      "mime": "text"
    },
    "image_placeholder": {
      "uri": "text",
      "path": "text",
      "fileName": "text",
      "mime": "text"
    },
    "name": "text",
    "history": [],
    "edition_number": 1,
    "user_affiliation_program_url": "text"
  },
  "brand": {
    "brand_name": "text",
    "brand_logo": {
      "light": "text",
      "dark": "text"
    },
    "description": "text",
    "colors": {
      "light": {
        "primary": "text",
        "secondary": "text",
        "tertiary": "text",
        "bg_primary": "text",
        "bg_secondary": "text",
        "text_color": "text"
      },
      "dark": {
        "primary": "text",
        "secondary": "text",
        "tertiary": "text",
        "bg_primary": "text",
        "bg_secondary": "text",
        "text_color": "text"
      }
    },
    "slug": "text",
    "sponsors": [
      "text"
    ]
  },
  "collection": {
    "name": "text",
    "supply": 1,
    "displayEditionBadge": true,
    "blockchain": "text"
  },
  "product_general_name": "text",
  "product_background_image": "text",
  "product_name": "text",
  "beforeClaim": {
    "splashScreenVideo": null
  }
}

Get certificate information from an ephemeral link

get

Path parameters

secret_keystringRequired

issuestringRequired

Responses

200Success

application/json

get

/certificate/show/{secret_key}/{issue}

HTTPcURLJavaScriptPython

GET /certificate/show/{secret_key}/{issue} HTTP/1.1
Host: 
Accept: */*

200Success

{
  "certificate": {
    "id": "text",
    "image": {
      "uri": "text",
      "path": "text",
      "fileName": "text",
      "mime": "text"
    },
    "image_video": {
      "uri": "text",
      "path": "text",
      "fileName": "text",
      "mime": "text"
    },
    "image_placeholder": {
      "uri": "text",
      "path": "text",
      "fileName": "text",
      "mime": "text"
    },
    "name": "text",
    "history": [],
    "edition_number": 1,
    "user_affiliation_program_url": "text"
  },
  "brand": {
    "brand_name": "text",
    "brand_logo": {
      "light": "text",
      "dark": "text"
    },
    "description": "text",
    "colors": {
      "light": {
        "primary": "text",
        "secondary": "text",
        "tertiary": "text",
        "bg_primary": "text",
        "bg_secondary": "text",
        "text_color": "text"
      },
      "dark": {
        "primary": "text",
        "secondary": "text",
        "tertiary": "text",
        "bg_primary": "text",
        "bg_secondary": "text",
        "text_color": "text"
      }
    },
    "slug": "text",
    "sponsors": [
      "text"
    ]
  },
  "collection": {
    "name": "text",
    "supply": 1,
    "displayEditionBadge": true,
    "blockchain": "text"
  },
  "product_general_name": "text",
  "product_background_image": "text",
  "product_name": "text",
  "beforeClaim": {
    "splashScreenVideo": null
  }
}

Check if domain exist

get

Path parameters

subdomainstringRequired

Responses

200Success

application/json

Responseboolean

get

/wildcard/{subdomain}

HTTPcURLJavaScriptPython

GET /wildcard/{subdomain} HTTP/1.1
Host: 
Accept: */*

200Success

true

Get riddle user actions

post

Responses

200Success

application/json

Responseany

post

/riddle/webhook

HTTPcURLJavaScriptPython

POST /riddle/webhook HTTP/1.1
Host: 
Accept: */*

200Success

No content