# API reference

## Overview

This Progeny RESTful API `https://be.progeny.tech/api/v3/`uses the HTTP POST and GET methods to create and update resources in our database. &#x20;

Our API endpoint enables you to perform several common tasks in the biometric and document authentication processes, including:

* **Registering image of a face** - register a user's face in our database and return a token.&#x20;
* **Authenticate images against a registered token/uuid** - after a successful liveness check, uses token returned from register api to to determine if upload image matches the image associated with that id or not.
* **Comparing and matching additional images against a reference facial fingerprint** -  ensure not only liveness but also biometric likeness
* **Liveness check** - perform a standalone liveness check, including age verification
* **Know Your Customer** - send a scanned image of an ID or password and return a JSON object containing the extracted text


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.progeny.tech/our-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
