# API Reference

The below documentation is created programmatically using the Keyfax Web API OpenAPI specification. For more detailed examples on how to call each of these API end-points please see our Web API [quick-start](https://docs.keyfax.biz/integrations/apis/rest-api/quick-start "mention") and [deep-dive](https://docs.keyfax.biz/integrations/apis/rest-api/deep-dive "mention") guides.&#x20;

### Obtaining a Keyfax Launch URL

Use these end-points to post start-up data and obtain a Keyfax launch URL.

{% openapi src="<https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media&token=715d4fa9-4b0c-489b-8e53-03d905e14650>" path="/api/v1/startup" method="get" fullWidth="false" %}
[swagger.json](https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media\&token=715d4fa9-4b0c-489b-8e53-03d905e14650)
{% endopenapi %}

{% openapi src="<https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media&token=715d4fa9-4b0c-489b-8e53-03d905e14650>" path="/api/v1/startup" method="post" fullWidth="false" %}
[swagger.json](https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media\&token=715d4fa9-4b0c-489b-8e53-03d905e14650)
{% endopenapi %}

### Processing Keyfax Results

Use this end point to obtain Keyfax results.&#x20;

{% openapi src="<https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media&token=715d4fa9-4b0c-489b-8e53-03d905e14650>" path="/api/v1/results" method="post" fullWidth="false" %}
[swagger.json](https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media\&token=715d4fa9-4b0c-489b-8e53-03d905e14650)
{% endopenapi %}

### Obtaining API keys

Use these end-points to generate API keys for our `Basic` or `API Key` verification methods.&#x20;

{% openapi src="<https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media&token=715d4fa9-4b0c-489b-8e53-03d905e14650>" path="/api/v1/key" method="get" expanded="false" fullWidth="false" %}
[swagger.json](https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media\&token=715d4fa9-4b0c-489b-8e53-03d905e14650)
{% endopenapi %}

{% openapi src="<https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media&token=715d4fa9-4b0c-489b-8e53-03d905e14650>" path="/api/v1/key" method="post" fullWidth="false" %}
[swagger.json](https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media\&token=715d4fa9-4b0c-489b-8e53-03d905e14650)
{% endopenapi %}

{% openapi src="<https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media&token=715d4fa9-4b0c-489b-8e53-03d905e14650>" path="/api/v1/key" method="delete" fullWidth="false" %}
[swagger.json](https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media\&token=715d4fa9-4b0c-489b-8e53-03d905e14650)
{% endopenapi %}

### Bearer / JWT Tokens

Use these end-points to obtain a short-lived JSON Web Token (JWT) for `Bearer` verification.

{% openapi src="<https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media&token=715d4fa9-4b0c-489b-8e53-03d905e14650>" path="/api/v1/token" method="get" fullWidth="false" %}
[swagger.json](https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media\&token=715d4fa9-4b0c-489b-8e53-03d905e14650)
{% endopenapi %}

{% openapi src="<https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media&token=715d4fa9-4b0c-489b-8e53-03d905e14650>" path="/api/v1/token" method="post" fullWidth="false" %}
[swagger.json](https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FB7PbkLveUjxahhsIocAn%2Fswagger.json?alt=media\&token=715d4fa9-4b0c-489b-8e53-03d905e14650)
{% endopenapi %}
