| Name | facekiapiclientv2 JSON |
| Version |
1.3
JSON |
| download |
| home_page | |
| Summary | FACEKI KYC Api Library |
| upload_time | 2023-08-07 09:31:47 |
| maintainer | |
| docs_url | None |
| author | Faceki |
| requires_python | |
| license | |
| keywords |
api
client
library
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FacekiAPIClientV2
The `FacekiAPIClientV2` is a Python client for interacting with the Faceki API. It provides methods to generate an access token, perform various KYC (Know Your Customer) operations, and retrieve KYC records.
## Installation
You can install `FacekiAPIClientV2` using pip:
```
pip install facekiapiclientv2
```
## Usage
```python
import requests
from facekiapiclientv2 import FacekiAPIClientV2
client_id = 'your_client_id'
client_secret = 'your_client_secret'
api_client = FacekiAPIClientV2(client_id, client_secret)
# Generate an access token
api_client.generate_token()
# Get KYC rules
kyc_rules = api_client.getKYCRules()
# Perform a KYC verification
selfie_image = 'path_to_selfie_image.jpg'
id_front_image = 'path_to_id_front_image.jpg'
id_back_image = 'path_to_id_back_image.jpg'
dl_front_image = 'path_to_dl_front_image.jpg'
dl_back_image = 'path_to_dl_back_image.jpg'
pp_front_image = 'path_to_pp_front_image.jpg'
pp_back_image = 'path_to_pp_back_image.jpg'
result = api_client.requestKYC(selfie_image, id_front_image, id_back_image,
dl_front_image, dl_back_image, pp_front_image,
pp_back_image)
# Get KYC verification summary
kyc_summary = api_client.getKycSummary()
# Generate a KYC verification link
expire_time = 0
application_id = 'your_application_id'
redirect_url:'https://xyz.com',
document_optional:True If you want customer to choose between document and False if you want customer to provide all document
require_additional_doc: True if you want customer to provide Additional Document (POA) and False if you dont want customer to provide Additional Doc
link = api_client.generateKYCLink(expire_time, application_id,redirect_url,document_optional,require_additional_doc)
# Get KYC records By Link
link_id = 'your_link_id'
kyc_records = api_client.getKYCrecordsByLink(link_id)
# Get KYC records By Reference Id
referenceId = 'record_referenceId'
kyc_records = api_client.getKYCRecordByReference(referenceId)
# Get KYC records By Reference Id
requestId = 'record_requestId'
kyc_records = api_client.getKYCRecordByRequestId(requestId)
# Perform a face check
selfie_image = 'path_to_selfie_image.jpg'
result = api_client.faceCheck(selfie_image)
```
## Exception Handling
The `FacekiAPIClientV2` class may raise exceptions in case of errors. Ensure that you handle these exceptions appropriately in your code. Examples of possible exceptions include:
- `requests.exceptions.RequestException`: Raised when there is an issue with making a request to the Faceki API.
- `Exception`: Raised for various errors such as failed token generation or failed requests.
## Disclaimer
Please note that this client code is provided as a starting point and may require modifications or updates depending on the Faceki API's specific requirements or changes. Refer to the Faceki API documentation for detailed information about the API's endpoints, request/response structures, and authentication requirements.
Raw data
{
"_id": null,
"home_page": "",
"name": "facekiapiclientv2",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "api,client,library",
"author": "Faceki",
"author_email": "haziq@faceki.com",
"download_url": "https://files.pythonhosted.org/packages/d8/fb/72e1442534ec4aec57c0788df58d8f6b2bea04426351c72e2a5a8d37a51b/facekiapiclientv2-1.3.tar.gz",
"platform": null,
"description": "# FacekiAPIClientV2\n\nThe `FacekiAPIClientV2` is a Python client for interacting with the Faceki API. It provides methods to generate an access token, perform various KYC (Know Your Customer) operations, and retrieve KYC records.\n\n## Installation\n\nYou can install `FacekiAPIClientV2` using pip:\n\n```\npip install facekiapiclientv2\n```\n\n## Usage\n\n```python\nimport requests\nfrom facekiapiclientv2 import FacekiAPIClientV2\n\nclient_id = 'your_client_id'\nclient_secret = 'your_client_secret'\napi_client = FacekiAPIClientV2(client_id, client_secret)\n\n# Generate an access token\napi_client.generate_token()\n\n# Get KYC rules\nkyc_rules = api_client.getKYCRules()\n\n# Perform a KYC verification\nselfie_image = 'path_to_selfie_image.jpg'\nid_front_image = 'path_to_id_front_image.jpg'\nid_back_image = 'path_to_id_back_image.jpg'\ndl_front_image = 'path_to_dl_front_image.jpg'\ndl_back_image = 'path_to_dl_back_image.jpg'\npp_front_image = 'path_to_pp_front_image.jpg'\npp_back_image = 'path_to_pp_back_image.jpg'\n\nresult = api_client.requestKYC(selfie_image, id_front_image, id_back_image,\n dl_front_image, dl_back_image, pp_front_image,\n pp_back_image)\n\n# Get KYC verification summary\nkyc_summary = api_client.getKycSummary()\n\n# Generate a KYC verification link\nexpire_time = 0\napplication_id = 'your_application_id'\nredirect_url:'https://xyz.com',\ndocument_optional:True If you want customer to choose between document and False if you want customer to provide all document\nrequire_additional_doc: True if you want customer to provide Additional Document (POA) and False if you dont want customer to provide Additional Doc\n\n\nlink = api_client.generateKYCLink(expire_time, application_id,redirect_url,document_optional,require_additional_doc)\n\n# Get KYC records By Link\nlink_id = 'your_link_id'\nkyc_records = api_client.getKYCrecordsByLink(link_id)\n\n# Get KYC records By Reference Id\nreferenceId = 'record_referenceId'\nkyc_records = api_client.getKYCRecordByReference(referenceId)\n\n# Get KYC records By Reference Id\nrequestId = 'record_requestId'\nkyc_records = api_client.getKYCRecordByRequestId(requestId)\n\n\n# Perform a face check\nselfie_image = 'path_to_selfie_image.jpg'\n\nresult = api_client.faceCheck(selfie_image)\n```\n\n## Exception Handling\n\nThe `FacekiAPIClientV2` class may raise exceptions in case of errors. Ensure that you handle these exceptions appropriately in your code. Examples of possible exceptions include:\n\n- `requests.exceptions.RequestException`: Raised when there is an issue with making a request to the Faceki API.\n- `Exception`: Raised for various errors such as failed token generation or failed requests.\n\n## Disclaimer\n\nPlease note that this client code is provided as a starting point and may require modifications or updates depending on the Faceki API's specific requirements or changes. Refer to the Faceki API documentation for detailed information about the API's endpoints, request/response structures, and authentication requirements.\n",
"bugtrack_url": null,
"license": "",
"summary": "FACEKI KYC Api Library",
"version": "1.3",
"project_urls": null,
"split_keywords": [
"api",
"client",
"library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26154a6d624923c46d6a914371ce2895238bc687d2563d730851760e0b105c21",
"md5": "4e1bbed3b7ca40b1c56b781c8e9e4651",
"sha256": "22b7cbab134f73aa7ba846061f33d13cf2a143592b2a77bc9faf6ff130cad614"
},
"downloads": -1,
"filename": "facekiapiclientv2-1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4e1bbed3b7ca40b1c56b781c8e9e4651",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4106,
"upload_time": "2023-08-07T09:31:45",
"upload_time_iso_8601": "2023-08-07T09:31:45.703962Z",
"url": "https://files.pythonhosted.org/packages/26/15/4a6d624923c46d6a914371ce2895238bc687d2563d730851760e0b105c21/facekiapiclientv2-1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8fb72e1442534ec4aec57c0788df58d8f6b2bea04426351c72e2a5a8d37a51b",
"md5": "4ac01ce6ef57ae1106e76807a5361765",
"sha256": "8847cb67addbd77943b20c10bdf1702d75fc7ef4b8c4443d2d00ad1b4208ab53"
},
"downloads": -1,
"filename": "facekiapiclientv2-1.3.tar.gz",
"has_sig": false,
"md5_digest": "4ac01ce6ef57ae1106e76807a5361765",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3831,
"upload_time": "2023-08-07T09:31:47",
"upload_time_iso_8601": "2023-08-07T09:31:47.394730Z",
"url": "https://files.pythonhosted.org/packages/d8/fb/72e1442534ec4aec57c0788df58d8f6b2bea04426351c72e2a5a8d37a51b/facekiapiclientv2-1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-07 09:31:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "facekiapiclientv2"
}
