# Accura ID Liveness

### IMPORTANT NOTES:

1. Max file upload size is 1 MB.
2. Results are returned in JSON format.
3. We DO NOT save any User information on our server.

<mark style="color:green;">`POST`</mark> [`https://api.accurascan.com/v2/api/id-liveness`](https://api.accurascan.com/v2/api/id-liveness)

#### Headers

| Name                                      | Type   | Description  |
| ----------------------------------------- | ------ | ------------ |
| Api-Key<mark style="color:red;">\*</mark> | String | Your API Key |

#### Request Body

| Name                                              | Type   | Description                     |
| ------------------------------------------------- | ------ | ------------------------------- |
| liveness\_image<mark style="color:red;">\*</mark> | File   | Upload Image for liveness check |
| country\_code<mark style="color:red;">\*</mark>   | String | Add the Country Code            |
| card\_code<mark style="color:red;">\*</mark>      | String | Add the Card Code               |

<details>

<summary><em>Postman Collection</em></summary>

{% code overflow="wrap" %}

```json
{"collection":{"info":{"_postman_id":"a9781476-c268-4fcc-a40a-15db2b0ace02","name":"ID Liveness","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","updatedAt":"2024-12-09T06:51:46.000Z","createdAt":"2024-12-09T06:50:52.000Z","lastUpdatedBy":"20339982","uid":"20339982-a9781476-c268-4fcc-a40a-15db2b0ace02"},"item":[{"name":"https://api.accurascan.com/v2/api/id-liveness","id":"e3262727-a571-4894-b92b-1736a9e132ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Api-Key","value":"your-api-key","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"liveness_image","type":"file","value":null},{"key":"country_code","value":"country_code","type":"text"},{"key":"card_code","value":"card_code","type":"text"}]},"url":{"raw":"https://api.accurascan.com/v2/api/id-liveness","protocol":"https","host":["api","accurascan","com"],"path":["v2","api","id-liveness"]}},"response":[],"uid":"20339982-e3262727-a571-4894-b92b-1736a9e132ed"}]}}
```

{% endcode %}

</details>

<figure><img src="https://2173810795-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9ct3oWZAE255BxwYNdp5%2Fuploads%2FLO5nUW37Xfboj0p61W91%2FID-Liv-Web.png?alt=media&#x26;token=50ff7194-d0d5-4441-bc2a-d8d62e2e7320" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
The preferred threshold is **55%**, meaning that if an image achieves a score above this threshold, the ID shown is considered ***Live***; otherwise, it is identified as a ***Spoof***.
{% endhint %}
