Verify buttons

Retrieve a button

Returns a verify button's public configuration. No key required.

GET /api/embed/v1/buttons/{button_id}

Returns a verify button's label and style. The button script calls this to draw itself. It's public and needs no key: it returns nothing private.

link Path

button_id string path required

The button's ID, starting vb_.

link Response

id string

The button's ID.

label string

The button's text.

background string

Background colour, #RRGGBB.

color string

Text colour, #RRGGBB.

radius integer

Corner radius in pixels.

size string

sm, md or lg.

full_width boolean

Whether it fills its container.

font string

inherit or system.

open_in string

same_tab or new_tab.

Responses may be cached for up to a minute, and can be called from any website.

cURL
curl https://www.kaywhysee.com/api/embed/v1/buttons/vb_MP1rKDG8nqK_SmwO
JavaScript
const response = await fetch(
  "https://www.kaywhysee.com/api/embed/v1/buttons/vb_MP1rKDG8nqK_SmwO",
);
const button = await response.json();
200
{
  "id": "vb_MP1rKDG8nqK_SmwO",
  "label": "Verify your identity",
  "background": "#d42a1c",
  "color": "#ffffff",
  "radius": 8,
  "size": "md",
  "full_width": false,
  "font": "inherit",
  "open_in": "same_tab"
}
404
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Verify button not found: vb_nope"
  }
}
Was this page helpful?

Authorization

Your secret key stays in this tab: it is sent with this request only and never stored.

Body application/json

Response

Send the request to see the response.