2fa.directory Open in urlscan Pro
2a06:98c1:3120::3  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * 2FA Directory


API USAGE


INTRODUCTION

The data collected for the 2fa.directory website is also available as JSON files
in order to enable developers to use it in their own programs. It is recommended
to use the API with the highest version number, since older versions might not
include all available information.


CACHING

If you intend to query our JSON files often and with a lot of traffic, you may
be blocked by Cloudflare, our reverse proxy provider. We therefore recommend
that you cache the files locally for any large traffic cases.


AVOID DOWNLOADING UNNECESSARY DATA

If you only intent on using a specific dataset, like all sites supporting
RFC-6238, we recommend that you use the URI which lists just that. See URIs for
a list of available paths. The smaller the better.


VERSION 3


URIS

CoverageUnsigned FilePGP Signed FileAll sites/v3/all.json/v3/all.json.sigAll
2FA-supporting
sites/v3/tfa.json/v3/tfa.json.sigSMS/v3/sms.json/v3/sms.json.sigPhone
calls/v3/call.json/v3/call.json.sigEmail
2FA/v3/email.json/v3/email.json.signon-U2F hardware 2FA
tokens/v3/custom-hardware.json/v3/custom-hardware.json.sigU2F hardware
tokens/v3/u2f.json/v3/u2f.json.sigRFC-6238
(TOTP)/v3/totp.json/v3/totp.json.signon-RFC-6238 software
2FA/v3/custom-software.json/v3/custom-software.json.sig


ELEMENTS

KeyValue TypeAlways DefinedDescriptiondomainFQDN✔️The domain name of the
serviceimgStringImage name used. If this is not defined, the image name is
domain.svgurlURLURL of the site. If this is not defined, the url is
https://domaintfaArray<String>Array containing all supported 2FA
methodsdocumentationURLURL to documentation pagerecoveryURLURL to recovery
documentation pagenotesStringText describing any discrepancies in the 2FA
implementationcontactObjectObject containing contact details. See table below
for elementsregionsArray<String>Array containing ISO 3166-1 country codes of the
regions in which the site is available. If the site is available everywhere
apart from a specific region, that region will be prefixed by a -
symboladditional-domainsArray<hostname>Array of domains that the site exists at
in addition to the main domain listed in the domain
field.custom-(software|hardware)Array<String>Array of custom software/hardware
methods that the site supports. Only present if the tfa element contains one of
these 2FA typeskeywordsArray<String>✔️Array of categories to which the site
belongs

CONTACT OBJECT ELEMENTS

KeyValueAlways DefinedDescriptiontwitterStringTwitter
handlefacebookStringFacebook page nameemailStringEmail address to
supportformStringSupport contact formlanguageStringLowercase ISO 639-1 language
code for the site if it is not in English


EXAMPLE WEBSITE WITH 2FA ENABLED

[
  [
    "Site Name",
    {
      "domain": "example.com",
      "additional-domains": [
        "example.net"
      ],
      "tfa": [
        "sms",
        "call",
        "email",
        "totp",
        "u2f",
        "custom-software",
        "custom-hardware"
      ],
      "custom-software": [
        "Authy"
      ],
      "documentation": "<link to site TFA documentation>",
      "recovery": "<link to site TFA recovery documentation>",
      "keywords": [
        "keyword1",
        "keyword2"
      ]
    }
  ]
]



EXAMPLE WEBSITE WITH 2FA DISABLED

[
  [
    "Site Name", 
    {
      "domain": "example.com",
      "contact": {
        "twitter": "example",
        "facebook": "example",
        "email": "example@example.com"
      },
      "keywords": [
        "keyword1",
        "keyword2"
      ]
    }
  ]
]



VERSION 2

API version 2 is no longer available. If you use this version, please upgrade to
version 3.


VERSION 1

API version 1 is no longer available. If you use this version, please upgrade to
version 3.

About Bots Privacy API Legal Contributing

The data on this website is crowdsourced and some data may be outdated.

2fa.directory is maintained by the non-profit 2factorauth and hosted on GitHub.