# Parcha API Client
A Python client for interacting with the Parcha API, providing both synchronous and asynchronous methods for various API endpoints.
## Features
- KYB (Know Your Business) and KYC (Know Your Customer) job management
- Check job execution
- Job retrieval by ID and case ID
- Asynchronous support using `aiohttp`
## Installation
```bash
pip install parcha-api-client # Note: Package name may differ
```
## Usage
```python
from parcha_api import ParchaAPI, KYBAgentJobInput
# Initialize the client
api = ParchaAPI("https://api.parcha.com", "your_api_token")
# Start a KYB agent job
kyb_input = KYBAgentJobInput(
agent_key="your_agent_key",
kyb_schema={"business_name": "Example Corp"}
)
response = api.start_kyb_agent_job(kyb_input)
# Get job by ID
job = api.get_job_by_id("job_id_here")
# Async example
async def fetch_jobs():
jobs = await api.get_jobs_by_case_id_async("case_id", "agent_key")
return jobs
```
## Documentation
For detailed information on available methods and models, refer to the docstrings in the source code.
## Requirements
- Python 3.7+
- `requests`
- `aiohttp`
- `pydantic`
## License
This Parcha API Client is proprietary software belonging to Parcha Labs Inc.
All rights reserved. Use of this software is subject to the terms of your service agreement with Parcha Labs Inc..
For questions about licensing or usage, please contact support@parcha.ai.
Raw data
{
"_id": null,
"home_page": "https://docs.parcha.ai",
"name": "parcha-api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "KYB, KYC, API client, Parcha, business verification, customer verification, compliance",
"author": "Miguel Rios",
"author_email": "miguel@parcha.ai",
"download_url": "https://files.pythonhosted.org/packages/2d/ed/89726032c2b853b38d0de61b495687ad8b1c0e5bcb359ea00b71d53944cf/parcha_api-0.1.0.tar.gz",
"platform": null,
"description": "# Parcha API Client\n\nA Python client for interacting with the Parcha API, providing both synchronous and asynchronous methods for various API endpoints.\n\n## Features\n\n- KYB (Know Your Business) and KYC (Know Your Customer) job management\n- Check job execution\n- Job retrieval by ID and case ID\n- Asynchronous support using `aiohttp`\n\n## Installation\n\n```bash\npip install parcha-api-client # Note: Package name may differ\n```\n\n## Usage\n\n```python\nfrom parcha_api import ParchaAPI, KYBAgentJobInput\n\n# Initialize the client\napi = ParchaAPI(\"https://api.parcha.com\", \"your_api_token\")\n\n# Start a KYB agent job\nkyb_input = KYBAgentJobInput(\n agent_key=\"your_agent_key\",\n kyb_schema={\"business_name\": \"Example Corp\"}\n)\nresponse = api.start_kyb_agent_job(kyb_input)\n\n# Get job by ID\njob = api.get_job_by_id(\"job_id_here\")\n\n# Async example\nasync def fetch_jobs():\n jobs = await api.get_jobs_by_case_id_async(\"case_id\", \"agent_key\")\n return jobs\n```\n\n## Documentation\n\nFor detailed information on available methods and models, refer to the docstrings in the source code.\n\n## Requirements\n\n- Python 3.7+\n- `requests`\n- `aiohttp`\n- `pydantic`\n\n## License\n\nThis Parcha API Client is proprietary software belonging to Parcha Labs Inc. \nAll rights reserved. Use of this software is subject to the terms of your service agreement with Parcha Labs Inc..\n\nFor questions about licensing or usage, please contact support@parcha.ai.\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "Python client for interacting with the Parcha API, providing both synchronous and asynchronous methods for various API endpoints.",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://docs.parcha.ai",
"Homepage": "https://docs.parcha.ai",
"Repository": "https://github.com/parcha-ai/parcha-api-python"
},
"split_keywords": [
"kyb",
" kyc",
" api client",
" parcha",
" business verification",
" customer verification",
" compliance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f89f4ab9c1c418cec808230b38f91438a23c818c55f4bf20c66a5cd880faf0e0",
"md5": "8b6d1b1ee7a62bd5ebb134c99a3f4d23",
"sha256": "c4f0a4c59d4df3557bbd06639089800296565fc0c3697ae229b767ebbebb7673"
},
"downloads": -1,
"filename": "parcha_api-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b6d1b1ee7a62bd5ebb134c99a3f4d23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 4673,
"upload_time": "2024-09-06T22:18:12",
"upload_time_iso_8601": "2024-09-06T22:18:12.452641Z",
"url": "https://files.pythonhosted.org/packages/f8/9f/4ab9c1c418cec808230b38f91438a23c818c55f4bf20c66a5cd880faf0e0/parcha_api-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ded89726032c2b853b38d0de61b495687ad8b1c0e5bcb359ea00b71d53944cf",
"md5": "fceac975f2f43b188674df41f490ee43",
"sha256": "f1cce56b8f74f93488e4f1f4a2d7f0cadfc2b451ded371b196b62a22f5216877"
},
"downloads": -1,
"filename": "parcha_api-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "fceac975f2f43b188674df41f490ee43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 4083,
"upload_time": "2024-09-06T22:18:13",
"upload_time_iso_8601": "2024-09-06T22:18:13.909322Z",
"url": "https://files.pythonhosted.org/packages/2d/ed/89726032c2b853b38d0de61b495687ad8b1c0e5bcb359ea00b71d53944cf/parcha_api-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-06 22:18:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "parcha-ai",
"github_project": "parcha-api-python",
"github_not_found": true,
"lcname": "parcha-api"
}
JSON
