mati


Namemati JSON
Version 2.0.6 PyPI version JSON
download
home_pagehttps://github.com/cuenca-mx/mati-python
SummaryClient library for mati.io
upload_time2024-02-07 23:26:18
maintainer
docs_urlNone
authorCuenca
requires_python>=3.6
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # mati-python
[![Build Status](https://travis-ci.com/cuenca-mx/mati-python.svg?branch=master)](https://travis-ci.com/cuenca-mx/mati-python)
[![Coverage Status](https://coveralls.io/repos/github/cuenca-mx/mati-python/badge.svg?branch=master)](https://coveralls.io/github/cuenca-mx/mati-python?branch=master)
[![PyPI](https://img.shields.io/pypi/v/mati.svg)](https://pypi.org/project/mati/)

[Mati](https://mati.io) Python3.6+ client library


## Install

```
pip install mati
```

## Testing

```
make venv
source venv/bin/activate
make test
```

## Create Verification

```python
from mati import Client

client = Client('api_key', 'secret_key')
verification = client.verifications.create(
    'some_flow_id',
    company_id='some_id',
)
```

## Upload documents
```python
from mati.types import (
    PageType,
    UserValidationFile,
    ValidationInputType,
    ValidationType,
)

# Load documents
front = open('ine_front.jpg', 'rb')
back = open('ine_back.jpg', 'rb')
live = open('liveness.mp4', 'rb')

# Create document with metadata
user_validation_file = UserValidationFile(
    filename='ine_front.jpg',
    content=front,
    input_type=ValidationInputType.document_photo,
    validation_type=ValidationType.national_id,
    country='MX',
    group=0, #The group is important when create your metamap
)
user_validation_file_back = UserValidationFile(
    filename='ine_back.jpg',
    content=back,
    input_type=ValidationInputType.document_photo,
    validation_type=ValidationType.national_id,
    country='MX',
    page=PageType.back,
    group=0,
)
user_validation_live = UserValidationFile(
    filename='liveness.MOV',
    content=live,
    input_type=ValidationInputType.selfie_video,
    group=1,
)

# Send documentation for validation
resp = client.verifications.upload_validation_data(
    [
        user_validation_file,
        user_validation_file_back,
        user_validation_live,
    ],
    verification.identity,
)
```

## Verification status
Retrieve the verification when its complete
```python
verification = client.verifications.retrieve('verification_id')
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cuenca-mx/mati-python",
    "name": "mati",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Cuenca",
    "author_email": "dev@cuenca.com",
    "download_url": "https://files.pythonhosted.org/packages/70/ba/30651fb5235156afaaa5496808fb4e320546bb7e6dd43761b18b72e5588b/mati-2.0.6.tar.gz",
    "platform": null,
    "description": "# mati-python\n[![Build Status](https://travis-ci.com/cuenca-mx/mati-python.svg?branch=master)](https://travis-ci.com/cuenca-mx/mati-python)\n[![Coverage Status](https://coveralls.io/repos/github/cuenca-mx/mati-python/badge.svg?branch=master)](https://coveralls.io/github/cuenca-mx/mati-python?branch=master)\n[![PyPI](https://img.shields.io/pypi/v/mati.svg)](https://pypi.org/project/mati/)\n\n[Mati](https://mati.io) Python3.6+ client library\n\n\n## Install\n\n```\npip install mati\n```\n\n## Testing\n\n```\nmake venv\nsource venv/bin/activate\nmake test\n```\n\n## Create Verification\n\n```python\nfrom mati import Client\n\nclient = Client('api_key', 'secret_key')\nverification = client.verifications.create(\n    'some_flow_id',\n    company_id='some_id',\n)\n```\n\n## Upload documents\n```python\nfrom mati.types import (\n    PageType,\n    UserValidationFile,\n    ValidationInputType,\n    ValidationType,\n)\n\n# Load documents\nfront = open('ine_front.jpg', 'rb')\nback = open('ine_back.jpg', 'rb')\nlive = open('liveness.mp4', 'rb')\n\n# Create document with metadata\nuser_validation_file = UserValidationFile(\n    filename='ine_front.jpg',\n    content=front,\n    input_type=ValidationInputType.document_photo,\n    validation_type=ValidationType.national_id,\n    country='MX',\n    group=0, #The group is important when create your metamap\n)\nuser_validation_file_back = UserValidationFile(\n    filename='ine_back.jpg',\n    content=back,\n    input_type=ValidationInputType.document_photo,\n    validation_type=ValidationType.national_id,\n    country='MX',\n    page=PageType.back,\n    group=0,\n)\nuser_validation_live = UserValidationFile(\n    filename='liveness.MOV',\n    content=live,\n    input_type=ValidationInputType.selfie_video,\n    group=1,\n)\n\n# Send documentation for validation\nresp = client.verifications.upload_validation_data(\n    [\n        user_validation_file,\n        user_validation_file_back,\n        user_validation_live,\n    ],\n    verification.identity,\n)\n```\n\n## Verification status\nRetrieve the verification when its complete\n```python\nverification = client.verifications.retrieve('verification_id')\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Client library for mati.io",
    "version": "2.0.6",
    "project_urls": {
        "Homepage": "https://github.com/cuenca-mx/mati-python"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dae87ab9c932651db3692aeaecba32e49667ec2c1a404b8677c4caf37c4aa5e9",
                "md5": "69ea26c3a787b77750a2bb0851f95f32",
                "sha256": "22b21489b0993949f99ff2eb96d1c941934995c3beeb17328c71f499477035b6"
            },
            "downloads": -1,
            "filename": "mati-2.0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "69ea26c3a787b77750a2bb0851f95f32",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 14956,
            "upload_time": "2024-02-07T23:26:17",
            "upload_time_iso_8601": "2024-02-07T23:26:17.243827Z",
            "url": "https://files.pythonhosted.org/packages/da/e8/7ab9c932651db3692aeaecba32e49667ec2c1a404b8677c4caf37c4aa5e9/mati-2.0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "70ba30651fb5235156afaaa5496808fb4e320546bb7e6dd43761b18b72e5588b",
                "md5": "333f6f653964711627ac8ae60c6178d1",
                "sha256": "c987962ebeccb8503e797c584a05108d50ca29f708e6a5839b4a8841ac37337c"
            },
            "downloads": -1,
            "filename": "mati-2.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "333f6f653964711627ac8ae60c6178d1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 12224,
            "upload_time": "2024-02-07T23:26:18",
            "upload_time_iso_8601": "2024-02-07T23:26:18.671321Z",
            "url": "https://files.pythonhosted.org/packages/70/ba/30651fb5235156afaaa5496808fb4e320546bb7e6dd43761b18b72e5588b/mati-2.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-07 23:26:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cuenca-mx",
    "github_project": "mati-python",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "lcname": "mati"
}
        
Elapsed time: 0.17727s