This document describes the Quado API, which is meant to be used by Relying Party or trusted parties performing administrative tasks.

Quado has acquired FIDO universal server certification, which supports the full range of FIDO authentications (FIDO2, UAF and U2F). You can select any type of FIDO specification your service is required.

• You need a valid API Key to send requests to the API endpoints. You can get your key from the Quado management console.
• The Quado API will only respond to secured communication done over HTTPS.
• Response to every request is sent in JSON format. In case the API request results in an error, it is represented by an "error_message": "error detail" key in the JSON response.
• The request method (verb) determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something from Quado, and POST implies you want to save something new to Quado.
• The API calls will respond with appropriate HTTP status codes for all requests. A 2XX indicates all went well, while 4XX or 5XX response codes indicate an error from the requesting client or our API servers respectively.
• Every API response have unique transaction id in x-transaction-id header. You can search API logs by this id from Quado management console.

An API Key is required to be sent as part of every request to the Quado API, in the form of an X-Api-Key request header.

If you do not have an API key, you can easily generate one from Quado management console.

An API Key tells our API server that the request it received came from you. Everything that you have access to in Quado FIDO server is accessible with an API Key that is generated by you.

If an API Key is missing, malformed, or invalid, you will receive a 401 Unauthorised response code and the following JSON response:

{
  "transaction_id":"bbf8b012-5f1f-4da9-996a-6211b6a668fb",
  "status_code":401,
  "error_message":"API key is invalid.",
  "error_code":"010000"
}

You can find FIDO2 sample code from url below for understanding how to integrate Quado API in your service. UAF and U2F sample code are comming soon.

FIDO2

Quick start

https://doc.quado.io/quick_start.

An example integration for Node in the Express framework.

https://github.com/quado-developer/quado-webauthn-express-sample.

For help regarding accessing the Quado API, feel free to ask us at contact@quado.io. In the event you receive a 503 response from our servers, it implies that we have hit an unexpected spike in API access traffic and would usually be operational within the next 5 minutes. If the outage persists, or your receive any other form of 5XX error, kindly let us know.